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

Class DeferredColumnRegionObject<DATA_TYPE,ATTR extends Any>

java.lang.Object

io.deephaven.engine.table.impl.sources.regioned.GenericColumnRegionBase<ATTR>

io.deephaven.engine.table.impl.sources.regioned.DeferredColumnRegionBase<ATTR,ColumnRegionObject<DATA_TYPE,ATTR>>

io.deephaven.engine.table.impl.sources.regioned.DeferredColumnRegionObject<DATA_TYPE,ATTR>

All Implemented Interfaces:

Page<ATTR>, PagingChunkSource<ATTR>, ChunkSource<ATTR>, FillContextMaker, GetContextMaker, DefaultChunkSource<ATTR>, ColumnRegion<ATTR>, ColumnRegionObject<DATA_TYPE,ATTR>, Releasable

public class DeferredColumnRegionObject<DATA_TYPE,ATTR extends Any>
extends DeferredColumnRegionBase<ATTR,ColumnRegionObject<DATA_TYPE,ATTR>>
implements ColumnRegionObject<DATA_TYPE,ATTR>

ColumnRegionShort implementation for deferred regions, i.e. regions that will be properly constructed on first access.

Nested Class Summary

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

ChunkSource.FillContext, ChunkSource.GetContext

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.sources.regioned.ColumnRegion

ColumnRegion.Null<ATTR extends Any>

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.sources.regioned.ColumnRegionObject

ColumnRegionObject.Constant<DATA_TYPE,ATTR extends Any>, ColumnRegionObject.DictionaryKeysWrapper, ColumnRegionObject.Null<DATA_TYPE,ATTR extends Any>, ColumnRegionObject.SelfDictionaryRegion<DATA_TYPE,ATTR extends Any>, ColumnRegionObject.StaticPageStore<DATA_TYPE,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.page.Page

Page.WithDefaults<ATTR extends Any>, Page.WithDefaultsForRepeatingValues<ATTR extends Any>

Field Summary

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

DEFAULT_FILL_INSTANCE, ZERO_LENGTH_CHUNK_SOURCE_ARRAY

Method Summary

Modifier and Type	Method	Description
boolean	gatherDictionaryValuesRowSet(RowSet.SearchIterator keysToVisit, RowSequence.Iterator knownKeys, @NotNull RowSetBuilderSequential sequentialBuilder)	Optional method that should only be used on regions returned by ColumnRegionObject.getDictionaryValuesRegion().
ColumnRegionLong<DictionaryKeys>	getDictionaryKeysRegion()
ColumnRegionObject<DATA_TYPE,ATTR>	getDictionaryValuesRegion()
DATA_TYPE	getObject(long elementIndex)	Get a single object from this region.
DATA_TYPE	getObject(@NotNull ChunkSource.FillContext context, long elementIndex)	Get a single object from this region.
RegionVisitResult	supportsDictionaryFormat(RowSet.SearchIterator keysToVisit)	Check if this region can expose an alternate form as paired regions of long keys and DATA_TYPE values covering all of its row keys in keysToVisit.

Methods inherited from class io.deephaven.engine.table.impl.sources.regioned.DeferredColumnRegionBase

fillChunk, fillChunkAppend, getChunk, getChunk, getChunkType, getResultRegion, invalidate, releaseCachedResources

Methods inherited from class io.deephaven.engine.table.impl.sources.regioned.GenericColumnRegionBase

mask, throwIfInvalidated

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.impl.sources.regioned.ColumnRegion

firstRowOffset, invalidate

Methods inherited from interface io.deephaven.engine.table.impl.sources.regioned.ColumnRegionObject

getChunkType

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

getChunk, getChunk, getChunkByFilling, makeGetContext

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.page.Page

advanceToNextPage, advanceToNextPage, advanceToNextPageAndGetPositionDistance, firstRow, getRowOffset

Methods inherited from interface io.deephaven.engine.page.PagingChunkSource

fillChunkAppend, makeFillContext, mask, maxRow

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

releaseCachedResources

Method Details

getObject

