io.deephaven.engine.table.impl.join.JoinKeyState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-table Show documentation

Engine Table: Implementation and closely-coupled utilities

There is a newer version: 0.37.1

Show newest version

/**
 * Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
 */
package io.deephaven.engine.table.impl.join;

import io.deephaven.engine.rowset.RowSet;

interface JoinKeyState {
    void addLeftIndices(RowSet leftIndices);

    void removeLeftIndices(RowSet leftIndices);

    void addRightIndices(RowSet rightIndices);

    void removeRightIndices(RowSet rightIndices);

    void modifyByRightIndices(RowSet rightRowSet);// Informs the state the right RowSet at that position was modified

    /**
     * After the right side has been changed (all additions, modifications, removals, etc.) have been completed; each
     * state is visited calling propagateRightUpdates to update its WritableRowRedirection and the list of left
     * indicesthat have been modified by right changes.
     */
    void propagateRightUpdates();

    boolean isActive();

    void setActive();

    String dumpString();

    /**
     * Get the key for this join state, for use within the statesByKey KeyedObjectHashMap.
     */
    Object getKey();

    /**
     * Intrusive set for touchedStates or statesTouchedByRight.
     *
     * The sets can swap back and forth; so rather than having to remove things from one set and enter them into
     * another; we swap which of the two intrusive references we use.
     */
    int getSlot1();

    void setSlot1(int slot);

    /**
     * Second intrusive list for touchedStates or statesTouchedByRight.
     */
    int getSlot2();

    void setSlot2(int slot);
}