Package io.deephaven.engine.page

Interface PageStore<ATTR extends Any,INNER_ATTR extends ATTR,PAGE extends Page<INNER_ATTR>>

All Superinterfaces:

ChunkSource<ATTR>, DefaultChunkSource<ATTR>, DefaultChunkSource.SupportsContiguousGet<ATTR>, FillContextMaker, GetContextMaker, PagingChunkSource<ATTR>

All Known Subinterfaces:

RegionedPageStore<ATTR,INNER_ATTR,REGION_TYPE>

All Known Implementing Classes:

AppendOnlyFixedSizePageRegionByte, AppendOnlyFixedSizePageRegionChar, AppendOnlyFixedSizePageRegionDouble, AppendOnlyFixedSizePageRegionFloat, AppendOnlyFixedSizePageRegionInt, AppendOnlyFixedSizePageRegionLong, AppendOnlyFixedSizePageRegionObject, AppendOnlyFixedSizePageRegionShort, ColumnChunkPageStore, ColumnRegionByte.StaticPageStore, ColumnRegionChar.StaticPageStore, ColumnRegionDouble.StaticPageStore, ColumnRegionFloat.StaticPageStore, ColumnRegionInt.StaticPageStore, ColumnRegionLong.StaticPageStore, ColumnRegionObject.StaticPageStore, ColumnRegionShort.StaticPageStore, RegionedPageStore.Static

public interface PageStore<ATTR extends Any,INNER_ATTR extends ATTR,PAGE extends Page<INNER_ATTR>>
extends PagingChunkSource<ATTR>, DefaultChunkSource.SupportsContiguousGet<ATTR>

PageStores are a collection of non-overlapping Pages, providing a single PagingChunkSource across all the pages. PageStores are responsible for mapping row keys to pages. PageStores may themselves be Pages nested within other PageStores.

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

DefaultChunkSource.SupportsContiguousGet<ATTR extends Any>, DefaultChunkSource.WithPrev<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 void	doFillChunkAppend(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super ATTR> destination, @NotNull RowSequence rowSequence, @NotNull Page<INNER_ATTR> page)	This is a helper which is the same as a call to fillChunkAppend(io.deephaven.engine.table.ChunkSource.FillContext, io.deephaven.chunk.WritableChunk<? super ATTR>, io.deephaven.engine.rowset.RowSequence.Iterator), except that some of the initial work has already been done for the first call to PagingChunkSource.fillChunkAppend(FillContext, WritableChunk, RowSequence.Iterator) which we don't want to repeat.
default void	fillChunk(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super ATTR> destination, @NotNull RowSequence rowSequence)	Populates the given destination chunk with data corresponding to the keys from the given RowSequence.
default void	fillChunkAppend(@NotNull ChunkSource.FillContext context, @NotNull WritableChunk<? super ATTR> destination, RowSequence.Iterator rowSequenceIterator)	Similar to ChunkSource.fillChunk(FillContext, WritableChunk, RowSequence), except that the values are appended to destination, rather than placed at the beginning.
default @NotNull Chunk<? extends ATTR>	getChunk(@NotNull ChunkSource.GetContext context, long firstKey, long lastKey)	Same as ChunkSource.getChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence.
default Chunk<? extends ATTR>	getChunk(@NotNull ChunkSource.GetContext context, @NotNull RowSequence rowSequence)	Returns a chunk of data corresponding to the keys from the given RowSequence.
PAGE	getPageContaining(@Nullable ChunkSource.FillContext fillContext, long rowKey)

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

getChunkType

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

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

makeFillContext, mask, maxRow

Method Details

getPageContaining

@NotNull
PAGE getPageContaining(@Nullable
 @Nullable ChunkSource.FillContext fillContext,
 long rowKey)

Parameters:

fillContext - The fill context to use; may be null if the calling code does not have a fill context

rowKey - The row key to get the page for

Returns:

The page containing rowKey, after applying PagingChunkSource.mask().

getChunk

default Chunk<? extends ATTR> 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<ATTR extends Any>

Specified by:

getChunk in interface DefaultChunkSource<ATTR extends Any>

Specified by:

getChunk in interface DefaultChunkSource.SupportsContiguousGet<ATTR extends Any>

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

getChunk

@NotNull
default @NotNull Chunk<? extends ATTR> getChunk(@NotNull
 @NotNull ChunkSource.GetContext context,
 long firstKey,
 long lastKey)

Description copied from interface: ChunkSource

Same as ChunkSource.getChunk(GetContext, RowSequence), except that you pass in the begin and last keys representing the begin and last (inclusive) keys of a single range rather than an RowSequence. Typically you want to call this only if you don't have an RowSequence, such as during an RowSequence.forAllRowKeyRanges(LongRangeConsumer) call. In this case, it allows you to avoid creating an intermediary RowSequence object.

Specified by:

getChunk in interface ChunkSource<ATTR extends Any>

Specified by:

getChunk in interface DefaultChunkSource<ATTR extends Any>

Specified by:

getChunk in interface DefaultChunkSource.SupportsContiguousGet<ATTR extends Any>

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

firstKey - The beginning key (inclusive) of the range to fetch in the chunk

lastKey - The last key (inclusive) of the range to fetch in the chunk

fillChunk

default void fillChunk(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super ATTR> 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<ATTR extends Any>

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

fillChunkAppend

default void fillChunkAppend(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super ATTR> destination,
 @NotNull
 RowSequence.Iterator rowSequenceIterator)

Description copied from interface: PagingChunkSource

Similar to ChunkSource.fillChunk(FillContext, WritableChunk, RowSequence), except that the values are appended to destination, rather than placed at the beginning.

The values to fill into destination are specified by rowSequenceIterator, whose RowSequence.firstRowKey() must exist, and must be represented by this PagingChunkSource (modulo PagingChunkSource.mask()), otherwise results are undefined.

All values specified by rowSequenceIterator that are on the same page as its next row key will be appended to destination. Row keys are on the same page when the bits outside of PagingChunkSource.mask() are identical.

Specified by:

fillChunkAppend in interface PagingChunkSource<ATTR extends Any>

Parameters:

context - A context containing all mutable/state related data used in filling destination

destination - The WritableChunk to append the results to

rowSequenceIterator - An iterator over the remaining row keys specifying the values to retrieve, which contains at least the keys to extract from this PagingChunkSource

doFillChunkAppend

@FinalDefault
default void doFillChunkAppend(@NotNull
 @NotNull ChunkSource.FillContext context,
 @NotNull
 @NotNull WritableChunk<? super ATTR> destination,
 @NotNull
 @NotNull RowSequence rowSequence,
 @NotNull
 @NotNull Page<INNER_ATTR> page)

This is a helper which is the same as a call to fillChunkAppend(io.deephaven.engine.table.ChunkSource.FillContext, io.deephaven.chunk.WritableChunk<? super ATTR>, io.deephaven.engine.rowset.RowSequence.Iterator), except that some of the initial work has already been done for the first call to PagingChunkSource.fillChunkAppend(FillContext, WritableChunk, RowSequence.Iterator) which we don't want to repeat.