Package com.illumon.iris.db.v2.sources.regioned

Interface BufferedPage<ATTR extends Attributes.Any>

All Superinterfaces:

ChunkSource<ATTR>, DefaultChunkSource<ATTR>, FillContextMaker, GetContextMaker, Page<ATTR>, Page.WithDefaults<ATTR>, PagingChunkSource<ATTR>

All Known Implementing Classes:

BufferedPageByte, BufferedPageChar, BufferedPageDouble, BufferedPageFloat, BufferedPageInt, BufferedPageLong, BufferedPageShort

public interface BufferedPage<ATTR extends Attributes.Any>
extends Page.WithDefaults<ATTR>

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.chunk.ChunkSource

ChunkSource.FillContext, ChunkSource.GetContext, ChunkSource.WithPrev<ATTR extends Attributes.Any>

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.chunk.DefaultChunkSource

DefaultChunkSource.SupportsContiguousGet<ATTR extends Attributes.Any>, DefaultChunkSource.WithPrev<ATTR extends Attributes.Any>

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.sources.chunk.page.Page

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	USE_RANGES_AVERAGE_RUN_LENGTH	Minimum average run length in an OrderedKeys that should trigger copy-by-ranges in BufferedPage implementations.

Fields inherited from interface com.illumon.iris.db.v2.sources.chunk.ChunkSource

DEFAULT_FILL_INSTANCE, ZERO_LENGTH_CHUNK_SOURCE_ARRAY

Method Summary

Modifier and Type	Method	Description
com.illumon.iris.db.v2.sources.regioned.BufferedType	bufferedType()	The BufferedType associated with a buffer page has all the helper functions for calculating offsets, lengths, etc.
default long	firstRowOffset()
default long	length()
default long	mask()	This mask is applied to OrderedKeys which are passed into ChunkSource.getChunk(ChunkSource.GetContext, OrderedKeys) and ChunkSource.fillChunk(ChunkSource.FillContext, WritableChunk, OrderedKeys).

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.ChunkSource

getChunkType, getNativeType

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.DefaultChunkSource

getChunk, getChunk, getChunkByFilling, makeFillContext, makeGetContext

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.FillContextMaker

makeFillContext

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.GetContextMaker

makeGetContext

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.page.Page

advanceToNextPage, advanceToNextPage, advanceToNextPageAndGetPositionDistance, firstRow, getRowOffset, lastRow

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.page.Page.WithDefaults

fillChunk, fillChunkAppend, fillChunkAppend

Methods inherited from interface com.illumon.iris.db.v2.sources.chunk.page.PagingChunkSource

maxRow

Field Details

USE_RANGES_AVERAGE_RUN_LENGTH

static final int USE_RANGES_AVERAGE_RUN_LENGTH

Minimum average run length in an OrderedKeys that should trigger copy-by-ranges in BufferedPage implementations.

See Also:

• Constant Field Values

Method Details

bufferedType

com.illumon.iris.db.v2.sources.regioned.BufferedType bufferedType()

The BufferedType associated with a buffer page has all the helper functions for calculating offsets, lengths, etc. based on the type stored on this BufferedPage.

Returns:

The type of the buffered page.

length

@FinalDefault
default long length()

Specified by:

length in interface Page<ATTR extends Attributes.Any>

Returns:

the length of this page.

mask

@FinalDefault
default long mask()

Description copied from interface: PagingChunkSource

This mask is applied to OrderedKeys which are passed into ChunkSource.getChunk(ChunkSource.GetContext, OrderedKeys) and ChunkSource.fillChunk(ChunkSource.FillContext, WritableChunk, OrderedKeys). This allows the PagingChunkSources to be cached, and reused even if they are properly relocated in key space.

Specified by:

mask in interface PagingChunkSource<ATTR extends Attributes.Any>

Returns:

the mask for this page, which must be a bitmask representing the some number of lower order bits of a long.

firstRowOffset

@FinalDefault
default long firstRowOffset()

Specified by:

firstRowOffset in interface Page<ATTR extends Attributes.Any>

Returns:

the first row of this page, after applying the PagingChunkSource.mask(), which refers to the first row of this page.