public DATA_TYPE getObject(long elementIndex)

Description copied from interface: ColumnRegionObject

Get a single object from this region.

Specified by:

getObject in interface ColumnRegionObject<DATA_TYPE,ATTR extends Any>

Parameters:

elementIndex - Element row key in the table's address space

Returns:

The object value at the specified element row key

getObject

public DATA_TYPE getObject(@NotNull
 @NotNull ChunkSource.FillContext context,
 long elementIndex)

Description copied from interface: ColumnRegionObject

Get a single object from this region.

Specified by:

getObject in interface ColumnRegionObject<DATA_TYPE,ATTR extends Any>

Parameters:

context - A PagingContextHolder to enable resource caching where suitable, with current region index pointing to this region

elementIndex - Element row key in the table's address space

Returns:

The object value at the specified element row key

supportsDictionaryFormat

public RegionVisitResult supportsDictionaryFormat(@NotNull
 RowSet.SearchIterator keysToVisit)

Description copied from interface: ColumnRegionObject

Check if this region can expose an alternate form as paired regions of long keys and DATA_TYPE values covering all of its row keys in keysToVisit.

Both alternate regions must use the same or smaller row key space as this one. Indices fetched from the keys region must represent valid element indices in the values region. Values regions must support ColumnRegionObject.gatherDictionaryValuesRowSet(RowSet.SearchIterator, RowSequence.Iterator, RowSetBuilderSequential).

Use ColumnRegionObject.getDictionaryKeysRegion() to access the region of keys and ColumnRegionObject.getDictionaryValuesRegion() to access the region of values.

Specified by:

supportsDictionaryFormat in interface ColumnRegionObject<DATA_TYPE,ATTR extends Any>

Parameters:

keysToVisit - Iterator positioned at the first relevant row key belonging to this region. Will be advanced to after this region if true is returned. No guarantee is made if false is returned.

Returns:

A RegionVisitResult specifying FAILED if this region cannot supply a dictionary, CONTINUE if it can and keysToVisit is not exhausted, and COMPLETE if it can and keysToVisit is exhausted

gatherDictionaryValuesRowSet

public boolean gatherDictionaryValuesRowSet(@NotNull
 RowSet.SearchIterator keysToVisit,
 @NotNull
 RowSequence.Iterator knownKeys,
 @NotNull
 @NotNull RowSetBuilderSequential sequentialBuilder)

Description copied from interface: ColumnRegionObject

Optional method that should only be used on regions returned by ColumnRegionObject.getDictionaryValuesRegion(). Gathers row keys representing the dictionary values for this region, excluding those already known to the caller. This is used to support symbol table access.

Specified by:

gatherDictionaryValuesRowSet in interface ColumnRegionObject<DATA_TYPE,ATTR extends Any>

Parameters:

keysToVisit - A search iterator over the enclosing table address space (which must have the same regions at the same masks), positioned at a row key in this region. Used to identify regions to visit. Should be advanced to after this region as a side-effect.

knownKeys - An iterator over the previously-known row keys, positioned at the first known key in this region, or after the region's maximum key if no keys are known. Should be advanced to after this region as a side effect.

sequentialBuilder - Output builder; implementations should append ranges for row keys not found in knownKeys

Returns:

Whether keysToVisit has been exhausted

getDictionaryKeysRegion

public ColumnRegionLong<DictionaryKeys> getDictionaryKeysRegion()

Specified by:

getDictionaryKeysRegion in interface ColumnRegionObject<DATA_TYPE,ATTR extends Any>

Returns:

A dictionary keys region as specified by ColumnRegionObject.supportsDictionaryFormat(RowSet.SearchIterator)

getDictionaryValuesRegion

public ColumnRegionObject<DATA_TYPE,ATTR> getDictionaryValuesRegion()

Specified by:

getDictionaryValuesRegion in interface ColumnRegionObject<DATA_TYPE,ATTR extends Any>

Returns:

A dictionary values region as specified by ColumnRegionObject.supportsDictionaryFormat(RowSet.SearchIterator)