Interface ImmutableColumnSource<DATA_TYPE>

All Superinterfaces:
ChunkSource<Attributes.Values>, ChunkSource.WithPrev<Attributes.Values>, ColumnSource<DATA_TYPE>, DefaultChunkSource<Attributes.Values>, DefaultChunkSource.WithPrev<Attributes.Values>, ElementSource<DATA_TYPE>, FillContextMaker, GetContextMaker, Releasable, TupleExporter<DATA_TYPE>, TupleSource<DATA_TYPE>
All Known Subinterfaces:
ImmutableColumnSourceGetDefaults.ForBoolean, ImmutableColumnSourceGetDefaults.ForByte, ImmutableColumnSourceGetDefaults.ForChar, ImmutableColumnSourceGetDefaults.ForDouble, ImmutableColumnSourceGetDefaults.ForFloat, ImmutableColumnSourceGetDefaults.ForInt, ImmutableColumnSourceGetDefaults.ForLong, ImmutableColumnSourceGetDefaults.ForLongAsDateTime, ImmutableColumnSourceGetDefaults.ForObject<DATA_TYPE>, ImmutableColumnSourceGetDefaults.ForShort, ImmutableColumnSourceGetDefaults.LongBacked<DATA_TYPE>, PartitioningRegionedSource, RegionedColumnSource<DATA_TYPE>
All Known Implementing Classes:
AbstractColumnSource.DefaultedImmutable, ImmutableBooleanArraySource, ImmutableByteArraySource, ImmutableCharArraySource, ImmutableDateTimeArraySource, ImmutableDoubleArraySource, ImmutableFloatArraySource, ImmutableInstantArraySource, ImmutableIntArraySource, ImmutableLongArraySource, ImmutableObjectArraySource, ImmutableShortArraySource, RegionedColumnSourceBase, RegionedColumnSourceObject, RegionedColumnSourceObject.AsValues, RegionedColumnSourceObjectWithDictionary, RegionedColumnSourcePartitioning, RowIdSource, SingleValueObjectColumnSource, SymbolTableToUniqueIdSource

public interface ImmutableColumnSource<DATA_TYPE> extends ColumnSource<DATA_TYPE>
Sub-interface of ColumnSource for implementations that always use return true from isImmutable() and delegate all getPrev* methods to their current (non-previous) equivalents.
  • Method Details

    • getPrev

      default DATA_TYPE getPrev(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index. Previous values are used during an LTM update cycle to process changes in data. During normal operation previous values will be identical to current values.
      Specified by:
      getPrev in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the value from.
      Returns:
      the previous value at the index, or null.
    • getPrevBoolean

      default Boolean getPrevBoolean(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as a Boolean. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevBoolean in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous boolean at the index, or null.
    • getPrevByte

      default byte getPrevByte(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as a byte. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevByte in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous boolean at the index, null values are represented by QueryConstants.NULL_BYTE
    • getPrevChar

      default char getPrevChar(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as a char. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevChar in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous char at the index, null values are represented by QueryConstants.NULL_CHAR
    • getPrevDouble

      default double getPrevDouble(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as a double. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevDouble in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous double at the index, null values are represented by QueryConstants.NULL_DOUBLE
    • getPrevFloat

      default float getPrevFloat(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as a float. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevFloat in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous float at the index, null values are represented by QueryConstants.NULL_FLOAT
    • getPrevInt

      default int getPrevInt(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as an int. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevInt in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous int at the index, null values are represented by QueryConstants.NULL_INT
    • getPrevLong

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

      default short getPrevShort(long elementIndex)
      Description copied from interface: ElementSource
      Get the previous value at the index as a short. See ElementSource.getPrev(long) for more details.
      Specified by:
      getPrevShort in interface ElementSource<DATA_TYPE>
      Parameters:
      elementIndex - the location in index space to get the previous value from.
      Returns:
      the previous short at the index, null values are represented by QueryConstants.NULL_SHORT
    • isImmutable

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