Package io.deephaven.multiviewwidget.impl

Class RollupViewBuilderImpl

java.lang.Object

io.deephaven.multiviewwidget.impl.RollupViewBuilderImpl

All Implemented Interfaces:

RollupViewBuilder, ViewFactory

public class RollupViewBuilderImpl
extends Object
implements RollupViewBuilder

Constructor Summary

Constructors

Constructor	Description
RollupViewBuilderImpl(WidgetBuilder widgetBuilder, String name, Table table, Color tabColor)

Method Summary

Modifier and Type	Method	Description
@NotNull RollupViewBuilder	agg(@NotNull Class<?> type, @NotNull AggType agg)	Set the default aggregation to apply for the specified type if the user does not choose a different one.
@NotNull RollupViewBuilder	agg(@NotNull String column, @NotNull Collection<AggType> aggs)	Set the default aggregations to apply for a specific column.
@NotNull RollupViewBuilder	collapseSideView(boolean startCollapsed)	Identifies if the side-panel for this view should start collapsed
@NotNull RollupViewBuilder	columnOrder(@NotNull Collection<String> columnOrder)
@NotNull RollupViewBuilder	defaultRollup(@NotNull RollupDefinition rollup)	Set the default rollup that will be applied when the widget is opened.
@NotNull RollupViewBuilder	formatColumns(@NotNull Collection<String> formatCols)	Defines a number of column-level formats which will be applied to the resultant table.
@NotNull RollupViewBuilder	formatColumnWhere(@NotNull String formatCol, @NotNull String formatCondition, @Nullable String formatColor)	Defines a conditional columnar format.
@NotNull WidgetBuilder	getBuilder()	Get the parent builder in its current state.
@NotNull RollupViewBuilder	groupingColumns(@NotNull Collection<String> groupingCols)	Set the allowable set of grouping columns.
@NotNull RollupViewBuilder	linkFilterColumn(@NotNull Collection<String> linkColumns)	Identifies column(s) used to filter on the linked view.
@NotNull RollupViewBuilder	linkTo(@NotNull String linkTarget)	Defines a directional link to another view-tab.
@NotNull RollupViewBuilder	sortAscending(@NotNull String col, @NotNull Collection<AggType> aggs)	Identifies columns used for sort-ordering of the resultant table
@NotNull RollupViewBuilder	sortDescending(@NotNull String col, @NotNull Collection<AggType> aggs)	Identifies columns used for sort-ordering of the resultant table

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.deephaven.multiviewwidget.builder.RollupViewBuilder

agg, collapseSideView, columnOrder, formatColumns, groupingColumns, linkFilterColumn, sortAscending, sortDescending

Methods inherited from interface io.deephaven.multiviewwidget.builder.ViewFactory

addAggView, addAggView, addGlobalFilter, addGlobalFilter, addLeafView, addLeafView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPlotView, addPlotView, addPlotView, addPlotView, addRollupView, addRollupView, addStaticFilter, build, collapseGlobalFilter, collapseGlobalFilter, globalFilterBucket, globalFilterBucket

Constructor Details

RollupViewBuilderImpl

public RollupViewBuilderImpl(WidgetBuilder widgetBuilder,
 String name,
 Table table,
 Color tabColor)

Method Details

groupingColumns

@NotNull
public @NotNull RollupViewBuilder groupingColumns(@NotNull
 @NotNull Collection<String> groupingCols)

Description copied from interface: RollupViewBuilder

Set the allowable set of grouping columns. These will be displayed to the user for customization.

Specified by:

groupingColumns in interface RollupViewBuilder

Parameters:

groupingCols - the allowable grouping columns.

Returns:

this RollupViewBuilder

defaultRollup

@NotNull
public @NotNull RollupViewBuilder defaultRollup(@NotNull
 @NotNull RollupDefinition rollup)

Description copied from interface: RollupViewBuilder

Set the default rollup that will be applied when the widget is opened.

Specified by:

defaultRollup in interface RollupViewBuilder

Parameters:

rollup - the rollup

Returns:

this RollupViewBuilder

agg

@NotNull
public @NotNull RollupViewBuilder agg(@NotNull
 @NotNull Class<?> type,
 @NotNull
 @NotNull AggType agg)

Description copied from interface: RollupViewBuilder

Set the default aggregation to apply for the specified type if the user does not choose a different one.

Specified by:

agg in interface RollupViewBuilder

Parameters:

type - the type

agg - the default agg for this type

Returns:

