Package io.deephaven.engine.table.impl.util

Interface RowRedirection

All Superinterfaces:

ChunkSource<RowKeys>, ChunkSource.WithPrev<RowKeys>, DefaultChunkSource<RowKeys>, DefaultChunkSource.WithPrev<RowKeys>, FillContextMaker, FillUnordered<RowKeys>, GetContextMaker

All Known Subinterfaces:

WritableRowRedirection

All Known Implementing Classes:

ContiguousWritableRowRedirection, GroupedWritableRowRedirection, IntColumnSourceRowRedirection, IntColumnSourceWritableRowRedirection, InverseWrappedRowSetRowRedirection, LongColumnSourceRowRedirection, LongColumnSourceWritableRowRedirection, SingleValueRowRedirection, WrappedRowSetRowRedirection, WritableRowRedirectionLockFree, WritableSingleValueRowRedirection

public interface RowRedirection
extends DefaultChunkSource.WithPrev<RowKeys>, FillUnordered<RowKeys>

Data structure for mapping one "outer" row key space to another "inner" row key space. Query engine components use this when a RowSet must be flattened or re-ordered.

Nested Class Summary

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

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

ZERO_LENGTH_CHUNK_SOURCE_WITH_PREV_ARRAY

Method Summary

Modifier and Type	Method	Description
default boolean	ascendingMapping()	If this RowRedirection is guaranteed to map outer keys in ascending order to inner keys in ascending order; then return true; all other redirections must return false.
default void	fillChunk(@NotNull ChunkSource.FillContext fillContext, @NotNull WritableChunk<? super RowKeys> innerRowKeys, @NotNull RowSequence outerRowKeys)	Lookup each element in a RowSequence and write the result to a WritableLongChunk.
default void	fillChunkUnordered(@NotNull ChunkSource.FillContext fillContext, @NotNull WritableChunk<? super RowKeys> innerRowKeys, @NotNull LongChunk<? extends RowKeys> outerRowKeys)	Lookup each element in a LongChunk and write the result to a WritableLongChunk.
default void	fillPrevChunk(@NotNull ChunkSource.FillContext fillContext, @NotNull WritableChunk<? super RowKeys> innerRowKeys, @NotNull RowSequence outerRowKeys)	Lookup each element in a RowSequence using previous values and write the result to a WritableLongChunk.
default void	fillPrevChunkUnordered(@NotNull ChunkSource.FillContext fillContext, @NotNull WritableChunk<? super RowKeys> innerRowKeys, @NotNull LongChunk<? extends RowKeys> outerRowKeys)	Lookup each element in a LongChunk using previous values and write the result to a WritableLongChunk.
long	get(long outerRowKey)	Simple redirected lookup.
default ChunkType	getChunkType()	Get the most suitable ChunkType for use with this ChunkSource.
long	getPrev(long outerRowKey)	Simple redirected lookup, using previous values.
default boolean	isWritable()
default boolean	providesFillUnordered()	Returns true if this column source can efficiently provide an unordered fill.
default WritableRowRedirection	writableCast()	Cast this RowRedirection reference to a WritableRowRedirection.

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

getChunk, getChunk, getChunkByFilling, makeFillContext, makeGetContext

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

getPrevChunk, getPrevChunk, getPrevChunkByFilling, getPrevSource

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

makeFillContext

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

makeGetContext

Method Details

get

long get(long outerRowKey)

Simple redirected lookup.

Parameters:

outerRowKey - The "outer" row key

Returns:

The corresponding "inner" row key, or RowSequence.NULL_ROW_KEY if no mapping exists

getPrev

long getPrev(long outerRowKey)

Simple redirected lookup, using previous values.

Parameters:

outerRowKey - The "outer" row key

Returns:

The corresponding "inner" row key, or RowSequence.NULL_ROW_KEY if no mapping exists

getChunkType

default ChunkType getChunkType()

Description copied from interface: ChunkSource

Get the most suitable ChunkType for use with this ChunkSource.

Specified by:

getChunkType in interface ChunkSource<RowKeys>

Returns:

The ChunkType

providesFillUnordered

default 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<RowKeys>

Returns:

if this column source can provide an unordered fill

fillChunk

default void fillChunk(@NotNull
 @NotNull ChunkSource.FillContext fillContext,
 @NotNull
 @NotNull WritableChunk<? super RowKeys> innerRowKeys,
 @NotNull
 @NotNull RowSequence outerRowKeys)

Lookup each element in a RowSequence and write the result to a WritableLongChunk.

Specified by:

fillChunk in interface ChunkSource<RowKeys>

Parameters:

fillContext - The fill context

innerRowKeys - The result WritableLongChunk

outerRowKeys - The row keys to lookup in this RowRedirection

fillChunkUnordered

default void fillChunkUnordered(@NotNull
 @NotNull ChunkSource.FillContext fillContext,
 @NotNull
 @NotNull WritableChunk<? super RowKeys> innerRowKeys,
 @NotNull
 @NotNull LongChunk<? extends RowKeys> outerRowKeys)

Lookup each element in a LongChunk and write the result to a WritableLongChunk.

Specified by:

fillChunkUnordered in interface FillUnordered<RowKeys>

Parameters:

fillContext - The FillContext

innerRowKeys - The result chunk

outerRowKeys - The row keys to lookup in this RowRedirection

fillPrevChunk

default void fillPrevChunk(@NotNull
 @NotNull ChunkSource.FillContext fillContext,
 @NotNull
 @NotNull WritableChunk<? super RowKeys> innerRowKeys,
 @NotNull
 @NotNull RowSequence outerRowKeys)

Lookup each element in a RowSequence using previous values and write the result to a WritableLongChunk.

Specified by:

fillPrevChunk in interface ChunkSource.WithPrev<RowKeys>

Parameters:

fillContext - The fill context

innerRowKeys - The result WritableLongChunk

outerRowKeys - The row keys to lookup in this RowRedirection

fillPrevChunkUnordered

default void fillPrevChunkUnordered(@NotNull
 @NotNull ChunkSource.FillContext fillContext,
 @NotNull
 @NotNull WritableChunk<? super RowKeys> innerRowKeys,
 @NotNull
 @NotNull LongChunk<? extends RowKeys> outerRowKeys)

Lookup each element in a LongChunk using previous values and write the result to a WritableLongChunk.

Specified by:

fillPrevChunkUnordered in interface FillUnordered<RowKeys>

Parameters:

fillContext - The FillContext

innerRowKeys - The result chunk

outerRowKeys - The row keys to lookup in this RowRedirection

ascendingMapping

default boolean ascendingMapping()

If this RowRedirection is guaranteed to map outer keys in ascending order to inner keys in ascending order; then return true; all other redirections must return false.

Returns:

if our output maintains ascending order

isWritable

default boolean isWritable()

Returns:

Whether this RowRedirection is actually writable

writableCast

default WritableRowRedirection writableCast()

Cast this RowRedirection reference to a WritableRowRedirection.

Returns:

this cast to a WritableRowRedirection

Throws:

ClassCastException - If this is not a WritableRowRedirection