Package io.deephaven.engine.table

Interface ElementSource<T>

Type Parameters:
T - the type of underlying data.
All Known Subinterfaces:
AggregateColumnSource<VECTOR_TYPE,COMPONENT_TYPE>, ChunkColumnSource<T>, ColumnSource<T>, ColumnSourceGetDefaults.ForBoolean, ColumnSourceGetDefaults.ForByte, ColumnSourceGetDefaults.ForChar, ColumnSourceGetDefaults.ForDouble, ColumnSourceGetDefaults.ForFloat, ColumnSourceGetDefaults.ForInt, ColumnSourceGetDefaults.ForLong, ColumnSourceGetDefaults.ForLongAsInstant, ColumnSourceGetDefaults.ForObject<DATA_TYPE>, ColumnSourceGetDefaults.ForShort, ColumnSourceGetDefaults.LongBacked<DATA_TYPE>, ContextualizedObjectColumnSource<DATA_TYPE>, ImmutableColumnSource<DATA_TYPE>, ImmutableColumnSourceGetDefaults.ForBoolean, ImmutableColumnSourceGetDefaults.ForByte, ImmutableColumnSourceGetDefaults.ForChar, ImmutableColumnSourceGetDefaults.ForDouble, ImmutableColumnSourceGetDefaults.ForFloat, ImmutableColumnSourceGetDefaults.ForInt, ImmutableColumnSourceGetDefaults.ForLong, ImmutableColumnSourceGetDefaults.ForLongAsInstant, ImmutableColumnSourceGetDefaults.ForObject<DATA_TYPE>, ImmutableColumnSourceGetDefaults.ForShort, ImmutableColumnSourceGetDefaults.LongBacked<DATA_TYPE>, MutableColumnSource<DATA_TYPE>, MutableColumnSourceGetDefaults.ForBoolean, MutableColumnSourceGetDefaults.ForByte, MutableColumnSourceGetDefaults.ForChar, MutableColumnSourceGetDefaults.ForDouble, MutableColumnSourceGetDefaults.ForFloat, MutableColumnSourceGetDefaults.ForInt, MutableColumnSourceGetDefaults.ForLong, MutableColumnSourceGetDefaults.ForLongAsInstant, MutableColumnSourceGetDefaults.ForObject<DATA_TYPE>, MutableColumnSourceGetDefaults.ForShort, MutableColumnSourceGetDefaults.LongBacked<DATA_TYPE>, RegionedColumnSource<DATA_TYPE>, ReverseLookupColumnSource<DATA_TYPE,EXTRA_VALUE_TYPE>, SizedColumnSource<DATA_TYPE>, SizedContextualizedObjectColumnSource<DATA_TYPE>, SsmBackedColumnSource<K,T>, SymbolTableSource<SYMBOL_TYPE>, WritableColumnSource<T>
All Known Implementing Classes:
AbstractArrowColumnSource, AbstractColumnSource, AbstractColumnSource.DefaultedImmutable, AbstractColumnSource.DefaultedMutable, AlternatingColumnSource, ArrayBackedColumnSource, ArrowBooleanColumnSource, ArrowByteColumnSource, ArrowCharColumnSource, ArrowDoubleColumnSource, ArrowFloatColumnSource, ArrowInstantColumnSource, ArrowIntColumnSource, ArrowLocalTimeColumnSource, ArrowLongColumnSource, ArrowObjectColumnSource, ArrowShortColumnSource, ArrowStringColumnSource, ArrowUInt1ColumnSource, ArrowUInt4ColumnSource, ArrowUInt8ColumnSource, BaseAggregateSlicedColumnSource, BitMaskingColumnSource, BitShiftingColumnSource, BooleanArraySource, BooleanAsByteColumnSource, BooleanSingleValueSource, BooleanSparseArraySource, BooleanSparseArraySource.ReinterpretedAsByte, ByteAggregateColumnSource, ByteArraySource, ByteAsBooleanColumnSource, ByteChunkColumnSource, ByteSingleValueSource, ByteSparseArraySource, ByteSsmBackedSource, CharacterArraySource, CharacterSingleValueSource, CharacterSparseArraySource, CharAggregateColumnSource, CharChunkColumnSource, CharSsmBackedSource, CrossJoinRightColumnSource, DelegatingColumnSource, DeltaAwareColumnSource, DoubleAggregateColumnSource, DoubleArraySource, DoubleChunkColumnSource, DoubleNullToZeroColumnSource, DoubleSingleValueSource, DoubleSparseArraySource, DoubleSsmBackedSource, FloatAggregateColumnSource, FloatArraySource, FloatChunkColumnSource, FloatSingleValueSource, FloatSparseArraySource, FloatSsmBackedSource, Formula, FormulaKernelAdapter, HashTableColumnSource, Immutable2DByteArraySource, Immutable2DCharArraySource, Immutable2DDoubleArraySource, Immutable2DFloatArraySource, Immutable2DInstantArraySource, Immutable2DIntArraySource, Immutable2DLongArraySource, Immutable2DNanosBasedTimeArraySource, Immutable2DObjectArraySource, Immutable2DShortArraySource, Immutable2DZonedDateTimeArraySource, ImmutableByteArraySource, ImmutableCharArraySource, ImmutableConstantByteSource, ImmutableConstantCharSource, ImmutableConstantDoubleSource, ImmutableConstantFloatSource, ImmutableConstantInstantSource, ImmutableConstantIntSource, ImmutableConstantLongSource, ImmutableConstantNanosBasedTimeSource, ImmutableConstantObjectSource, ImmutableConstantShortSource, ImmutableConstantZonedDateTimeSource, ImmutableDoubleArraySource, ImmutableFloatArraySource, ImmutableInstantArraySource, ImmutableIntArraySource, ImmutableLongArraySource, ImmutableNanosBasedTimeArraySource, ImmutableObjectArraySource, ImmutableShortArraySource, ImmutableZonedDateTimeArraySource, InstantArraySource, InstantAsLongColumnSource, InstantSparseArraySource, InstantSsmSourceWrapper, IntAggregateColumnSource, IntChunkColumnSource, IntegerArraySource, IntegerSingleValueSource, IntegerSparseArraySource, IntSsmBackedSource, LocalDateWrapperSource, LocalTimeWrapperSource, LongAggregateColumnSource, LongArraySource, LongAsInstantColumnSource, LongAsLocalDateColumnSource, LongAsLocalTimeColumnSource, LongAsTimeSource, LongAsZonedDateTimeColumnSource, LongChunkColumnSource, LongSingleValueSource, LongSparseArraySource, LongSsmBackedSource, MergeSortedHelper.SortedMergeColumnSource, NanosBasedTimeArraySource, NanosBasedTimeSparseArraySource, NullValueColumnSource, ObjectAggregateColumnSource, ObjectArraySource, ObjectChunkColumnSource, ObjectSingleValueSource, ObjectSparseArraySource, ObjectSsmBackedSource, PrevColumnSource, RangeAggregateColumnSource, RangeAggregateColumnSourceByte, RangeAggregateColumnSourceChar, RangeAggregateColumnSourceDouble, RangeAggregateColumnSourceFloat, RangeAggregateColumnSourceInt, RangeAggregateColumnSourceLong, RangeAggregateColumnSourceObject, RangeAggregateColumnSourceShort, RedirectedColumnSource, ReversedColumnSource, RowKeyColumnSource, RowPositionColumnSource, RowSetColumnSourceWrapper, ShiftedColumnSource, ShortAggregateColumnSource, ShortArraySource, ShortChunkColumnSource, ShortSingleValueSource, ShortSparseArraySource, ShortSsmBackedSource, SingleValueColumnSource, SingleValueObjectColumnSource, SlicedByteAggregateColumnSource, SlicedCharAggregateColumnSource, SlicedDoubleAggregateColumnSource, SlicedFloatAggregateColumnSource, SlicedIntAggregateColumnSource, SlicedLongAggregateColumnSource, SlicedObjectAggregateColumnSource, SlicedShortAggregateColumnSource, SparseArrayColumnSource, SwitchColumnSource, SymbolTableToUniqueIdSource, UnboxedLongBackedColumnSource, UnboxedLongBackedColumnSource, UnboxedTimeBackedColumnSource, UngroupedArrayColumnSource, UngroupedBooleanArrayColumnSource, UngroupedBoxedBooleanArrayColumnSource, UngroupedBoxedByteArrayColumnSource, UngroupedBoxedByteObjectVectorColumnSource, UngroupedBoxedCharArrayColumnSource, UngroupedBoxedCharObjectVectorColumnSource, UngroupedBoxedDoubleArrayColumnSource, UngroupedBoxedDoubleObjectVectorColumnSource, UngroupedBoxedFloatArrayColumnSource, UngroupedBoxedFloatObjectVectorColumnSource, UngroupedBoxedIntArrayColumnSource, UngroupedBoxedIntObjectVectorColumnSource, UngroupedBoxedLongArrayColumnSource, UngroupedBoxedLongObjectVectorColumnSource, UngroupedBoxedShortArrayColumnSource, UngroupedBoxedShortObjectVectorColumnSource, UngroupedByteArrayColumnSource, UngroupedByteVectorColumnSource, UngroupedCharArrayColumnSource, UngroupedCharVectorColumnSource, UngroupedColumnSource, UngroupedDoubleArrayColumnSource, UngroupedDoubleVectorColumnSource, UngroupedFloatArrayColumnSource, UngroupedFloatVectorColumnSource, UngroupedIntArrayColumnSource, UngroupedIntVectorColumnSource, UngroupedLongArrayColumnSource, UngroupedLongVectorColumnSource, UngroupedObjectVectorColumnSource, UngroupedShortArrayColumnSource, UngroupedShortVectorColumnSource, UnionColumnSource, ViewColumnSource, WritableByteAsBooleanColumnSource, WritableRedirectedColumnSource, ZonedDateTimeArraySource, ZonedDateTimeAsLongSource, ZonedDateTimeSparseArraySource
public interface ElementSource<T>
A source of element data within a table.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    get(long rowKey)
    Get the value from the source.
    @Nullable Boolean
    getBoolean(long rowKey)
    Get the value at the rowKey as a Boolean.
    byte
    getByte(long rowKey)
    Get the value at the rowKey as a byte.
    char
    getChar(long rowKey)
    Get the value at the rowKey as a char.
    double
    getDouble(long rowKey)
    Get the value at the rowKey as a double.
    float
    getFloat(long rowKey)
    Get the value at the rowKey as a float.
    int
    getInt(long rowKey)
    Get the value at the rowKey as an int.
    long
    getLong(long rowKey)
    Get the value at the rowKey as a long.
    T
    getPrev(long rowKey)
    Get the previous value at the rowKey.
    @Nullable Boolean
    getPrevBoolean(long rowKey)
    Get the previous value at the rowKey as a Boolean.
    byte
    getPrevByte(long rowKey)
    Get the previous value at the rowKey as a byte.
    char
    getPrevChar(long rowKey)
    Get the previous value at the rowKey as a char.
    double
    getPrevDouble(long rowKey)
    Get the previous value at the rowKey as a double.
    float
    getPrevFloat(long rowKey)
    Get the previous value at the rowKey as a float.
    int
    getPrevInt(long rowKey)
    Get the previous value at the rowKey as an int.
    long
    getPrevLong(long rowKey)
    Get the previous value at the rowKey as a long.
    short
    getPrevShort(long rowKey)
    Get the previous value at the rowKey as a short.
    short
    getShort(long rowKey)
    Get the value at the rowKey as a short.

  • Method Details

    • get

      @Nullable T get(long rowKey)
      Get the value from the source. This may return boxed values for basic types. RowKeys that are not present are undefined.
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the value at the rowKey, potentially null.

    • getBoolean

      @Nullable @Nullable Boolean getBoolean(long rowKey)
      Get the value at the rowKey as a Boolean. RowKeys that are not present are undefined.
      Parameters:
      rowKey - the location in key space to get the value from.
      Returns:
      the boolean at the rowKey, potentially null.

    • getByte

      byte getByte(long rowKey)
      Get the value at the rowKey as a byte. RowKeys that are not present are undefined.
      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

      char getChar(long rowKey)
      Get the value at the rowKey as a char. RowKeys that are not present are undefined.
      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

      double getDouble(long rowKey)
      Get the value at the rowKey as a double. RowKeys that are not present are undefined.
      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

      float getFloat(long rowKey)
      Get the value at the rowKey as a float. RowKeys that are not present are undefined.
      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

      int getInt(long rowKey)
      Get the value at the rowKey as an int. RowKeys that are not present are undefined.
      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

      long getLong(long rowKey)
      Get the value at the rowKey as a long. RowKeys that are not present are undefined.
      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

      short getShort(long rowKey)
      Get the value at the rowKey as a short. RowKeys that are not present are undefined.
      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

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

    • getPrevBoolean

      @Nullable @Nullable Boolean getPrevBoolean(long rowKey)
      Get the previous value at the rowKey as a Boolean. See getPrev(long) for more details. RowKeys that were not present are undefined.
      Parameters:
      rowKey - the location in key space to get the previous value from.
      Returns:
      the previous boolean at the rowKey, potentially null.

    • getPrevByte

      byte getPrevByte(long rowKey)
      Get the previous value at the rowKey as a byte. See getPrev(long) for more details. RowKeys that were not present are undefined.
      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

      char getPrevChar(long rowKey)
      Get the previous value at the rowKey as a char. See getPrev(long) for more details. RowKeys that were not present are undefined.
      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

      double getPrevDouble(long rowKey)
      Get the previous value at the rowKey as a double. See getPrev(long) for more details. RowKeys that were not present are undefined.
      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

      float getPrevFloat(long rowKey)
      Get the previous value at the rowKey as a float. See getPrev(long) for more details. RowKeys that were not present are undefined.
      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

      int getPrevInt(long rowKey)
      Get the previous value at the rowKey as an int. See getPrev(long) for more details. RowKeys that were not present are undefined.
      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

      long getPrevLong(long rowKey)
      Get the previous value at the rowKey as a long. See getPrev(long) for more details.
      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

      short getPrevShort(long rowKey)
      Get the previous value at the rowKey as a short. See getPrev(long) for more details. RowKeys that were not present are undefined.
      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