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

Class LongSparseArraySource

java.lang.Object

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

io.deephaven.engine.table.impl.sources.SparseArrayColumnSource<Long>

io.deephaven.engine.table.impl.sources.LongSparseArraySource

All Implemented Interfaces:

RowSetShiftCallback, ChunkSink<Values>, ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<Long>, ElementSource<Long>, FillContextMaker, GetContextMaker, ColumnSourceGetDefaults.ForLong, ColumnSourceGetDefaults.LongBacked<Long>, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, MutableColumnSource<Long>, MutableColumnSourceGetDefaults.ForLong, MutableColumnSourceGetDefaults.LongBacked<Long>, ConvertibleTimeSource, FillUnordered<Values>, InMemoryColumnSource, PossiblyImmutableColumnSource, Releasable, TupleExporter<Long>, TupleSource<Long>, WritableColumnSource<Long>, WritableSourceWithPrepareForParallelPopulation

public class LongSparseArraySource
extends SparseArrayColumnSource<Long>
implements MutableColumnSourceGetDefaults.ForLong, ConvertibleTimeSource

Sparse array source for Long.

The C-haracterSparseArraySource is replicated to all other types with io.deephaven.engine.table.impl.sources.Replicate. (C-haracter is deliberately spelled that way in order to prevent Replicate from altering this very comment).

Nested Class Summary

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

SparseArrayColumnSource.FillByContext<UArray>

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.sources.ConvertibleTimeSource

ConvertibleTimeSource.Zoned

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 LongOneOrN.Block0	blocks
protected LongOneOrN.Block0	prevBlocks
protected UpdateCommitter<LongSparseArraySource>	prevFlusher	The presence of a prevFlusher means that this ArraySource wants to track previous values.

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
LongSparseArraySource()

Method Summary

Modifier and Type	Method	Description
<ALTERNATE_DATA_TYPE> boolean	allowsReinterpret(@NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)	Test if a reinterpret call will succeed.
protected <ALTERNATE_DATA_TYPE> ColumnSource<ALTERNATE_DATA_TYPE>	doReinterpret(@NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)	Supply allowed reinterpret results.
void	ensureCapacity(long capacity, boolean nullFill)	Ensure that this WritableColumnSource can accept row keys in range [0, capacity).
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.
<R> void	fillFromChunkUnordered(@NotNull ChunkSink.FillFromContext context, @NotNull Chunk<? extends Values> src, @NotNull LongChunk<RowKeys> keys, ToLongFunction<R> converter)
void	fillPrevChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Values> dest, @NotNull RowSequence rowSequence)	Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
Long	get(long rowKey)	Get the value from the source.
LongChunk<Values>	getChunk(@NotNull ChunkSource.GetContext context, @NotNull RowSequence rowSequence)	Returns a chunk of data corresponding to the keys from the given RowSequence.
final long	getLong(long rowKey)	Get the value at the rowKey as a long.
Long	getPrev(long rowKey)	Get the previous value at the rowKey.
LongChunk<Values>	getPrevChunk(@NotNull ChunkSource.GetContext context, @NotNull RowSequence rowSequence)	Returns a chunk of previous data corresponding to the keys from the given RowSequence.
final long	getPrevLong(long rowKey)	Get the previous value at the rowKey as a long.
void	prepareForParallelPopulation(RowSequence changedRows)	Prepare this column source such that: all values in rowSet may be accessed using getPrev all values in rowSet may be populated in parallel
final void	set(long key, long value)
void	set(long key, Long value)
void	setNull(long key)
void	shift(RowSet keysToShift, long shiftDelta)	Signals that the row keys in rowSet should be shifted by the provided shiftDelta.
void	startTrackingPrevValues()	ColumnSource implementations that track previous values have the option to not actually start tracking previous values until this method is called.
boolean	supportsTimeConversion()	Check if this class supports time conversion.
ColumnSource<Long>	toEpochNano()	Convert this source to a long source of nanoseconds of epoch.
ColumnSource<Instant>	toInstant()	Convert this source to an Instant source.
ColumnSource<LocalDate>	toLocalDate(@NotNull ZoneId zone)	Convert this source to a LocalDate source at the specified zone.
ColumnSource<LocalTime>	toLocalTime(@NotNull ZoneId zone)	Convert this source to a LocalTime source at the specified zone.
ColumnSource<ZonedDateTime>	toZonedDateTime(@NotNull ZoneId zone)	Convert this source to a ZonedDateTime source at the specified zone.

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

fillChunk, fillChunkUnordered, fillFromChunk, fillPrevChunkUnordered, getInstantMemoryColumnSource, getPreferredChunkSize, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, getSparseMemoryColumnSource, isImmutable, makeFillFromContext, providesFillUnordered, remove, set, set, set, set, set, set, setImmutable, setNull

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

defaultFillChunk, defaultFillPrevChunk, 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.ChunkSource

fillChunk

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

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

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

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

getChunk, getChunkByFilling, makeFillContext, makeGetContext

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

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

getPrevBoolean, getPrevByte, getPrevChar, getPrevDouble, getPrevFloat, getPrevInt, 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

Field Details

prevFlusher

protected transient UpdateCommitter<LongSparseArraySource> 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.

blocks

protected LongOneOrN.Block0 blocks

prevBlocks

protected transient LongOneOrN.Block0 prevBlocks

Constructor Details

LongSparseArraySource

public LongSparseArraySource()

Method Details

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

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.

setNull

public void setNull(long key)

Specified by:

setNull in interface WritableColumnSource<Long>

set

public final void set(long key,
 long value)

Specified by:

set in interface WritableColumnSource<Long>

