io.deephaven.engine.table.impl.sources.regioned.SymbolTableSource 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.sources.regioned;

import io.deephaven.engine.table.ColumnSource;
import io.deephaven.engine.table.Table;
import io.deephaven.engine.table.impl.QueryTable;
import io.deephaven.engine.rowset.RowSet;
import org.jetbrains.annotations.NotNull;

/**
 * 
 * Interface for {@link ColumnSource}s that can provide a {@link Table} view of their symbol tables, providing a many:1
 * or 1:1 mapping of unique {@code long} identifiers to the symbol values in this source.
 * 

 * Such sources are also expected to be reinterpretable ({@link ColumnSource#allowsReinterpret(Class)}) as {@code long}
 * {@link ColumnSource}s of the same identifiers.
 */
public interface SymbolTableSource extends ColumnSource {

    /**
     * The name for the column of {@code long} identifiers.
     */
    String ID_COLUMN_NAME = "ID";

    /**
     * The name for the column of symbol values, which will have the same data type as this column source.
     */
    String SYMBOL_COLUMN_NAME = "Symbol";

    /**
     * @param sourceRowSet The {@link RowSet} whose keys must be mappable
     * @return Whether this SymbolTableSource can provide a symbol table that covers all keys in {@code sourceRowSet}.
     */
    boolean hasSymbolTable(@NotNull final RowSet sourceRowSet);

    /**
     * 

     * Get a static {@link Table} view of this SymbolTableSource's symbol table, providing a many:1 or 1:1 mapping of
     * unique {@code long} identifiers to the symbol values in this source.
     *
     * @param sourceRowSet The {@link RowSet} whose keys must be mappable via the result {@link Table}'s identifier
     *        column
     * @param useLookupCaching Hint whether symbol lookups performed to generate the symbol table should apply caching.
     *        Implementations may ignore this hint.
     * @return The symbol table
     */
    Table getStaticSymbolTable(@NotNull RowSet sourceRowSet, boolean useLookupCaching);

    /**
     * 

     * Get a {@link Table} view of this SymbolTableSource's symbol table, providing a many:1 or 1:1 mapping of unique
     * {@code long} identifiers to the symbol values in this source.
     *
     * 
     * The result will be refreshing if {@code table} {@link Table#isRefreshing() is refreshing}.
     *
     * @param sourceTable The {@link QueryTable} whose row keys must be mappable via the result {@link Table}'s
     *        identifier column
     * @param useLookupCaching Hint whether symbol lookups performed to generate the symbol table should apply caching.
     *        Implementations may ignore this hint.
     * @return The symbol table
     */
    Table getSymbolTable(@NotNull QueryTable sourceTable, boolean useLookupCaching);

    /**
     * Check if the specified {@link ColumnSource} supports a symbol table for the entirety of the supplied
     * {@link RowSet}.
     *
     * @param source The column source
     * @param rowSet The {@link RowSet} for inspection.
     * @return True if the column source can provide a complete symbol table for the provided RowSet.
     */
    static boolean hasSymbolTable(@NotNull final ColumnSource source, @NotNull final RowSet rowSet) {
        return source instanceof SymbolTableSource && ((SymbolTableSource) source).hasSymbolTable(rowSet);
    }
}