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

Class SingleValueColumnSource<T>

java.lang.Object

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

io.deephaven.engine.table.impl.sources.SingleValueColumnSource<T>

All Implemented Interfaces:

ChunkSink<Values>, ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<T>, ElementSource<T>, FillContextMaker, GetContextMaker, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, PushdownFilterMatcher, FillUnordered<Values>, InMemoryColumnSource, RowKeyAgnosticChunkSource<Values>, Releasable, TupleExporter<T>, TupleSource<T>, WritableColumnSource<T>

Direct Known Subclasses:

BooleanSingleValueSource, ByteSingleValueSource, CharacterSingleValueSource, DoubleSingleValueSource, FloatSingleValueSource, IntegerSingleValueSource, LongSingleValueSource, ObjectSingleValueSource, ShortSingleValueSource

public abstract class SingleValueColumnSource<T>
extends AbstractColumnSource<T>
implements WritableColumnSource<T>, ChunkSink<Values>, InMemoryColumnSource, RowKeyAgnosticChunkSource<Values>

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.ChunkSink

ChunkSink.FillFromContext

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

ChunkSource.FillContext, ChunkSource.GetContext, 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>

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

WritableColumnSource.ByteFiller, WritableColumnSource.CharFiller, WritableColumnSource.DoubleFiller, WritableColumnSource.FloatFiller, WritableColumnSource.IntFiller, WritableColumnSource.LongFiller, WritableColumnSource.ObjectFiller, WritableColumnSource.ShortFiller, WritableColumnSource.SinkFiller

Field Summary

Fields

Modifier and Type	Field	Description
protected long	changeTime
protected boolean	isTrackingPrevValues

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.ChunkSink

DEFAULT_FILL_FROM_INSTANCE

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

Fields inherited from interface io.deephaven.engine.table.impl.sources.InMemoryColumnSource

TWO_DIMENSIONAL_COLUMN_SOURCE_THRESHOLD

Method Summary

Modifier and Type	Method	Description
final void	ensureCapacity(long capacity, boolean nullFilled)	Ensure that this WritableColumnSource can accept row keys in range [0, capacity).
void	estimatePushdownFilterCost(WhereFilter filter, RowSet selection, boolean usePrev, PushdownFilterContext context, JobScheduler jobScheduler, LongConsumer onComplete, Consumer<Exception> onError)	Estimate the cost of pushing down the next pushdown filter.
protected abstract Chunk<Values>	getPrevValueChunk()	Returns a chunk containing the previous value for this columnSource.
static <T> SingleValueColumnSource<T>	getSingleValueColumnSource(Class<T> type)
static <T> SingleValueColumnSource<T>	getSingleValueColumnSource(Class<T> type, Class<?> componentType)
protected abstract Chunk<Values>	getValueChunk()	Returns a chunk containing the value for this column source.
boolean	isImmutable()	Determine if this column source is immutable, meaning that the values at a given row key never change.
ChunkSink.FillFromContext	makeFillFromContext(int chunkCapacity)	Provide a default, empty ChunkSink.FillFromContext for use with our default WritableColumnSource.fillFromChunk(io.deephaven.engine.table.ChunkSink.FillFromContext, io.deephaven.chunk.Chunk<? extends io.deephaven.chunk.attributes.Values>, io.deephaven.engine.rowset.RowSequence).
PushdownFilterContext	makePushdownFilterContext(WhereFilter filter, List<ColumnSource<?>> filterSources)	Create a pushdown filter context for this entity.
void	pushdownFilter(WhereFilter filter, RowSet selection, boolean usePrev, PushdownFilterContext context, long costCeiling, JobScheduler jobScheduler, Consumer<PushdownResult> onComplete, Consumer<Exception> onError)	Push down the given filter to the underlying table and pass the result to the consumer.
void	set(byte value)
void	set(char value)
void	set(double value)
void	set(float value)
void	set(int value)
void	set(long value)
void	set(short value)
void	set(T value)
void	setNull()
final void	setNull(long key)
final void	setNull(RowSequence rowSequence)
final void	startTrackingPrevValues()	ColumnSource implementations that track previous values have the option to not actually start tracking previous values until this method is called.

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

allowsReinterpret, defaultFillChunk, defaultFillPrevChunk, doReinterpret, fillChunk, fillPrevChunk, getComponentType, getPrevSource, getType, match, pushdownManager, 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.ChunkSource

fillChunk

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

fillPrevChunk

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

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

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

getChunk, getChunk, getChunkByFilling, makeFillContext, makeGetContext

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

getPrevChunk, getPrevChunk, getPrevChunkByFilling

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

get, getBoolean, getByte, getChar, getDouble, getFloat, getInt, getLong, getPrev, getPrevBoolean, getPrevByte, getPrevChar, getPrevDouble, getPrevFloat, getPrevInt, getPrevLong, getPrevShort, getShort

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

makeFillContext

Methods inherited from interface io.deephaven.engine.table.impl.sources.FillUnordered

fillChunkUnordered, fillPrevChunkUnordered, providesFillUnordered

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

makeGetContext

Methods inherited from interface io.deephaven.engine.table.impl.sources.InMemoryColumnSource

isInMemory

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

exportAllReinterpretedTo, exportAllReinterpretedTo, exportAllTo, exportElementReinterpreted

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

createTupleFromReinterpretedValues

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

ensureCapacity, fillFromChunk, fillFromChunkUnordered, set, set, set, set, set, set, set, set

Field Details

