Package io.deephaven.plot.filters

Class SelectableDataSetOneClick

java.lang.Object
io.deephaven.plot.filters.SelectableDataSetOneClick
All Implemented Interfaces:
SelectableDataSet<String,Set<Object>>
public class SelectableDataSetOneClick extends Object implements SelectableDataSet<String,Set<Object>>
A OneClick filtered table. If requireAllFiltersToDisplay is true, data is only displayed once the user has OneClick filtered all byColumns. If requireAllFiltersToDisplay is false, data is displayed when not all oneclicks are selected

  • Constructor Details

    • SelectableDataSetOneClick

      public SelectableDataSetOneClick(io.deephaven.engine.table.PartitionedTable partitionedTable)
      Creates a SelectableDataSetOneClick instance.

      Listens for OneClick events for the specified byColumns and calculates the SwappableTable by filtering the table. The SwappableTable will be null until all byColumns have a corresponding OneClick filter.

      Parameters:
      partitionedTable - partitioned table
      Throws:
      io.deephaven.base.verify.RequirementFailure - partitionedTable, table and byColumns must not be null

    • SelectableDataSetOneClick

      public SelectableDataSetOneClick(io.deephaven.engine.table.PartitionedTable partitionedTable, boolean requireAllFiltersToDisplay)
      Creates a SelectableDataSetOneClick instance.

      Listens for OneClick events for the specified byColumns and calculates the SwappableTable by filtering the table. If requireAllFiltersToDisplay is true, the SwappableTable will be null until all byColumns have a corresponding OneClick filter. If requireAllFiltersToDisplay is false, the SwappableTable will be calculated by filtering the table with the OneClicks used.

      Parameters:
      partitionedTable - PartitionedTable
      requireAllFiltersToDisplay - false to display data when not all oneclicks are selected; true to only display data when appropriate oneclicks are selected
      Throws:
      io.deephaven.base.verify.RequirementFailure - partitionedTable, table and byColumns must not be null

  • Method Details

    • getTableDefinition

      public io.deephaven.engine.table.TableDefinition getTableDefinition()
      Specified by:
      getTableDefinition in interface SelectableDataSet<String,Set<Object>>
      Returns:
      underlying table definition.

    • getByColumns

      public String[] getByColumns()

    • getSwappableTable

      public SwappableTable getSwappableTable(Comparable seriesName, ChartImpl chart, Function<io.deephaven.engine.table.Table,io.deephaven.engine.table.Table> tableTransform, String... cols)
      Description copied from interface: SelectableDataSet
      Gets the view of the Table with the selected subset.
      Specified by:
      getSwappableTable in interface SelectableDataSet<String,Set<Object>>
      chart - chart
      tableTransform - tableTransform applied to the tables in partitionedTables. The purpose of this transform is to track the table definitions for tables inside partitionedTable
      cols - selected columns
      Returns:
      table view on selected subset

    • transform

      public SelectableDataSet<String,Set<Object>> transform(@NotNull @NotNull Object memoKey, @NotNull @NotNull Function<io.deephaven.engine.table.Table,io.deephaven.engine.table.Table> transformation)
      Description copied from interface: SelectableDataSet
      Produces a derivative SelectableDataSet with the specified transformation applied to all internal tables.
      Specified by:
      transform in interface SelectableDataSet<String,Set<Object>>
      Parameters:
      memoKey - An Object that uniquely identifies the actions taken by the transformation so it can be cached.
      Returns:
      a new SelectableDataSet with the transformation applied