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

Class ObjectArraySource<T>

java.lang.Object

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

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

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

All Implemented Interfaces:

ChunkSink<Values>, ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<T>, ElementSource<T>, FillContextMaker, GetContextMaker, ColumnSourceGetDefaults.ForObject<T>, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, MutableColumnSource<T>, MutableColumnSourceGetDefaults.ForObject<T>, ChunkedBackingStoreExposedWritableSource, FillUnordered<Values>, InMemoryColumnSource, Releasable, TupleExporter<T>, TupleSource<T>, WritableColumnSource<T>, WritableSourceWithPrepareForParallelPopulation

public class ObjectArraySource<T>
extends ArrayBackedColumnSource<T>
implements MutableColumnSourceGetDefaults.ForObject<T>

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	ensurePreviousClockCycle	If ensure previous has been called, we need not check previous values when filling.
protected gnu.trove.list.array.TIntArrayList	prevAllocated
protected UpdateCommitter<io.deephaven.engine.table.impl.sources.ArraySourceHelper<T,T[]>>	prevFlusher	The presence of a prevFlusher means that this ArraySource wants to track previous values.

Fields inherited from class io.deephaven.engine.table.impl.sources.ArrayBackedColumnSource

BLOCK_SIZE

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

Constructor Summary

Constructors

Constructor	Description
ObjectArraySource(Class<T> type)
ObjectArraySource(Class<T> type, Class<?> componentType)

Method Summary

