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

Class BitShiftingColumnSource<T>

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

  • Constructor Details

  • Method Details

    • maybeWrap

      public static <T> ColumnSource<T> maybeWrap(@NotNull @NotNull CrossJoinShiftState shiftState, @NotNull @NotNull ColumnSource<T> innerSource)
      Wrap the innerSource if it is not agnostic to redirection. Otherwise, return the innerSource.
      Parameters:
      shiftState - The cross join shift state to use
      innerSource - The column source to redirect

    • getComponentType

      public Class<?> getComponentType()
      Specified by:
      getComponentType in interface ColumnSource<T>
      Overrides:
      getComponentType in class AbstractColumnSource<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>

    • 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

    • 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

    • isUngroupable

      public boolean isUngroupable()
      Description copied from interface: UngroupableColumnSource
      Does this particular ColumnSource support ungrouping?
      Specified by:
      isUngroupable in interface UngroupableColumnSource
      Returns:
      true if you can call the getUngrouped family of methods and get a valid answer

    • getUngroupedSize

      public long getUngroupedSize(long groupRowKey)
      Specified by:
      getUngroupedSize in interface UngroupableColumnSource

    • getUngroupedPrevSize

      public long getUngroupedPrevSize(long groupRowKey)
      Specified by:
      getUngroupedPrevSize in interface UngroupableColumnSource

    • getUngrouped

      public T getUngrouped(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one Object element out of the vector.
      Specified by:
      getUngrouped in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ObjectVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrev

      public T getUngroupedPrev(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one Object element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrev in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ObjectVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedBoolean

      public Boolean getUngroupedBoolean(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one Boolean element out of the vector.
      Specified by:
      getUngroupedBoolean in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ObjectVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevBoolean

      public Boolean getUngroupedPrevBoolean(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one Boolean element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevBoolean in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ObjectVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedDouble

      public double getUngroupedDouble(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one double element out of the vector.
      Specified by:
      getUngroupedDouble in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((DoubleVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevDouble

      public double getUngroupedPrevDouble(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one double element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevDouble in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((DoubleVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedFloat

      public float getUngroupedFloat(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one float element out of the vector.
      Specified by:
      getUngroupedFloat in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((FloatVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevFloat

      public float getUngroupedPrevFloat(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one float element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevFloat in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((FloatVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedByte

      public byte getUngroupedByte(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one byte element out of the vector.
      Specified by:
      getUngroupedByte in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ByteVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevByte

      public byte getUngroupedPrevByte(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one byte element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevByte in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ByteVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedChar

      public char getUngroupedChar(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one char element out of the vector.
      Specified by:
      getUngroupedChar in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((CharVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevChar

      public char getUngroupedPrevChar(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one char element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevChar in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((CharVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedShort

      public short getUngroupedShort(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one short element out of the vector.
      Specified by:
      getUngroupedShort in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ShortVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevShort

      public short getUngroupedPrevShort(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one short element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevShort in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((ShortVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedInt

      public int getUngroupedInt(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one int element out of the vector.
      Specified by:
      getUngroupedInt in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((IntVector)columnSource.get(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevInt

      public int getUngroupedPrevInt(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one int element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevInt in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((IntVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • getUngroupedLong

      public long getUngroupedLong(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one long element out of the vector.
      Specified by:
      getUngroupedLong in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((LongVector)columnSource.getLong(groupRowKey)).get(offsetInGroup)

    • getUngroupedPrevLong

      public long getUngroupedPrevLong(long groupRowKey, int offsetInGroup)
      Description copied from interface: UngroupableColumnSource
      Reach into a grouped column source and pull one long element out of the vector as of end of the previous update cycle.
      Specified by:
      getUngroupedPrevLong in interface UngroupableColumnSource
      Parameters:
      groupRowKey - The vector's row key in the grouped column source
      offsetInGroup - Positional offset within the vector at groupRowKey
      Returns:
      Equivalent to ((LongVector)columnSource.getPrev(groupRowKey)).get(offsetInGroup)

    • 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

    • 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<T>
      Overrides:
      allowsReinterpret in class AbstractColumnSource<T>
      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<T>
      Parameters:
      alternateDataType - The alternate data type
      Returns:
      The resulting ColumnSource

    • makeFillContext

      public io.deephaven.engine.table.impl.sources.BitShiftingColumnSource.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<T>
      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

    • fillChunk

      public void fillChunk(@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<T>
      Overrides:
      fillChunk in class AbstractColumnSource<T>
      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 void fillPrevChunk(@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<T>
      Overrides:
      fillPrevChunk in class AbstractColumnSource<T>
      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

    • isStateless

      public boolean isStateless()
      Description copied from interface: ColumnSource
      Most column sources will return the same value for a given row without respect to the order that the rows are read. Those columns sources are considered "stateless" and should return true. Some column sources, however may be dependent on evaluation order. For example, a formula that updates a Map must be evaluated from the first row to the last row. A column source that has the potential to depend on the order of evaluation must return false.
      Specified by:
      isStateless in interface ColumnSource<T>
      Returns:
      true if this is a stateless column source