io.deephaven.engine.table.impl.UncoalescedTable Maven / Gradle / Ivy
Show all versions of deephaven-engine-table Show documentation
/**
* Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
*/
package io.deephaven.engine.table.impl;
import io.deephaven.api.AsOfJoinMatch;
import io.deephaven.api.ColumnName;
import io.deephaven.api.JoinAddition;
import io.deephaven.api.JoinMatch;
import io.deephaven.api.RangeJoinMatch;
import io.deephaven.api.Selectable;
import io.deephaven.api.SortColumn;
import io.deephaven.api.agg.Aggregation;
import io.deephaven.api.Pair;
import io.deephaven.api.agg.spec.AggSpec;
import io.deephaven.api.filter.Filter;
import io.deephaven.api.snapshot.SnapshotWhenOptions;
import io.deephaven.api.updateby.UpdateByOperation;
import io.deephaven.api.updateby.UpdateByControl;
import io.deephaven.base.verify.Assert;
import io.deephaven.engine.context.ExecutionContext;
import io.deephaven.engine.liveness.Liveness;
import io.deephaven.engine.primitive.iterator.*;
import io.deephaven.engine.rowset.TrackingRowSet;
import io.deephaven.engine.table.*;
import io.deephaven.engine.table.hierarchical.RollupTable;
import io.deephaven.engine.table.hierarchical.TreeTable;
import io.deephaven.engine.table.impl.updateby.UpdateBy;
import io.deephaven.api.util.ConcurrentMethod;
import io.deephaven.util.QueryConstants;
import io.deephaven.util.SafeCloseable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
import java.util.Map;
import java.util.function.Function;
/**
* Abstract class for uncoalesced tables. These tables have deferred work that must be done before data can be operated
* on.
*/
public abstract class UncoalescedTable> extends BaseTable {
private final Object coalescingLock = new Object();
private volatile Table coalesced;
public UncoalescedTable(@NotNull final TableDefinition definition, @NotNull final String description) {
super(definition, description, null);
}
// region coalesce support
/**
* Produce the actual coalesced result table, suitable for caching.
*
* Note that if this table must have listeners registered, etc, setting these up is the implementation's
* responsibility.
*
* Also note that the implementation should copy attributes, as in
* {@code copyAttributes(resultTable, CopyAttributeOperation.Coalesce)}.
*
* @return The coalesced result table, suitable for caching
*/
protected abstract Table doCoalesce();
public final Table coalesce() {
try (final SafeCloseable ignored = ExecutionContext.getContext().withUpdateGraph(updateGraph).open()) {
Table localCoalesced;
if (Liveness.verifyCachedObjectForReuse(localCoalesced = coalesced)) {
return localCoalesced;
}
synchronized (coalescingLock) {
if (Liveness.verifyCachedObjectForReuse(localCoalesced = coalesced)) {
return localCoalesced;
}
return coalesced = doCoalesce();
}
}
}
/**
* Proactively set the coalesced result table. See {@link #doCoalesce()} for the caller's responsibilities. Note
* that it is an error to call this more than once with a non-null input.
*
* @param coalesced The coalesced result table, suitable for caching
*/
protected final void setCoalesced(final Table coalesced) {
synchronized (coalescingLock) {
Assert.eqNull(this.coalesced, "this.coalesced");
this.coalesced = coalesced;
}
}
protected @Nullable final Table getCoalesced() {
return coalesced;
}
// endregion coalesce support
// region uncoalesced listeners
@SuppressWarnings("unused")
protected final void addUpdateListenerUncoalesced(@NotNull final TableUpdateListener listener) {
super.addUpdateListener(listener);
}
protected final boolean addUpdateListenerUncoalesced(
@NotNull final TableUpdateListener listener, final long requiredLastNotificationStep) {
return super.addUpdateListener(listener, requiredLastNotificationStep);
}
protected final void removeUpdateListenerUncoalesced(@NotNull final TableUpdateListener listener) {
super.removeUpdateListener(listener);
}
// endregion uncoalesced listeners
// region non-delegated overrides
@Override
public long sizeForInstrumentation() {
return QueryConstants.NULL_LONG;
}
@Override
public boolean isFlat() {
return false;
}
// endregion non-delegated methods
// region delegated methods
@Override
public long size() {
return coalesce().size();
}
@Override
public TrackingRowSet getRowSet() {
return coalesce().getRowSet();
}
@Override
public ColumnSource getColumnSource(String sourceName) {
return coalesce().getColumnSource(sourceName);
}
@Override
public Map> getColumnSourceMap() {
return coalesce().getColumnSourceMap();
}
@Override
public Collection> getColumnSources() {
return coalesce().getColumnSources();
}
@Override
public CloseableIterator columnIterator(@NotNull String columnName) {
return coalesce().columnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfChar characterColumnIterator(@NotNull String columnName) {
return coalesce().characterColumnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfByte byteColumnIterator(@NotNull String columnName) {
return coalesce().byteColumnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfShort shortColumnIterator(@NotNull String columnName) {
return coalesce().shortColumnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfInt integerColumnIterator(@NotNull String columnName) {
return coalesce().integerColumnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfLong longColumnIterator(@NotNull String columnName) {
return coalesce().longColumnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfFloat floatColumnIterator(@NotNull String columnName) {
return coalesce().floatColumnIterator(columnName);
}
@Override
public CloseablePrimitiveIteratorOfDouble doubleColumnIterator(@NotNull String columnName) {
return coalesce().doubleColumnIterator(columnName);
}
@Override
public CloseableIterator objectColumnIterator(@NotNull String columnName) {
return coalesce().objectColumnIterator(columnName);
}
@Override
@ConcurrentMethod
public Table where(Filter filter) {
return coalesce().where(filter);
}
@Override
@ConcurrentMethod
public Table wouldMatch(WouldMatchPair... matchers) {
return coalesce().wouldMatch(matchers);
}
@Override
public Table whereIn(Table rightTable, Collection columnsToMatch) {
return coalesce().whereIn(rightTable, columnsToMatch);
}
@Override
public Table whereNotIn(Table rightTable, Collection columnsToMatch) {
return coalesce().whereNotIn(rightTable, columnsToMatch);
}
@Override
public Table select(Collection columns) {
return coalesce().select(columns);
}
@Override
@ConcurrentMethod
public Table selectDistinct(Collection columns) {
return coalesce().selectDistinct(columns);
}
@Override
public Table update(Collection columns) {
return coalesce().update(columns);
}
@Override
public Table lazyUpdate(Collection newColumns) {
return coalesce().lazyUpdate(newColumns);
}
@Override
@ConcurrentMethod
public Table view(Collection columns) {
return coalesce().view(columns);
}
@Override
@ConcurrentMethod
public Table updateView(Collection columns) {
return coalesce().updateView(columns);
}
@Override
@ConcurrentMethod
public Table dropColumns(String... columnNames) {
return coalesce().dropColumns(columnNames);
}
@Override
public Table renameColumns(Collection pairs) {
return coalesce().renameColumns(pairs);
}
@Override
@ConcurrentMethod
public Table moveColumns(int index, String... columnsToMove) {
return coalesce().moveColumns(index, columnsToMove);
}
@Override
@ConcurrentMethod
public Table head(long size) {
return coalesce().head(size);
}
@Override
@ConcurrentMethod
public Table tail(long size) {
return coalesce().tail(size);
}
@Override
@ConcurrentMethod
public Table slice(long firstPositionInclusive, long lastPositionExclusive) {
return coalesce().slice(firstPositionInclusive, lastPositionExclusive);
}
@Override
@ConcurrentMethod
public Table slicePct(double startPercentInclusive, double endPercentExclusive) {
return coalesce().slicePct(startPercentInclusive, endPercentExclusive);
}
@Override
@ConcurrentMethod
public Table headPct(double percent) {
return coalesce().headPct(percent);
}
@Override
@ConcurrentMethod
public Table tailPct(double percent) {
return coalesce().tailPct(percent);
}
@Override
public Table exactJoin(
Table rightTable,
Collection columnsToMatch,
Collection columnsToAdd) {
return coalesce().exactJoin(rightTable, columnsToMatch, columnsToAdd);
}
@Override
public Table asOfJoin(Table rightTable, Collection exactMatches, AsOfJoinMatch asOfMatch,
Collection columnsToAdd) {
return coalesce().asOfJoin(rightTable, exactMatches, asOfMatch, columnsToAdd);
}
@Override
public Table naturalJoin(
Table rightTable,
Collection columnsToMatch,
Collection columnsToAdd) {
return coalesce().naturalJoin(rightTable, columnsToMatch, columnsToAdd);
}
@Override
public Table join(
Table rightTable,
Collection columnsToMatch,
Collection columnsToAdd,
int reserveBits) {
return coalesce().join(rightTable, columnsToMatch, columnsToAdd, reserveBits);
}
@Override
public Table rangeJoin(@NotNull Table rightTable, @NotNull Collection exactMatches,
@NotNull RangeJoinMatch rangeMatch, @NotNull Collection aggregations) {
return coalesce().rangeJoin(rightTable, exactMatches, rangeMatch, aggregations);
}
@Override
@ConcurrentMethod
public Table aggAllBy(AggSpec spec, ColumnName... groupByColumns) {
return coalesce().aggAllBy(spec, groupByColumns);
}
@Override
@ConcurrentMethod
public Table aggBy(Collection aggregations, boolean preserveEmpty, Table initialGroups,
Collection groupByColumns) {
return coalesce().aggBy(aggregations, preserveEmpty, initialGroups, groupByColumns);
}
@Override
public Table headBy(long nRows, String... groupByColumnNames) {
return coalesce().headBy(nRows, groupByColumnNames);
}
@Override
public Table tailBy(long nRows, String... groupByColumnNames) {
return coalesce().tailBy(nRows, groupByColumnNames);
}
@Override
public Table ungroup(boolean nullFill, Collection columnsToUngroup) {
return coalesce().ungroup(nullFill, columnsToUngroup);
}
@Override
@ConcurrentMethod
public PartitionedTable partitionBy(boolean dropKeys, String... keyColumnNames) {
return coalesce().partitionBy(dropKeys, keyColumnNames);
}
@Override
@ConcurrentMethod
public PartitionedTable partitionedAggBy(Collection aggregations, boolean preserveEmpty,
Table initialGroups, String... keyColumnNames) {
return coalesce().partitionedAggBy(aggregations, preserveEmpty, initialGroups, keyColumnNames);
}
@Override
@ConcurrentMethod
public RollupTable rollup(Collection aggregations, boolean includeConstituents,
Collection groupByColumns) {
return coalesce().rollup(aggregations, includeConstituents, groupByColumns);
}
@Override
@ConcurrentMethod
public TreeTable tree(String idColumn, String parentColumn) {
return coalesce().tree(idColumn, parentColumn);
}
@Override
public Table updateBy(@NotNull final UpdateByControl control,
@NotNull final Collection ops,
@NotNull final Collection byColumns) {
return UpdateBy.updateBy((QueryTable) this.coalesce(), ops, byColumns, control);
}
@Override
@ConcurrentMethod
public Table sort(Collection columnsToSortBy) {
return coalesce().sort(columnsToSortBy);
}
@Override
@ConcurrentMethod
public Table reverse() {
return coalesce().reverse();
}
@Override
public Table snapshot() {
return coalesce().snapshot();
}
@Override
public Table snapshotWhen(Table trigger, SnapshotWhenOptions options) {
return coalesce().snapshotWhen(trigger, options);
}
@Override
public Table getSubTable(TrackingRowSet rowSet) {
return coalesce().getSubTable(rowSet);
}
@Override
public R apply(Function function) {
return coalesce().apply(function);
}
@Override
@ConcurrentMethod
public Table flatten() {
return coalesce().flatten();
}
@Override
public void awaitUpdate() throws InterruptedException {
coalesce().awaitUpdate();
}
@Override
public boolean awaitUpdate(long timeout) throws InterruptedException {
return coalesce().awaitUpdate(timeout);
}
@Override
public void addUpdateListener(ShiftObliviousListener listener, boolean replayInitialImage) {
coalesce().addUpdateListener(listener, replayInitialImage);
}
@Override
public void addUpdateListener(@NotNull TableUpdateListener listener) {
coalesce().addUpdateListener(listener);
}
@Override
public boolean addUpdateListener(@NotNull TableUpdateListener listener, long requiredLastNotificationStep) {
return coalesce().addUpdateListener(listener, requiredLastNotificationStep);
}
@Override
public void removeUpdateListener(ShiftObliviousListener listener) {
coalesce().removeUpdateListener(listener);
}
@Override
public void removeUpdateListener(TableUpdateListener listener) {
coalesce().removeUpdateListener(listener);
}
// endregion delegated methods
}