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

Class TransformedDataIndex

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

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, BasicDataIndex, Serializable

public class TransformedDataIndex
extends LivenessArtifact
implements BasicDataIndex

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static TransformedDataIndex	from(@NotNull DataIndex index, @NotNull DataIndexTransformer transformer)
boolean	isRefreshing()	Whether the index BasicDataIndex.table() is refreshing.
@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.
protected Table	maybeSortByFirstKey(@NotNull Table indexTable)	Sort the input index table by the first row key of its RowSet column, if specified.
@NotNull String	rowSetColumnName()	Get the RowSet column name for the index table.
@NotNull Table	table(DataIndexOptions unused)	Get the Table backing this data index.

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, table

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 TransformedDataIndex from(@NotNull
 @NotNull DataIndex index,
 @NotNull
 @NotNull DataIndexTransformer transformer)

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

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

rowSetColumnName

@NotNull
public @NotNull String rowSetColumnName()

Description copied from interface: BasicDataIndex

Get the RowSet column name for the index table.

Specified by:

rowSetColumnName in interface BasicDataIndex

Returns:

The RowSet column name

table

@NotNull
public @NotNull Table table(DataIndexOptions unused)

Description copied from interface: BasicDataIndex

Get the Table backing this data index.

Specified by:

table in interface BasicDataIndex

Parameters:

unused - parameters to control the returned table

Returns:

The Table

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

maybeSortByFirstKey

protected Table maybeSortByFirstKey(@NotNull
 @NotNull Table indexTable)

Sort the input index table by the first row key of its RowSet column, if specified.

Parameters:

indexTable - The input index table

Returns:

The table sorted by first row key, if requested, else the input index table