Package io.deephaven.engine.table.impl.dataindex

Class RemappedDataIndex

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessArtifact

io.deephaven.engine.table.impl.dataindex.AbstractDataIndex

io.deephaven.engine.table.impl.dataindex.RemappedDataIndex

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, BasicDataIndex, DataIndex, DataIndexer.RetainableDataIndex, Serializable

public class RemappedDataIndex
extends AbstractDataIndex
implements DataIndexer.RetainableDataIndex

A AbstractDataIndex that remaps the key columns of another AbstractDataIndex. Used to implement DataIndex.remapKeyColumns(Map).

See Also:

• Serialized Form

Nested Class Summary

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

DataIndex.RowKeyLookup

Field Summary

Fields inherited from class io.deephaven.engine.table.impl.dataindex.AbstractDataIndex

ROW_SET_COLUMN_NAME

Method Summary

Modifier and Type	Method	Description
static DataIndex	from(@NotNull AbstractDataIndex sourceIndex, @NotNull Map<ColumnSource<?>,ColumnSource<?>> oldToNewColumnMap)
boolean	isRefreshing()	Whether the index BasicDataIndex.table() is refreshing.
boolean	isValid()	Whether this AbstractDataIndex is potentially usable.
@NotNull List<String>	keyColumnNames()	Get a list of the key column names for the index table.
@NotNull Map<ColumnSource<?>,String>	keyColumnNamesByIndexedColumn()	Get a map from indexed ColumnSources to key column names for the index table.
@NotNull DataIndex.RowKeyLookup	rowKeyLookup(DataIndexOptions options)	Build a lookup function of row keys for this index.
boolean	shouldRetain()
@NotNull Table	table(DataIndexOptions options)	Get the Table backing this data index.
boolean	tableIsCached()	Whether the Table backing this data index is already created and cached.

Methods inherited from class io.deephaven.engine.table.impl.dataindex.AbstractDataIndex

indexTableWrapper, indexTableWrapper, remapKeyColumns, rowSetColumnName, transform

Methods inherited from class io.deephaven.engine.liveness.LivenessArtifact

manageWithCurrentScope

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

destroy, dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

keyColumns, keyColumns, rowSetColumn, rowSetColumn, rowSetColumnName, table

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

remapKeyColumns, rowKeyLookup, rowKeyLookup, transform

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage, unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Method Details

from

public static DataIndex from(@NotNull
 @NotNull AbstractDataIndex sourceIndex,
 @NotNull
 @NotNull Map<ColumnSource<?>,ColumnSource<?>> oldToNewColumnMap)

keyColumnNamesByIndexedColumn

@NotNull
public @NotNull Map<ColumnSource<?>,String> keyColumnNamesByIndexedColumn()

Description copied from interface: BasicDataIndex

Get a map from indexed ColumnSources to key column names for the index table. This map must be ordered in the same order presented by BasicDataIndex.keyColumnNames() and used for lookup keys.

Specified by:

keyColumnNamesByIndexedColumn in interface BasicDataIndex

Returns:

A map designating the key column names for each indexed ColumnSource

keyColumnNames

@NotNull
public @NotNull List<String> keyColumnNames()

Description copied from interface: BasicDataIndex

Get a list of the key column names for the index table.

Specified by:

keyColumnNames in interface BasicDataIndex

Returns:

The key column names

tableIsCached

public boolean tableIsCached()

Description copied from interface: BasicDataIndex

Whether the Table backing this data index is already created and cached.

Specified by:

tableIsCached in interface BasicDataIndex

Returns:

true when the table is cached, false otherwise

table

@NotNull
public @NotNull Table table(DataIndexOptions options)

Description copied from interface: BasicDataIndex

Get the Table backing this data index.

Specified by:

table in interface BasicDataIndex

Parameters:

options - parameters to control the returned table

Returns:

The Table

rowKeyLookup

@NotNull
public @NotNull DataIndex.RowKeyLookup rowKeyLookup(DataIndexOptions options)

Description copied from interface: DataIndex

Build a lookup function of row keys for this index. If BasicDataIndex.isRefreshing() is true, this lookup function is only guaranteed to be accurate for the current cycle. Lookup keys should be in the order of the index's key columns.

Specified by:

rowKeyLookup in interface DataIndex

Parameters:

options - parameters for building the table, if required by this RowKeyLookup

Returns:

A function that provides map-like lookup of index BasicDataIndex.table() row keys from an index lookup key

isRefreshing

public boolean isRefreshing()

Description copied from interface: BasicDataIndex

Whether the index BasicDataIndex.table() is refreshing. Some transformations will force the index to become static even when the source table is refreshing.

Specified by:

isRefreshing in interface BasicDataIndex

Returns:

true if the index BasicDataIndex.table() is refreshing, false otherwise

isValid

public boolean isValid()

Description copied from class: AbstractDataIndex

Whether this AbstractDataIndex is potentially usable. This will return true when there are no known issues for this data index. This performs fast checks, such as verifying all locations have index table files, but does not fully guarantee that the index is complete and loadable.

Specified by:

isValid in class AbstractDataIndex

Returns:

true If the AbstractDataIndex is potentially usable, false otherwise

shouldRetain

public boolean shouldRetain()

Specified by:

shouldRetain in interface DataIndexer.RetainableDataIndex

Returns:

Whether this should be strongly held (if added) to maintain reachability