Overrides:

set in class SparseArrayColumnSource<Long>

shift

public void shift(RowSet keysToShift,
 long shiftDelta)

Description copied from interface: RowSetShiftCallback

Signals that the row keys in rowSet should be shifted by the provided shiftDelta.

Specified by:

shift in interface RowSetShiftCallback

Parameters:

keysToShift - The row keys to shift

shiftDelta - The shift delta to apply to each row key in rowSet

set

public void set(long key,
 Long value)

Specified by:

set in interface WritableColumnSource<Long>

get

public Long 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 ColumnSourceGetDefaults.ForLong

Specified by:

get in interface ElementSource<Long>

Parameters:

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

Returns:

the value at the rowKey, potentially null.

getPrev

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

Specified by:

getPrev in interface MutableColumnSourceGetDefaults.ForLong

Parameters:

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

Returns:

the previous value at the rowKey, potentially null.

getLong

public final long getLong(long rowKey)

Description copied from interface: ElementSource

Get the value at the rowKey as a long. RowKeys that are not present are undefined.

Specified by:

getLong in interface ElementSource<Long>

Parameters:

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

Returns:

the long at the rowKey, null values are represented by QueryConstants.NULL_LONG

getPrevLong

public final long getPrevLong(long rowKey)

Description copied from interface: ElementSource

Get the previous value at the rowKey as a long. See ElementSource.getPrev(long) for more details.

Specified by:

getPrevLong in interface ElementSource<Long>

Parameters:

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

Returns:

the previous long at the rowKey, null values are represented by QueryConstants.NULL_LONG

startTrackingPrevValues

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

prepareForParallelPopulation

public void prepareForParallelPopulation(RowSequence changedRows)

Description copied from interface: WritableSourceWithPrepareForParallelPopulation

Prepare this column source such that:

• all values in rowSet may be accessed using getPrev
• all values in rowSet may be populated in parallel

Further operations in this cycle need not check for previous when writing data to the column source; you must provide a row set that contains every row that may be written to this column source.

Specified by:

prepareForParallelPopulation in interface WritableSourceWithPrepareForParallelPopulation

Parameters:

changedRows - the row sequence of values that will change on this cycle

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

Specified by:

fillFromChunkUnordered in interface WritableColumnSource<Long>

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

fillFromChunkUnordered

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

fillPrevChunk

public void fillPrevChunk(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super Values> dest,
 @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<Long>

Parameters:

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

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

getChunk

public LongChunk<Values> getChunk(@NotNull
 @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

getPrevChunk

public LongChunk<Values> getPrevChunk(@NotNull
 @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

allowsReinterpret

public <ALTERNATE_DATA_TYPE> boolean allowsReinterpret(@NotNull
 @NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)

Description copied from interface: ColumnSource

Test if a reinterpret call will succeed.

Specified by:

allowsReinterpret in interface ColumnSource<Long>

Overrides:

allowsReinterpret in class AbstractColumnSource<Long>

Parameters:

alternateDataType - The alternative type to consider

Returns:

If a reinterpret on this column source with the supplied alternateDataType will succeed.

doReinterpret

protected <ALTERNATE_DATA_TYPE>
ColumnSource<ALTERNATE_DATA_TYPE> doReinterpret(@NotNull
 @NotNull Class<ALTERNATE_DATA_TYPE> alternateDataType)

Description copied from class: AbstractColumnSource

Supply allowed reinterpret results. The default implementation handles the most common case to avoid code duplication.

Overrides:

doReinterpret in class AbstractColumnSource<Long>

Parameters:

alternateDataType - The alternate data type

Returns:

The resulting ColumnSource

supportsTimeConversion

public boolean supportsTimeConversion()

Description copied from interface: ConvertibleTimeSource

Check if this class supports time conversion. If false, all other methods will fail.

Specified by:

supportsTimeConversion in interface ConvertibleTimeSource

Returns:

true if time conversion is supported.

toZonedDateTime

public ColumnSource<ZonedDateTime> toZonedDateTime(@NotNull
 @NotNull ZoneId zone)

Description copied from interface: ConvertibleTimeSource

Convert this source to a ZonedDateTime source at the specified zone.

Specified by:

toZonedDateTime in interface ConvertibleTimeSource

Parameters:

zone - the time zone

Returns:

a view of this source as a ZonedDateTime

toLocalDate

public ColumnSource<LocalDate> toLocalDate(@NotNull
 @NotNull ZoneId zone)

Description copied from interface: ConvertibleTimeSource

Convert this source to a LocalDate source at the specified zone.

Specified by:

toLocalDate in interface ConvertibleTimeSource

Parameters:

zone - the time zone

Returns:

a view of this source as a LocalDate

toLocalTime

public ColumnSource<LocalTime> toLocalTime(@NotNull
 @NotNull ZoneId zone)

Description copied from interface: ConvertibleTimeSource

Convert this source to a LocalTime source at the specified zone.

Specified by:

toLocalTime in interface ConvertibleTimeSource

Parameters:

zone - the time zone

Returns:

a view of this source as a LocalTime

toInstant

public ColumnSource<Instant> toInstant()

Description copied from interface: ConvertibleTimeSource

Convert this source to an Instant source.

Specified by:

toInstant in interface ConvertibleTimeSource

Returns:

a view of this source asan Instant

toEpochNano

public ColumnSource<Long> toEpochNano()

Description copied from interface: ConvertibleTimeSource

Convert this source to a long source of nanoseconds of epoch.

Specified by:

toEpochNano in interface ConvertibleTimeSource

Returns:

a view of this source as a ZonedDateTime