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

Interface ColumnRegionObject.SelfDictionaryRegion<DATA_TYPE,ATTR extends Any>

All Superinterfaces:

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

All Known Implementing Classes:

ColumnRegionObject.Constant, ColumnRegionObject.Null

Enclosing interface:

ColumnRegionObject<DATA_TYPE,ATTR extends Any>

public static interface ColumnRegionObject.SelfDictionaryRegion<DATA_TYPE,ATTR extends Any>
extends ColumnRegionObject<DATA_TYPE,ATTR>

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.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
default ColumnRegionObject<DATA_TYPE,ATTR>	getDictionaryValuesRegion()
default 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 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

gatherDictionaryValuesRowSet, getChunkType, getDictionaryKeysRegion, getObject, getObject

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

supportsDictionaryFormat

@FinalDefault
default 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

getDictionaryValuesRegion

@FinalDefault
default 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)