changeTime

protected transient long changeTime

isTrackingPrevValues

protected boolean isTrackingPrevValues

Method Details

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

getSingleValueColumnSource

public static <T> SingleValueColumnSource<T> getSingleValueColumnSource(Class<T> type)

getSingleValueColumnSource

public static <T> SingleValueColumnSource<T> getSingleValueColumnSource(Class<T> type,
 Class<?> componentType)

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

set

public void set(char value)

set

public void set(byte value)

set

public void set(double value)

set

public void set(float value)

set

public void set(short value)

set

public void set(long value)

set

public void set(int value)

set

public void set(T value)

setNull

public void setNull()

setNull

public final void setNull(long key)

Specified by:

setNull in interface WritableColumnSource<T>

setNull

public final void setNull(RowSequence rowSequence)

Specified by:

setNull in interface WritableColumnSource<T>

ensureCapacity

public final void ensureCapacity(long capacity,
 boolean nullFilled)

Description copied from interface: WritableColumnSource

Ensure that this WritableColumnSource can accept row keys in range [0, capacity).

Specified by:

ensureCapacity in interface WritableColumnSource<T>

Parameters:

capacity - The new minimum capacity

nullFilled - Whether data should be "null-filled". If true, get operations at row keys that have not been set will return the appropriate null value; otherwise such gets produce undefined results.

makeFillFromContext

public ChunkSink.FillFromContext makeFillFromContext(int chunkCapacity)

Description copied from interface: WritableColumnSource

Provide a default, empty ChunkSink.FillFromContext for use with our default WritableColumnSource.fillFromChunk(io.deephaven.engine.table.ChunkSink.FillFromContext, io.deephaven.chunk.Chunk<? extends io.deephaven.chunk.attributes.Values>, io.deephaven.engine.rowset.RowSequence).

Specified by:

makeFillFromContext in interface ChunkSink<T>

Specified by:

makeFillFromContext in interface WritableColumnSource<T>

makePushdownFilterContext

public PushdownFilterContext makePushdownFilterContext(WhereFilter filter,
 List<ColumnSource<?>> filterSources)

Description copied from interface: PushdownFilterMatcher

Create a pushdown filter context for this entity.

Specified by:

makePushdownFilterContext in interface PushdownFilterMatcher

Overrides:

makePushdownFilterContext in class AbstractColumnSource<T>

Parameters:

filter - the filter to use while making the context

filterSources - the column sources that match the filter column names

Returns:

the created filter context

estimatePushdownFilterCost

public void estimatePushdownFilterCost(WhereFilter filter,
 RowSet selection,
 boolean usePrev,
 PushdownFilterContext context,
 JobScheduler jobScheduler,
 LongConsumer onComplete,
 Consumer<Exception> onError)

Description copied from interface: PushdownFilterMatcher

Estimate the cost of pushing down the next pushdown filter. This returns a unitless value to compare the cost of executing different filters. Common costs are listed in PushdownResult (such as PushdownResult.REGION_METADATA_STATS_COST) and should be used as a baseline for estimating the cost of newly implemented pushdown operations.

A no-op implementation should simply complete with Long.MAX_VALUE.

Specified by:

estimatePushdownFilterCost in interface PushdownFilterMatcher

Overrides:

estimatePushdownFilterCost in class AbstractColumnSource<T>

Parameters:

filter - The filter to test.

selection - The set of rows to tests.

usePrev - Whether to use the previous result

context - The PushdownFilterContext to use for the pushdown operation.

jobScheduler - The job scheduler to use for scheduling child jobs

onComplete - Consumer of the estimated cost of the pushdown operation. 9223372036854775807L indicates that the filter cannot be pushed down.

onError - Consumer of any exceptions that occur during the estimate operation

pushdownFilter

public void pushdownFilter(WhereFilter filter,
 RowSet selection,
 boolean usePrev,
 PushdownFilterContext context,
 long costCeiling,
 JobScheduler jobScheduler,
 Consumer<PushdownResult> onComplete,
 Consumer<Exception> onError)

Description copied from interface: PushdownFilterMatcher

Push down the given filter to the underlying table and pass the result to the consumer. This method is expected to execute all pushdown filter steps that are greater than PushdownFilterContext.executedFilterCost() and less than or equal to costCeiling.

The resulting PushdownResult (to onComplete) must only contain rows from selection. The match row set are rows that are guaranteed to match. The implicitly "missing" rows selection - match - maybeMatch are rows that are guaranteed to not match. The remaining maybe match row set are rows that may, or may not, match. The pushdown result ownership passes to onComplete.

A no-op implementation should simply complete with PushdownResult.maybeMatch(selection).

Specified by:

pushdownFilter in interface PushdownFilterMatcher

Overrides:

pushdownFilter in class AbstractColumnSource<T>

Parameters:

filter - The filter to apply.

selection - The set of rows to test.

usePrev - Whether to use the previous result

context - The PushdownFilterContext to use for the pushdown operation.

costCeiling - Execute all possible filters with a cost less than or equal this value.

jobScheduler - The job scheduler to use for scheduling child jobs

onComplete - Consumer of the output rowsets for added and modified rows that pass the filter

onError - Consumer of any exceptions that occur during the pushdown operation

getValueChunk

protected abstract Chunk<Values> getValueChunk()

Returns a chunk containing the value for this column source.

getPrevValueChunk

protected abstract Chunk<Values> getPrevValueChunk()

Returns a chunk containing the previous value for this columnSource.