io.deephaven.engine.table.GridAttributes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-api Show documentation
Engine API: Engine API module, suitable as a compile-time dependency for most queries
The newest version!
//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.engine.table;

import io.deephaven.api.util.ConcurrentMethod;
import org.jetbrains.annotations.NotNull;

import java.util.Collections;
import java.util.Map;

/**
 * Attribute-driven functionality shared by {@link Table} and other grid-like components.
 */
public interface GridAttributes> extends AttributeMap {

    String SORTABLE_COLUMNS_ATTRIBUTE = "SortableColumns";
    String LAYOUT_HINTS_ATTRIBUTE = "LayoutHints";
    String DESCRIPTION_ATTRIBUTE = "TableDescription";
    String COLUMN_DESCRIPTIONS_ATTRIBUTE = "ColumnDescriptions";

    /**
     * Disallow sorting on all but the specified columns.
     *
     * @param allowedSortingColumns The columns for which sorting is to be allowed
     * @return A copy of this grid with the sort restrictions applied, or this if no change was needed
     */
    @ConcurrentMethod
    TYPE restrictSortTo(@NotNull String... allowedSortingColumns);

    /**
     * Clear all sorting restrictions that were applied to the grid.
     *
     * @return A copy of this grid with the sort restrictions removed, or this if no change was needed
     */
    @ConcurrentMethod
    TYPE clearSortingRestrictions();

    /**
     * Apply a description to this grid.
     *
     * @param description The description to apply
     * @return A copy of this grid with the description applied, or this if no change was needed
     */
    @ConcurrentMethod
    TYPE withDescription(@NotNull String description);

    /**
     * Add a description for a specific column. Users should use {@link #withColumnDescriptions(Map)} to set several
     * descriptions at once.
     *
     * @param column The name of the column
     * @param description The column description
     * @return A copy of this grid with the description applied, or this if no change was needed
     */
    @ConcurrentMethod
    TYPE withColumnDescription(@NotNull String column, @NotNull String description);

    /**
     * Add a set of column descriptions to the grid.
     *
     * @param descriptions A map of column name to column description
     * @return A copy of this grid with the descriptions applied, or this if no change was needed
     */
    @ConcurrentMethod
    TYPE withColumnDescriptions(@NotNull Map descriptions);

    /**
     * Set layout hints for this grid.
     *
     * @param hints A packed string of layout hints
     * @return A copy of this grid with the layout hints applied, or this if no change was needed
     */
    @ConcurrentMethod
    TYPE setLayoutHints(@NotNull String hints);

    /**
     * @param attributes The map of attributes to examine
     * @return A possibly-empty map from column name to description
     */
    @NotNull
    static Map getColumnDescriptions(@NotNull final Map attributes) {
        // noinspection unchecked
        return (Map) attributes.getOrDefault(COLUMN_DESCRIPTIONS_ATTRIBUTE, Collections.emptyMap());
    }
}