this RollupViewBuilder

agg

@NotNull
public @NotNull RollupViewBuilder agg(@NotNull
 @NotNull String column,
 @NotNull
 @NotNull Collection<AggType> aggs)

Description copied from interface: RollupViewBuilder

Set the default aggregations to apply for a specific column. This takes precedence over default type aggs.

Specified by:

agg in interface RollupViewBuilder

Parameters:

column - the column name

aggs - the default aggs for this column.

Returns:

this RollupViewBuilder

sortAscending

@NotNull
public @NotNull RollupViewBuilder sortAscending(@NotNull
 @NotNull String col,
 @NotNull
 @NotNull Collection<AggType> aggs)

Description copied from interface: RollupViewBuilder

Identifies columns used for sort-ordering of the resultant table

Specified by:

sortAscending in interface RollupViewBuilder

Parameters:

col - column name which will identify the resultant sorting * @param aggs the aggregation to be sorted. No parameter indicates sort the grouping column if available.

Returns:

this RollupViewBuilder

sortDescending

@NotNull
public @NotNull RollupViewBuilder sortDescending(@NotNull
 @NotNull String col,
 @NotNull
 @NotNull Collection<AggType> aggs)

Description copied from interface: RollupViewBuilder

Identifies columns used for sort-ordering of the resultant table

Specified by:

sortDescending in interface RollupViewBuilder

Parameters:

col - column name which will identify the resultant sorting

aggs - the aggregation to be sorted. No parameter indicates sort the grouping column if available.

Returns:

this RollupViewBuilder

columnOrder

@NotNull
public @NotNull RollupViewBuilder columnOrder(@NotNull
 @NotNull Collection<String> columnOrder)

Specified by:

columnOrder in interface RollupViewBuilder

formatColumns

@NotNull
public @NotNull RollupViewBuilder formatColumns(@NotNull
 @NotNull Collection<String> formatCols)

Description copied from interface: RollupViewBuilder

Defines a number of column-level formats which will be applied to the resultant table. The formatting is identical to that defined by Table.formatColumns(String...)

Specified by:

formatColumns in interface RollupViewBuilder

Parameters:

formatCols - Columnar formatting to be applied to the resultant table

Returns:

this RollupViewBuilder

formatColumnWhere

@NotNull
public @NotNull RollupViewBuilder formatColumnWhere(@NotNull
 @NotNull String formatCol,
 @NotNull
 @NotNull String formatCondition,
 @Nullable
 @Nullable String formatColor)

Description copied from interface: RollupViewBuilder

Defines a conditional columnar format. See Table.formatColumnWhere(String, String, String)

Specified by:

formatColumnWhere in interface RollupViewBuilder

Parameters:

formatCol - the columns which will have conditional formatting applied

formatCondition - the condition used to identify if the color should be applied

formatColor - the color to conditionally apply

Returns:

this RollupViewBuilder

collapseSideView

@NotNull
public @NotNull RollupViewBuilder collapseSideView(boolean startCollapsed)

Description copied from interface: RollupViewBuilder

Identifies if the side-panel for this view should start collapsed

Specified by:

collapseSideView in interface RollupViewBuilder

Returns:

this RollupViewBuilder

linkTo

@NotNull
public @NotNull RollupViewBuilder linkTo(@NotNull
 @NotNull String linkTarget)

Description copied from interface: RollupViewBuilder

Defines a directional link to another view-tab. By default, current "Group-By" column(s) on the current view will be used as filters on the linked view

Specified by:

linkTo in interface RollupViewBuilder

Parameters:

linkTarget - a view-tab to which this table is linked

Returns:

this RollupViewBuilder

linkFilterColumn

@NotNull
public @NotNull RollupViewBuilder linkFilterColumn(@NotNull
 @NotNull Collection<String> linkColumns)

Description copied from interface: RollupViewBuilder

Identifies column(s) used to filter on the linked view. When following a link from the specified column(s), then the default "Group-By" column(s) will not be used as filters on the linked view

Specified by:

linkFilterColumn in interface RollupViewBuilder

Parameters:

linkColumns - a column in the existing view, which will be used as a filter on the linked view

Returns:

this RollupViewBuilder

getBuilder

@NotNull
public @NotNull WidgetBuilder getBuilder()

Description copied from interface: ViewFactory

Get the parent builder in its current state. May be used to store intermediary states of the builder in order to separate widget-creation into multiple distinct sections

Specified by:

getBuilder in interface ViewFactory

Returns:

the parent builder