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

Class NanosBasedTimeSparseArraySource<TIME_TYPE>

java.lang.Object

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

io.deephaven.engine.table.impl.sources.NanosBasedTimeSparseArraySource<TIME_TYPE>

All Implemented Interfaces:

RowSetShiftCallback, ChunkSink<Values>, ChunkSource<Values>, ChunkSource.WithPrev<Values>, ColumnSource<TIME_TYPE>, ElementSource<TIME_TYPE>, FillContextMaker, GetContextMaker, DefaultChunkSource<Values>, DefaultChunkSource.WithPrev<Values>, ConvertibleTimeSource, FillUnordered<Values>, InMemoryColumnSource, PossiblyImmutableColumnSource, Releasable, TupleExporter<TIME_TYPE>, TupleSource<TIME_TYPE>, WritableColumnSource<TIME_TYPE>, WritableSourceWithPrepareForParallelPopulation

Direct Known Subclasses:

InstantSparseArraySource, ZonedDateTimeSparseArraySource

public abstract class NanosBasedTimeSparseArraySource<TIME_TYPE>
extends AbstractColumnSource<TIME_TYPE>
implements FillUnordered<Values>, WritableColumnSource<TIME_TYPE>, InMemoryColumnSource, PossiblyImmutableColumnSource, WritableSourceWithPrepareForParallelPopulation, RowSetShiftCallback, ConvertibleTimeSource

Array-backed ColumnSource for TIME_TYPEs. Allows reinterpret as long.

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.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 final LongSparseArraySource	nanoSource

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
NanosBasedTimeSparseArraySource(@NotNull Class<TIME_TYPE> type)
NanosBasedTimeSparseArraySource(@NotNull Class<TIME_TYPE> type, @NotNull LongSparseArraySource nanoSource)

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 nullFilled)	Ensure that this WritableColumnSource can accept row keys in range [0, capacity).
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	fillChunkUnordered(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Values> dest, @NotNull LongChunk<? extends RowKeys> keys)	Populates a contiguous portion of the given destination chunk with data corresponding to the keys from the given LongChunk.
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	fillPrevChunkUnordered(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super Values> dest, @NotNull LongChunk<? extends RowKeys> keys)	Populates a contiguous portion of the given destination chunk with prev data corresponding to the keys from the given LongChunk.
TIME_TYPE	get(long rowKey)	Get the value from the source.
long	getLong(long rowKey)	Get the value at the rowKey as a long.
TIME_TYPE	getPrev(long rowKey)	Get the previous value at the rowKey.
long	getPrevLong(long rowKey)	Get the previous value at the rowKey as a long.
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).
protected abstract TIME_TYPE	makeValue(long nanos)
void	prepareForParallelPopulation(RowSequence rowSequence)	Prepare this column source such that: all values in rowSet may be accessed using getPrev all values in rowSet may be populated in parallel
boolean	providesFillUnordered()	Returns true if this column source can efficiently provide an unordered fill.
void	set(long key, long value)
void	set(long key, TIME_TYPE value)
void	setImmutable()	Set this column source as having an immutable result.
void	setNull(long key)
void	setNull(RowSequence rowSequence)
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.
protected abstract long	toNanos(TIME_TYPE value)
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.AbstractColumnSource

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

fillPrevChunk

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

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

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

getChunk, 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.ElementSource

getBoolean, getByte, getChar, getDouble, getFloat, getInt, getPrevBoolean, getPrevByte, getPrevChar, getPrevDouble, getPrevFloat, getPrevInt, getPrevShort, getShort

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.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, set, set, set, set, set, set

Field Details

nanoSource

protected final LongSparseArraySource nanoSource

Constructor Details

NanosBasedTimeSparseArraySource

public NanosBasedTimeSparseArraySource(@NotNull
 @NotNull Class<TIME_TYPE> type)

NanosBasedTimeSparseArraySource

public NanosBasedTimeSparseArraySource(@NotNull
 @NotNull Class<TIME_TYPE> type,
 @NotNull
 @NotNull LongSparseArraySource nanoSource)

Method Details

ensureCapacity

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

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.

prepareForParallelPopulation

public void prepareForParallelPopulation(RowSequence rowSequence)

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:

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

makeValue

protected abstract TIME_TYPE makeValue(long nanos)

toNanos

protected abstract long toNanos(TIME_TYPE value)

set

public void set(long key,
 TIME_TYPE value)

Specified by:

set in interface WritableColumnSource<TIME_TYPE>

set

public void set(long key,
 long value)

Specified by:

set in interface WritableColumnSource<TIME_TYPE>

setNull

public void setNull(long key)

Specified by:

setNull in interface WritableColumnSource<TIME_TYPE>

get

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

Parameters:

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

Returns:

the value at the rowKey, potentially null.

getPrev

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

Parameters:

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

Returns:

the previous value at the rowKey, potentially null.

getLong

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

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

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

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

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

setImmutable

public void setImmutable()

Description copied from interface: PossiblyImmutableColumnSource

Set this column source as having an immutable result.

Specified by:

setImmutable in interface PossiblyImmutableColumnSource

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

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

Overrides:

fillChunk in class AbstractColumnSource<TIME_TYPE>

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

providesFillUnordered

public boolean providesFillUnordered()

Description copied from interface: FillUnordered

Returns true if this column source can efficiently provide an unordered fill. If this method returns false, then fillChunkUnordered and fillPrevChunkUnordered may throw an UnsupportedOperationException.

Specified by:

providesFillUnordered in interface FillUnordered<TIME_TYPE>

Returns:

if this column source can provide an unordered fill

fillChunkUnordered

public void fillChunkUnordered(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super Values> dest,
 @NotNull
 @NotNull LongChunk<? extends RowKeys> keys)

Description copied from interface: FillUnordered

Populates a contiguous portion of the given destination chunk with data corresponding to the keys from the given LongChunk.

It behaves as if the following code were executed:

 destination.setSize(keys.size());
 for (int ii = 0; ii < keys.size(); ++ii) {
     destination.set(ii, get(keys.get(ii)));
 }
 

Specified by:

fillChunkUnordered in interface FillUnordered<TIME_TYPE>

Parameters:

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

dest - The chunk to be populated according to keys

keys - A chunk of individual, not assumed to be ordered keys to be fetched

fillPrevChunkUnordered

public void fillPrevChunkUnordered(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super Values> dest,
 @NotNull
 @NotNull LongChunk<? extends RowKeys> keys)

Description copied from interface: FillUnordered

Populates a contiguous portion of the given destination chunk with prev data corresponding to the keys from the given LongChunk.

It behaves as if the following code were executed:

 destination.setSize(keys.size());
 for (int ii = 0; ii < keys.size(); ++ii) {
     destination.set(ii, getPrev(keys.get(ii)));
 }
 

Specified by:

fillPrevChunkUnordered in interface FillUnordered<TIME_TYPE>

Parameters:

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

dest - The chunk to be populated according to keys

keys - A chunk of individual, not assumed to be ordered keys to be fetched

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

Specified by:

makeFillFromContext in interface WritableColumnSource<TIME_TYPE>

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

Specified by:

fillFromChunk in interface WritableColumnSource<TIME_TYPE>

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

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

Specified by:

fillFromChunkUnordered in interface WritableColumnSource<TIME_TYPE>

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

setNull

public void setNull(RowSequence rowSequence)

Specified by:

setNull in interface WritableColumnSource<TIME_TYPE>

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

Overrides:

allowsReinterpret in class AbstractColumnSource<TIME_TYPE>

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

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