Package io.deephaven.engine.table.impl.sources.deltaaware

Class DeltaAwareColumnSource<T>

java.lang.Object
io.deephaven.engine.table.impl.AbstractColumnSource<T>
io.deephaven.engine.table.impl.sources.deltaaware.DeltaAwareColumnSource<T>
All Implemented Interfaces:
ChunkSink<Values>, ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<T>, ElementSource<T>, FillContextMaker, GetContextMaker, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, PushdownFilterMatcher, Releasable, TupleExporter<T>, TupleSource<T>, WritableColumnSource<T>
public final class DeltaAwareColumnSource<T> extends AbstractColumnSource<T> implements WritableColumnSource<T>, ChunkSink<Values>

  • Constructor Details

    • DeltaAwareColumnSource

      public DeltaAwareColumnSource(Class<T> type)

  • Method Details

    • makeGetContext

      public ChunkSource.GetContext makeGetContext(int chunkSize, 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<T>
      Specified by:
      makeGetContext in interface GetContextMaker
      Parameters:
      chunkSize - 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

    • makeFillContext

      public ChunkSource.FillContext makeFillContext(int chunkSize, 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<T>
      Specified by:
      makeFillContext in interface FillContextMaker
      Parameters:
      chunkSize - 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

    • getChunk

      public Chunk<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<T>
      Specified by:
      getChunk in interface DefaultChunkSource<T>
      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

    • fillChunk

      public void fillChunk(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> dest, @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<T>
      Overrides:
      fillChunk in class AbstractColumnSource<T>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      dest - 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

    • getPrevChunk

      public 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<T>
      Specified by:
      getPrevChunk in interface DefaultChunkSource.WithPrev<T>
      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

    • fillPrevChunk

      public void fillPrevChunk(@NotNull @NotNull ChunkSource.FillContext context, @NotNull @NotNull WritableChunk<? super Values> dest, @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<T>
      Overrides:
      fillPrevChunk in class AbstractColumnSource<T>
      Parameters:
      context - A context containing all mutable/state related data used in retrieving the Chunk.
      dest - 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

    • fillFromChunk

      public void fillFromChunk(@NotNull @NotNull ChunkSink.FillFromContext context, @NotNull @NotNull Chunk<? extends Values> src, @NotNull @NotNull RowSequence rowSequence)
      Description copied from interface: WritableColumnSource
      Our default, inefficient, implementation. Inheritors who care should provide a better implementation.
      Specified by:
      fillFromChunk in interface ChunkSink<T>
      Specified by:
      fillFromChunk in interface WritableColumnSource<T>
      Parameters:
      context - A context containing all mutable/state related data used in writing the Chunk.
      src - The source of the data rowSequence
      rowSequence - An RowSequence representing the keys to be written

    • fillFromChunkUnordered

      public void fillFromChunkUnordered(@NotNull @NotNull ChunkSink.FillFromContext context, @NotNull @NotNull Chunk<? extends Values> src, @NotNull @NotNull LongChunk<RowKeys> keys)
      Description copied from interface: ChunkSink
      Fills the ChunkSink with data from the source, with data corresponding to the keys from the given key chunk.
      Specified by:
      fillFromChunkUnordered in interface ChunkSink<T>
      Specified by:
      fillFromChunkUnordered in interface WritableColumnSource<T>
      Parameters:
      context - A context containing all mutable/state related data used in writing the Chunk.
      src - The source of the data RowSequence
      keys - A LongChunk representing the keys to be written

    • get

      public T 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<T>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the value at the rowKey, potentially null.

    • getBoolean

      public 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<T>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the boolean at the rowKey, potentially null.

    • getByte

      public 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 T 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<T>
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the previous value at the rowKey, potentially null.

    • getPrevBoolean

      public 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<T>
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous boolean at the rowKey, potentially null.

    • getPrevByte

      public 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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 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<T>
      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

    • set

      public void set(long key, T value)
      Specified by:
      set in interface WritableColumnSource<T>

    • setNull

      public void setNull(long key)
      Specified by:
      setNull in interface WritableColumnSource<T>

    • set

      public void set(long key, byte value)
      Specified by:
      set in interface WritableColumnSource<T>

    • set

      public void set(long key, char value)
      Specified by:
      set in interface WritableColumnSource<T>

    • set

      public void set(long key, double value)
      Specified by:
      set in interface WritableColumnSource<T>

    • set

      public void set(long key, float value)
      Specified by:
      set in interface WritableColumnSource<T>

    • set

      public void set(long key, int value)
      Specified by:
      set in interface WritableColumnSource<T>

    • set

      public void set(long key, long value)
      Specified by:
      set in interface WritableColumnSource<T>

    • set

      public void set(long key, short value)
      Specified by:
      set in interface WritableColumnSource<T>

    • startTrackingPrevValues

      public 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<T>

    • ensureCapacity

      public void ensureCapacity(long capacity, boolean nullFilled)
      Description copied from interface: WritableColumnSource
      Ensure that this WritableColumnSource can accept row keys in range [0, capacity).
      Specified by:
      ensureCapacity in interface WritableColumnSource<T>
      Parameters:
      capacity - The new minimum capacity
      nullFilled - Whether data should be "null-filled". If true, get operations at row keys that have not been set will return the appropriate null value; otherwise such gets produce undefined results.

    • isImmutable

      public 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<T>
      Returns:
      true if the values at a given row key of the column source never change, false otherwise

    • releaseCachedResources

      public void releaseCachedResources()
      Description copied from interface: ColumnSource
      Release any resources held for caching purposes. Implementations need not guarantee that concurrent accesses are correct, as the purpose of this method is to ensure cleanup for column sources that will no longer be used.
      Specified by:
      releaseCachedResources in interface ColumnSource<T>
      Specified by:
      releaseCachedResources in interface Releasable