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

Class CharAggregateColumnSource

java.lang.Object
io.deephaven.engine.table.impl.AbstractColumnSource<VECTOR_TYPE>
io.deephaven.engine.table.impl.sources.aggregate.CharAggregateColumnSource
All Implemented Interfaces:
ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<CharVector>, ElementSource<CharVector>, FillContextMaker, GetContextMaker, ColumnSourceGetDefaults.ForObject<CharVector>, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, MutableColumnSource<CharVector>, MutableColumnSourceGetDefaults.ForObject<CharVector>, AggregateColumnSource<CharVector,Character>, UngroupableColumnSource, Releasable, TupleExporter<CharVector>, TupleSource<CharVector>
public final class CharAggregateColumnSource extends AbstractColumnSource<VECTOR_TYPE>
ColumnSource implementation for aggregation result char columns.

  • Method Details

    • get

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

    • getPrev

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

    • fillChunk

      public 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<Values>
      Overrides:
      fillChunk in class AbstractColumnSource<CharVector>
      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 @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<Values>
      Overrides:
      fillPrevChunk in class AbstractColumnSource<CharVector>
      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

    • ungrouped

      public final UngroupedColumnSource<Character> ungrouped()
      Specified by:
      ungrouped in interface AggregateColumnSource<VECTOR_TYPE extends Vector<VECTOR_TYPE>,COMPONENT_TYPE>

    • 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<VECTOR_TYPE extends Vector<VECTOR_TYPE>>

    • 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<VECTOR_TYPE extends Vector<VECTOR_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

    • isUngroupable

      public final 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 final long getUngroupedSize(long groupRowKey)
      Specified by:
      getUngroupedSize in interface UngroupableColumnSource

    • getUngroupedPrevSize

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

    • getUngrouped

      public final Object 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 final Object 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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)

    • 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<VECTOR_TYPE extends Vector<VECTOR_TYPE>>
      Returns:
      true if this is a stateless column source

    • 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<VECTOR_TYPE extends Vector<VECTOR_TYPE>>
      Specified by:
      isImmutable in interface MutableColumnSource<VECTOR_TYPE extends Vector<VECTOR_TYPE>>
      Returns:
      true if the values at a given row key of the column source never change, false otherwise