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

Class RowSetColumnSourceWrapper

java.lang.Object

io.deephaven.engine.table.impl.AbstractColumnSource<RowSet>

io.deephaven.engine.table.impl.sources.RowSetColumnSourceWrapper

All Implemented Interfaces:

ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<RowSet>, ElementSource<RowSet>, FillContextMaker, GetContextMaker, ColumnSourceGetDefaults.ForObject<RowSet>, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, MutableColumnSource<RowSet>, MutableColumnSourceGetDefaults.ForObject<RowSet>, Releasable, TupleExporter<RowSet>, TupleSource<RowSet>

public class RowSetColumnSourceWrapper
extends AbstractColumnSource<RowSet>
implements MutableColumnSourceGetDefaults.ForObject<RowSet>

This class wraps a ColumnSource of RowSet and returns TrackingRowSet.prev() when previous values are requested and the accessed value is tracking. This should be used when the row set objects are mutated instead of replaced during a cycle, e.g. when TableOperations.aggBy(Aggregation) is used with AggregationProcessor.forExposeGroupRowSets().

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.AbstractColumnSource

AbstractColumnSource.DefaultedImmutable<DATA_TYPE>, AbstractColumnSource.DefaultedMutable<DATA_TYPE>

Nested classes/interfaces inherited from interface io.deephaven.engine.table.ChunkSource

ChunkSource.FillContext, ChunkSource.WithPrev<ATTR extends Any>

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.DefaultChunkSource

DefaultChunkSource.SupportsContiguousGet<ATTR extends Any>, DefaultChunkSource.WithPrev<ATTR extends Any>

Nested classes/interfaces inherited from interface io.deephaven.engine.table.TupleExporter

TupleExporter.ExportElementFunction<TUPLE_TYPE>

Field Summary

Fields inherited from class io.deephaven.engine.table.impl.AbstractColumnSource

componentType, type, updateGraph, USE_RANGES_AVERAGE_RUN_LENGTH

Fields inherited from interface io.deephaven.engine.table.ChunkSource

DEFAULT_FILL_INSTANCE, ZERO_LENGTH_CHUNK_SOURCE_ARRAY

Fields inherited from interface io.deephaven.engine.table.ChunkSource.WithPrev

ZERO_LENGTH_CHUNK_SOURCE_WITH_PREV_ARRAY

Fields inherited from interface io.deephaven.engine.table.ColumnSource

ZERO_LENGTH_COLUMN_SOURCE_ARRAY

Method Summary

Modifier and Type	Method	Description
void	fillChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Values> destination, @NotNull RowSequence rowSequence)	Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
void	fillPrevChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Values> destination, @NotNull RowSequence rowSequence)	Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
static RowSetColumnSourceWrapper	from(@NotNull ColumnSource<? extends RowSet> source)
@Nullable RowSet	get(long rowKey)	Get the value from the source.
Chunk<? extends Values>	getChunk(ChunkSource.GetContext context, long firstKey, long lastKey)	Same as ChunkSource.getChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence.
Chunk<? extends Values>	getChunk(ChunkSource.GetContext context, @NotNull RowSequence rowSequence)	Returns a chunk of data corresponding to the keys from the given RowSequence.
Class<?>	getComponentType()
@Nullable RowSet	getPrev(long rowKey)	Get the previous value at the rowKey.
Chunk<? extends Values>	getPrevChunk(ChunkSource.GetContext context, long firstKey, long lastKey)	Same as ChunkSource.WithPrev.getPrevChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence.
Chunk<? extends Values>	getPrevChunk(ChunkSource.GetContext context, @NotNull RowSequence rowSequence)	Returns a chunk of previous data corresponding to the keys from the given RowSequence.
Class<RowSet>	getType()
ChunkSource.FillContext	makeFillContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.
ChunkSource.GetContext	makeGetContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.GetContext for retrieving chunks from this GetContextMaker, typically a ChunkSource.

Methods inherited from class io.deephaven.engine.table.impl.AbstractColumnSource

allowsReinterpret, defaultFillChunk, defaultFillPrevChunk, doReinterpret, getPrevSource, match, reinterpret

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.engine.table.ColumnSource

