Package io.deephaven.engine.table.impl.by.alternatingcolumnsource

Class AlternatingColumnSource<DATA_TYPE>

java.lang.Object
io.deephaven.engine.table.impl.AbstractColumnSource<DATA_TYPE>
io.deephaven.engine.table.impl.by.alternatingcolumnsource.AlternatingColumnSource<DATA_TYPE>
All Implemented Interfaces:
ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<DATA_TYPE>, ElementSource<DATA_TYPE>, FillContextMaker, GetContextMaker, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, FillUnordered<Values>, Releasable, TupleExporter<DATA_TYPE>, TupleSource<DATA_TYPE>
public class AlternatingColumnSource<DATA_TYPE> extends AbstractColumnSource<DATA_TYPE> implements ColumnSource<DATA_TYPE>, FillUnordered<Values>
ColumnSource implementation that delegates to the main and alternate sources for our incremental open addressed hash table key columns that swap back and forth between a "main" and "alternate" source. Note that the main and alternate swap back and forth, from the perspective of this column source the main source is addressed by zero; and the alternate source is addressed starting at ALTERNATE_SWITCH_MASK. Neither source may have addresses greater than ALTERNATE_INNER_MASK.

  • Field Details

  • Constructor Details

  • Method Details

    • setSources

      public void setSources(ColumnSource<DATA_TYPE> mainSource, ColumnSource<DATA_TYPE> alternateSource)

    • makeFillContext

      public final ChunkSource.FillContext makeFillContext(int chunkCapacity, SharedContext sharedContext)
      Description copied from interface: FillContextMaker
      Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.
      Specified by:
      makeFillContext in interface DefaultChunkSource<DATA_TYPE>
      Specified by:
      makeFillContext in interface FillContextMaker
      Parameters:
      chunkCapacity - The maximum size of any WritableChunk that will be filled with this context
      sharedContext - Shared store of intermediate results.
      Returns:
      A context for use with fill operations

    • makeGetContext

      public final ChunkSource.GetContext makeGetContext(int chunkCapacity, SharedContext sharedContext)
      Description copied from interface: GetContextMaker
      Allocate a new ChunkSource.GetContext for retrieving chunks from this GetContextMaker, typically a ChunkSource.
      Specified by:
      makeGetContext in interface DefaultChunkSource<DATA_TYPE>
      Specified by:
      makeGetContext in interface GetContextMaker
      Parameters:
      chunkCapacity - The maximum size required for any WritableChunk allocated as part of the result.
      sharedContext - Shared store of intermediate results.
      Returns:
      A context for use with get operations

    • fillChunk

      public final void fillChunk(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> destination, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: ChunkSource
      Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
      Specified by:
      fillChunk in interface ChunkSource<DATA_TYPE>
      Overrides:
      fillChunk in class AbstractColumnSource<DATA_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      destination - The chunk to be populated according to rowSequence. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,rowSequence.size()).
      rowSequence - An RowSequence representing the keys to be fetched

    • fillPrevChunk

      public final void fillPrevChunk(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> destination, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: ChunkSource.WithPrev
      Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
      Specified by:
      fillPrevChunk in interface ChunkSource.WithPrev<DATA_TYPE>
      Overrides:
      fillPrevChunk in class AbstractColumnSource<DATA_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      destination - The chunk to be populated according to rowSequence. No assumptions shall be made about the size of the chunk shall be made. The chunk will be populated from position [0,rowSequence.size()).
      rowSequence - An RowSequence representing the keys to be fetched

    • getChunk

      public final Chunk<? extends Values> getChunk(@NotNull @NotNull ChunkSource.GetContext context, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: ChunkSource
      Returns a chunk of data corresponding to the keys from the given RowSequence.
      Specified by:
      getChunk in interface ChunkSource<DATA_TYPE>
      Specified by:
      getChunk in interface DefaultChunkSource<DATA_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk. In particular, the Context may be used to provide a Chunk data pool
      rowSequence - An RowSequence representing the keys to be fetched
      Returns:
      A chunk of data corresponding to the keys from the given RowSequence

    • getPrevChunk

      public final Chunk<? extends Values> getPrevChunk(@NotNull @NotNull ChunkSource.GetContext context, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: ChunkSource.WithPrev
      Returns a chunk of previous data corresponding to the keys from the given RowSequence.
      Specified by:
      getPrevChunk in interface ChunkSource.WithPrev<DATA_TYPE>
      Specified by:
      getPrevChunk in interface DefaultChunkSource.WithPrev<DATA_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk. In particular, the Context may be used to provide a Chunk data pool
      rowSequence - An RowSequence representing the keys to be fetched
      Returns:
      A chunk of data corresponding to the keys from the given RowSequence

    • get

      public final DATA_TYPE get(long rowKey)
      Description copied from interface: ElementSource
      Get the value from the source. This may return boxed values for basic types. RowKeys that are not present are undefined.
      Specified by:
      get in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the value at the rowKey, potentially null.

    • getBoolean

      public final Boolean getBoolean(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a Boolean. RowKeys that are not present are undefined.
      Specified by:
      getBoolean in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the boolean at the rowKey, potentially null.

    • getByte

      public final byte getByte(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a byte. RowKeys that are not present are undefined.
      Specified by:
      getByte in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the boolean at the rowKey, null values are represented by QueryConstants.NULL_BYTE

    • getChar

      public final char getChar(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a char. RowKeys that are not present are undefined.
      Specified by:
      getChar in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the char at the rowKey, null values are represented by QueryConstants.NULL_CHAR

    • getDouble

      public final double getDouble(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a double. RowKeys that are not present are undefined.
      Specified by:
      getDouble in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the double at the rowKey, null values are represented by QueryConstants.NULL_DOUBLE

    • getFloat

      public final float getFloat(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a float. RowKeys that are not present are undefined.
      Specified by:
      getFloat in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the float at the rowKey, null values are represented by QueryConstants.NULL_FLOAT

    • getInt

      public final int getInt(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as an int. RowKeys that are not present are undefined.
      Specified by:
      getInt in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the int at the rowKey, null values are represented by QueryConstants.NULL_INT

    • getLong

      public final long getLong(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a long. RowKeys that are not present are undefined.
      Specified by:
      getLong in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the long at the rowKey, null values are represented by QueryConstants.NULL_LONG

    • getShort

      public final short getShort(long rowKey)
      Description copied from interface: ElementSource
      Get the value at the rowKey as a short. RowKeys that are not present are undefined.
      Specified by:
      getShort in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the short at the rowKey, null values are represented by QueryConstants.NULL_SHORT

    • getPrev

      public final DATA_TYPE getPrev(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey. Previous values are used during an UG update cycle to process changes in data. During normal operation previous values will be identical to current values. RowKeys that were not present are undefined.
      Specified by:
      getPrev in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the previous value at the rowKey, potentially null.

    • getPrevBoolean

      public final Boolean getPrevBoolean(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a Boolean. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevBoolean in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous boolean at the rowKey, potentially null.

    • getPrevByte

      public final byte getPrevByte(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a byte. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevByte in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous boolean at the rowKey, null values are represented by QueryConstants.NULL_BYTE

    • getPrevChar

      public final char getPrevChar(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a char. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevChar in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - ohe location in key space to get the previous value from.
      Returns:
      the previous char at the rowKey, null values are represented by QueryConstants.NULL_CHAR

    • getPrevDouble

      public final double getPrevDouble(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a double. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevDouble in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous double at the rowKey, null values are represented by QueryConstants.NULL_DOUBLE

    • getPrevFloat

      public final float getPrevFloat(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a float. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevFloat in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous float at the rowKey, null values are represented by QueryConstants.NULL_FLOAT

    • getPrevInt

      public final int getPrevInt(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as an int. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevInt in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous int at the rowKey, null values are represented by QueryConstants.NULL_INT

    • getPrevLong

      public final long getPrevLong(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a long. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevLong in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous long at the rowKey, null values are represented by QueryConstants.NULL_LONG

    • getPrevShort

      public final short getPrevShort(long rowKey)
      Description copied from interface: ElementSource
      Get the previous value at the rowKey as a short. See ElementSource.getPrev(long) for more details. RowKeys that were not present are undefined.
      Specified by:
      getPrevShort in interface ElementSource<DATA_TYPE>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous short at the rowKey, null values are represented by QueryConstants.NULL_SHORT

    • startTrackingPrevValues

      public final void startTrackingPrevValues()
      Description copied from interface: ColumnSource
      ColumnSource implementations that track previous values have the option to not actually start tracking previous values until this method is called. This is an option, not an obligation: some simple ColumnSource implementations (like TSingleValueSource for various T) always track previous values; other implementations (like PrevColumnSource) never do; some (like TArrayColumnSource) only start tracking once this method is called. An immutable column source can not have distinct prev values; therefore it is implemented as a no-op.
      Specified by:
      startTrackingPrevValues in interface ColumnSource<DATA_TYPE>

    • isImmutable

      public final boolean isImmutable()
      Description copied from interface: ColumnSource
      Determine if this column source is immutable, meaning that the values at a given row key never change.
      Specified by:
      isImmutable in interface ColumnSource<DATA_TYPE>
      Returns:
      true if the values at a given row key of the column source never change, false otherwise

    • allowsReinterpret

      public <ALTERNATE_DATA_TYPE> boolean allowsReinterpret(@NotNull @NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)
      Description copied from interface: ColumnSource
      Test if a reinterpret call will succeed.
      Specified by:
      allowsReinterpret in interface ColumnSource<DATA_TYPE>
      Overrides:
      allowsReinterpret in class AbstractColumnSource<DATA_TYPE>
      Parameters:
      alternateDataType - The alternative type to consider
      Returns:
      If a reinterpret on this column source with the supplied alternateDataType will succeed.

    • doReinterpret

      protected <ALTERNATE_DATA_TYPE> ColumnSource<ALTERNATE_DATA_TYPE> doReinterpret(@NotNull @NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)
      Description copied from class: AbstractColumnSource
      Supply allowed reinterpret results. The default implementation handles the most common case to avoid code duplication.
      Overrides:
      doReinterpret in class AbstractColumnSource<DATA_TYPE>
      Parameters:
      alternateDataType - The alternate data type
      Returns:
      The resulting ColumnSource

    • isAlternate

      public static boolean isAlternate(long index)

    • innerLocation

      public static int innerLocation(long hashSlot)

    • fillChunkUnordered

      public void fillChunkUnordered(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> dest, @NotNull @NotNull LongChunk<? extends RowKeys> keys)
      Description copied from interface: FillUnordered
      Populates a contiguous portion of the given destination chunk with data corresponding to the keys from the given LongChunk.

      It behaves as if the following code were executed: 

       destination.setSize(keys.size());
 for (int ii = 0; ii < keys.size(); ++ii) {
     destination.set(ii, get(keys.get(ii)));
 }
      Specified by:
      fillChunkUnordered in interface FillUnordered<DATA_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      dest - The chunk to be populated according to keys
      keys - A chunk of individual, not assumed to be ordered keys to be fetched

    • fillPrevChunkUnordered

      public void fillPrevChunkUnordered(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> dest, @NotNull @NotNull LongChunk<? extends RowKeys> keys)
      Description copied from interface: FillUnordered
      Populates a contiguous portion of the given destination chunk with prev data corresponding to the keys from the given LongChunk.

      It behaves as if the following code were executed: 

       destination.setSize(keys.size());
 for (int ii = 0; ii < keys.size(); ++ii) {
     destination.set(ii, getPrev(keys.get(ii)));
 }
      Specified by:
      fillPrevChunkUnordered in interface FillUnordered<DATA_TYPE>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      dest - The chunk to be populated according to keys
      keys - A chunk of individual, not assumed to be ordered keys to be fetched

    • providesFillUnordered

      public boolean providesFillUnordered()
      Description copied from interface: FillUnordered
      Returns true if this column source can efficiently provide an unordered fill. If this method returns false, then fillChunkUnordered and fillPrevChunkUnordered may throw an UnsupportedOperationException.
      Specified by:
      providesFillUnordered in interface FillUnordered<DATA_TYPE>
      Returns:
      if this column source can provide an unordered fill