Modifier and Type	Method	Description
void	copyFromChunk(long firstKey, long totalLength, Chunk<? extends Values> src, int offset)
void	ensureCapacity(long capacity, boolean nullFill)	Ensure that this WritableColumnSource can accept row keys in range [0, capacity).
void	fillChunk(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	fillFromChunk(@NotNull ChunkSink.FillFromContext context, @NotNull Chunk<? extends Values> src, @NotNull RowSequence rowSequence)	Our default, inefficient, implementation.
void	fillFromChunkUnordered(@NotNull ChunkSink.FillFromContext context, @NotNull Chunk<? extends Values> src, @NotNull LongChunk<RowKeys> keys)	Fills the ChunkSink with data from the source, with data corresponding to the keys from the given key chunk.
void	fillPrevChunk(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.
protected void	fillSparseChunk(@NotNull WritableChunk<? super Values> destGeneric, @NotNull RowSequence indices)
protected void	fillSparseChunkUnordered(@NotNull WritableChunk<? super Values> destGeneric, @NotNull LongChunk<? extends RowKeys> indices)
protected void	fillSparsePrevChunk(@NotNull WritableChunk<? super Values> destGeneric, @NotNull RowSequence indices)
protected void	fillSparsePrevChunkUnordered(@NotNull WritableChunk<? super Values> destGeneric, @NotNull LongChunk<? extends RowKeys> indices)
final T	get(long rowKey)	Get the value from the source.
final T	getAndSetUnsafe(long index, T newValue)
final long	getCapacity()	Get the capacity of this column source.
T	getPrev(long rowKey)	Get the previous value at the rowKey.
final T	getUnsafe(long index)
ChunkSource.FillContext	makeFillContext(int chunkCapacity, SharedContext sharedContext)	Allocate a new ChunkSource.FillContext for filling chunks from this FillContextMaker, typically a ChunkSource.
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).
void	move(long source, long dest, long length)
void	prepareForParallelPopulation(RowSequence changedIndices)	This version of `prepareForParallelPopulation` will internally call ensureCapacity(long, boolean) to make sure there is room for the incoming values.
long	resetWritableChunkToBackingStore(@NotNull ResettableWritableChunk<?> chunk, long position)	Resets the given chunk to provide a write-through reference to our backing array.
long	resetWritableChunkToBackingStoreSlice(@NotNull ResettableWritableChunk<?> chunk, long position)	Resets the given chunk to provide a write-through reference to our backing array.
void	set(long key, T value)
void	setNull(long key)
void	startTrackingPrevValues()	Force my inheritors to implement this method, rather than taking the interface default.

Methods inherited from class io.deephaven.engine.table.impl.sources.ArrayBackedColumnSource

fillChunkUnordered, fillPrevChunkUnordered, from, from, getBooleanMemoryColumnSource, getChunk, getInstantMemoryColumnSource, getInstantMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSource, getMemoryColumnSourceUntyped, getMemoryColumnSourceUntyped, isImmutable, providesFillUnordered, set, set, set, set, set, set, set

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

allowsReinterpret, defaultFillChunk, defaultFillPrevChunk, doReinterpret, getComponentType, getPrevSource, getType, 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.impl.sources.ChunkedBackingStoreExposedWritableSource

exposesChunkedBackingStore

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.ColumnSourceGetDefaults.ForObject

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

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

getChunk, getChunkByFilling, makeGetContext

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

getPrevChunk, getPrevChunk, 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.sources.InMemoryColumnSource

isInMemory

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

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

ensureCapacity, setNull

Field Details

prevFlusher

protected transient UpdateCommitter<io.deephaven.engine.table.impl.sources.ArraySourceHelper<T,T[]>> prevFlusher

The presence of a prevFlusher means that this ArraySource wants to track previous values. If prevFlusher is null, the ArraySource does not want (or does not yet want) to track previous values. Deserialized ArraySources never track previous values.

prevAllocated

protected transient gnu.trove.list.array.TIntArrayList prevAllocated

ensurePreviousClockCycle

protected transient long ensurePreviousClockCycle

If ensure previous has been called, we need not check previous values when filling.

Constructor Details

ObjectArraySource

public ObjectArraySource(Class<T> type)

ObjectArraySource

public ObjectArraySource(Class<T> type,
 Class<?> componentType)

Method Details

startTrackingPrevValues

public void startTrackingPrevValues()

Force my inheritors to implement this method, rather than taking the interface default.

Specified by:

startTrackingPrevValues in interface ColumnSource<T>

ensureCapacity

public void ensureCapacity(long capacity,
 boolean nullFill)

Description copied from interface: WritableColumnSource

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

Specified by:

ensureCapacity in interface WritableColumnSource<T>

Specified by:

ensureCapacity in class ArrayBackedColumnSource<T>

Parameters:

capacity - The new minimum capacity

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

prepareForParallelPopulation

public void prepareForParallelPopulation(RowSequence changedIndices)

This version of `prepareForParallelPopulation` will internally call ensureCapacity(long, boolean) to make sure there is room for the incoming values.

Specified by:

prepareForParallelPopulation in interface WritableSourceWithPrepareForParallelPopulation

Parameters:

changedIndices - indices in the dense table

setNull

public void setNull(long key)

Specified by:

setNull in interface WritableColumnSource<T>

set

public void set(long key,
 T value)

Specified by:

set in interface WritableColumnSource<T>

get

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

Parameters:

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

Returns:

the value at the rowKey, potentially null.

getUnsafe

public final T getUnsafe(long index)

getAndSetUnsafe

public final T getAndSetUnsafe(long index,
 T newValue)

getPrev

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

Parameters:

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

Returns:

the previous value at the rowKey, potentially null.

resetWritableChunkToBackingStore

public long resetWritableChunkToBackingStore(@NotNull
 @NotNull ResettableWritableChunk<?> chunk,
 long position)

Description copied from interface: ChunkedBackingStoreExposedWritableSource

Resets the given chunk to provide a write-through reference to our backing array.

Note: This is unsafe to use if previous tracking has been enabled!

Specified by:

resetWritableChunkToBackingStore in interface ChunkedBackingStoreExposedWritableSource

Parameters:

chunk - the writable chunk to reset to our backing array.

position - position that we require

Returns:

the first position addressable by the chunk

resetWritableChunkToBackingStoreSlice

public long resetWritableChunkToBackingStoreSlice(@NotNull
 @NotNull ResettableWritableChunk<?> chunk,
 long position)

Description copied from interface: ChunkedBackingStoreExposedWritableSource

Resets the given chunk to provide a write-through reference to our backing array.

Note: This is unsafe to use if previous tracking has been enabled!

Specified by:

resetWritableChunkToBackingStoreSlice in interface ChunkedBackingStoreExposedWritableSource

Parameters:

chunk - the writable chunk to reset to a slice of our backing array.

position - position of the first value in the returned chunk

Returns:

the capacity of the returned chunk

fillChunk

public void fillChunk(@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<T>

Overrides:

fillChunk in class AbstractColumnSource<T>

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

Overrides:

fillPrevChunk in class AbstractColumnSource<T>

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

fillSparseChunk

protected void fillSparseChunk(@NotNull
 @NotNull WritableChunk<? super Values> destGeneric,
 @NotNull
 @NotNull RowSequence indices)

Specified by:

fillSparseChunk in class ArrayBackedColumnSource<T>

fillSparsePrevChunk

protected void fillSparsePrevChunk(@NotNull
 @NotNull WritableChunk<? super Values> destGeneric,
 @NotNull
 @NotNull RowSequence indices)

Specified by:

fillSparsePrevChunk in class ArrayBackedColumnSource<T>

fillSparseChunkUnordered

protected void fillSparseChunkUnordered(@NotNull
 @NotNull WritableChunk<? super Values> destGeneric,
 @NotNull
 @NotNull LongChunk<? extends RowKeys> indices)

Specified by:

fillSparseChunkUnordered in class ArrayBackedColumnSource<T>

fillSparsePrevChunkUnordered

protected void fillSparsePrevChunkUnordered(@NotNull
 @NotNull WritableChunk<? super Values> destGeneric,
 @NotNull
 @NotNull LongChunk<? extends RowKeys> indices)

Specified by:

fillSparsePrevChunkUnordered in class ArrayBackedColumnSource<T>

copyFromChunk

public void copyFromChunk(long firstKey,
 long totalLength,
 Chunk<? extends Values> src,
 int offset)

fillFromChunkUnordered

public void fillFromChunkUnordered(@NotNull
 @NotNull ChunkSink.FillFromContext context,
 @NotNull
 @NotNull Chunk<? extends Values> src,
 @NotNull
 @NotNull LongChunk<RowKeys> keys)

Description copied from interface: ChunkSink

Fills the ChunkSink with data from the source, with data corresponding to the keys from the given key chunk.

Specified by:

fillFromChunkUnordered in interface ChunkSink<T>

Specified by:

fillFromChunkUnordered in interface WritableColumnSource<T>

Parameters:

context - A context containing all mutable/state related data used in writing the Chunk.

src - The source of the data RowSequence

keys - A LongChunk representing the keys to be written

move

public void move(long source,
 long dest,
 long length)

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

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

getCapacity

public final long getCapacity()

Get the capacity of this column source. This number is one higher than the highest key that may be accessed (read or written).

Returns:

The capacity of this column source

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>

fillFromChunk

public void fillFromChunk(@NotNull
 @NotNull ChunkSink.FillFromContext context,
 @NotNull
 @NotNull Chunk<? extends Values> src,
 @NotNull
 @NotNull RowSequence rowSequence)

Description copied from interface: WritableColumnSource

Our default, inefficient, implementation. Inheritors who care should provide a better implementation.

Specified by:

fillFromChunk in interface ChunkSink<T>

Specified by:

fillFromChunk in interface WritableColumnSource<T>

Parameters:

context - A context containing all mutable/state related data used in writing the Chunk.

src - The source of the data rowSequence

rowSequence - An RowSequence representing the keys to be written