allowsReinterpret, cast, cast, cast, cast, createPreviousTuple, createTuple, createTupleFromValues, exportAllTo, exportElement, exportElement, getChunkType, getPrevSource, isStateless, match, reinterpret, releaseCachedResources, startTrackingPrevValues, tupleLength

Methods inherited from interface io.deephaven.engine.table.impl.ColumnSourceGetDefaults.ForObject

getBoolean, getByte, getChar, getDouble, getFloat, getInt, getLong, getShort

Methods inherited from interface io.deephaven.engine.table.impl.DefaultChunkSource

getChunkByFilling

Methods inherited from interface io.deephaven.engine.table.impl.DefaultChunkSource.WithPrev

getPrevChunkByFilling

Methods inherited from interface io.deephaven.engine.table.FillContextMaker

makeFillContext

Methods inherited from interface io.deephaven.engine.table.GetContextMaker

makeGetContext

Methods inherited from interface io.deephaven.engine.table.impl.MutableColumnSource

isImmutable

Methods inherited from interface io.deephaven.engine.table.impl.MutableColumnSourceGetDefaults.ForObject

getPrevBoolean, getPrevByte, getPrevChar, getPrevDouble, getPrevFloat, getPrevInt, getPrevLong, getPrevShort

Methods inherited from interface io.deephaven.engine.table.TupleExporter

exportAllReinterpretedTo, exportAllReinterpretedTo, exportAllTo, exportElementReinterpreted

Methods inherited from interface io.deephaven.engine.table.TupleSource

createTupleFromReinterpretedValues

Method Details

from

public static RowSetColumnSourceWrapper from(@NotNull
 @NotNull ColumnSource<? extends RowSet> source)

getType

public Class<RowSet> getType()

Specified by:

getType in interface ColumnSource<RowSet>

Overrides:

getType in class AbstractColumnSource<RowSet>

getComponentType

public Class<?> getComponentType()

Specified by:

getComponentType in interface ColumnSource<RowSet>

Overrides:

getComponentType in class AbstractColumnSource<RowSet>

get

@Nullable
public @Nullable RowSet 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<RowSet>

Parameters:

rowKey - the location in key space to get the value from.

Returns:

the value at the rowKey, potentially null.

getPrev

@Nullable
public @Nullable RowSet 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<RowSet>

Parameters:

rowKey - the location in key space to get the value from.

Returns:

the previous value at the rowKey, potentially null.

makeGetContext

public ChunkSource.GetContext makeGetContext(int chunkCapacity,
 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<Values>

Specified by:

makeGetContext in interface GetContextMaker

Parameters:

chunkCapacity - 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 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<Values>

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

getChunk

public Chunk<? extends Values> getChunk(@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<Values>

Specified by:

getChunk in interface DefaultChunkSource<Values>

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

getChunk

public Chunk<? extends Values> getChunk(@NotNull
 ChunkSource.GetContext context,
 long firstKey,
 long lastKey)

Description copied from interface: ChunkSource

Same as ChunkSource.getChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence. Typically you want to call this only if you don't have an RowSequence, such as during an RowSequence.forAllRowKeyRanges(LongRangeConsumer) call. In this case, it allows you to avoid creating an intermediary RowSequence object.

Specified by:

getChunk in interface ChunkSource<Values>

Specified by:

getChunk in interface DefaultChunkSource<Values>

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

firstKey - The beginning key (inclusive) of the range to fetch in the chunk

lastKey - The last key (inclusive) of the range to fetch in the chunk

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<RowSet>

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

getPrevChunk

public Chunk<? extends Values> getPrevChunk(@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<Values>

Specified by:

getPrevChunk in interface DefaultChunkSource.WithPrev<Values>

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

getPrevChunk

public Chunk<? extends Values> getPrevChunk(@NotNull
 ChunkSource.GetContext context,
 long firstKey,
 long lastKey)

Description copied from interface: ChunkSource.WithPrev

Same as ChunkSource.WithPrev.getPrevChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence.

Specified by:

getPrevChunk in interface ChunkSource.WithPrev<Values>

Specified by:

getPrevChunk in interface DefaultChunkSource.WithPrev<Values>

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<RowSet>

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