Package io.deephaven.multiviewwidget.impl

Class AggViewBuilderImpl

java.lang.Object

io.deephaven.multiviewwidget.impl.AggViewBuilderImpl

All Implemented Interfaces:

AggViewBuilder, ViewFactory

@ScriptApi
public class AggViewBuilderImpl
extends Object
implements AggViewBuilder

Constructor Summary

Constructors

Constructor	Description
AggViewBuilderImpl(WidgetBuilder widgetBuilder, String name, Table liveTable, Color tabColor, String... defaultGroupingCols)

Method Summary

Modifier and Type	Method	Description
@NotNull AggViewBuilder	agg(@Nullable AggType aggType, @NotNull Collection<String> aggTypeCols)	Defines aggregation-type for identified columns.
@NotNull AggViewBuilder	aggColumnOrder(@NotNull Collection<String> aggFrontCols)	Identifies columns which should be displayed toward the beginning of the resultant columns
@NotNull AggViewBuilder	aggFormatColumns(@NotNull Collection<String> aggFormatCols)	Defines a number of column-level formats which will be applied to the resultant table.
@NotNull AggViewBuilder	aggFormatColumnWhere(@NotNull String aggFormatCol, @NotNull String aggFormatCondition, String aggFormatColor)	Defines a conditional columnar format.
@NotNull AggViewBuilder	aggSortAscending(@NotNull Collection<String> aggSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull AggViewBuilder	aggSortDescending(@NotNull Collection<String> aggSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull AggViewBuilder	collapseSideView(boolean startCollapsed)	Identifies if the side-panel for this view should start collapsed
@NotNull WidgetBuilder	getBuilder()	Get the parent builder in its current state.
@NotNull AggViewBuilderImpl	groupingColumns(@NotNull Collection<String> aggGroupingCols)	Set the allowable set of grouping columns.
@NotNull AggViewBuilder	linkFilterColumn(@NotNull Collection<String> linkColumns)	Identifies column(s) used to filter on the linked view.
@NotNull AggViewBuilder	linkTo(@NotNull String linkTarget)	Defines a directional link to another view-tab.
@NotNull AggViewBuilder	withTotals(boolean includeTotals)	Identifies if the view should include a totals row.

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.AggViewBuilder

agg, agg, agg, aggColumnOrder, aggColumns, aggColumns, aggFormatColumns, aggSortAscending, aggSortDescending, collapseSideView, groupingColumns, linkFilterColumn

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

AggViewBuilderImpl

public AggViewBuilderImpl(WidgetBuilder widgetBuilder,
 String name,
 Table liveTable,
 Color tabColor,
 String... defaultGroupingCols)

Method Details

groupingColumns

@NotNull
public @NotNull AggViewBuilderImpl groupingColumns(@NotNull
 @NotNull Collection<String> aggGroupingCols)

Description copied from interface: AggViewBuilder

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

Specified by:

groupingColumns in interface AggViewBuilder

Parameters:

aggGroupingCols - the allowable grouping columns.

Returns:

this AggViewBuilder

agg

@NotNull
public @NotNull AggViewBuilder agg(@Nullable
 @Nullable AggType aggType,
 @NotNull
 @NotNull Collection<String> aggTypeCols)

Description copied from interface: AggViewBuilder

Defines aggregation-type for identified columns. In the case that multiple aggregation-types are desired for a single column, then a call to this builder-method for each aggregation-type will be required. Columns which have non-standard aggregation will have the resultant column-header identify the underlying column-name and agg-type, unless explicitly defined using "targetColumnName=aggregatingColumnName" notation.

Specified by:

agg in interface AggViewBuilder

Parameters:

aggType - the desired aggregation-type

aggTypeCols - the column(s) which will have the aggregation-type applied

Returns:

this AggViewBuilder

withTotals

@NotNull
public @NotNull AggViewBuilder withTotals(boolean includeTotals)

Description copied from interface: AggViewBuilder

Identifies if the view should include a totals row. This is 'true' by default.

Specified by:

withTotals in interface AggViewBuilder

Parameters:

includeTotals - if the view should include totals.

Returns:

this AggViewBuilder

aggColumnOrder

@NotNull
public @NotNull AggViewBuilder aggColumnOrder(@NotNull
 @NotNull Collection<String> aggFrontCols)

Description copied from interface: AggViewBuilder

Identifies columns which should be displayed toward the beginning of the resultant columns

Specified by:

aggColumnOrder in interface AggViewBuilder

Parameters:

aggFrontCols - column name(s) which should be shown near the beginning of the resultant columns

Returns:

this AggViewBuilder

aggSortAscending

@NotNull
public @NotNull AggViewBuilder aggSortAscending(@NotNull
 @NotNull Collection<String> aggSortCols)

Description copied from interface: AggViewBuilder

Identifies columns used for sort-ordering of the resultant table

Specified by:

aggSortAscending in interface AggViewBuilder

Parameters:

aggSortCols - column name(s) which will identify the resultant sorting

Returns:

this AggViewBuilder

aggSortDescending

@NotNull
public @NotNull AggViewBuilder aggSortDescending(@NotNull
 @NotNull Collection<String> aggSortCols)

Description copied from interface: AggViewBuilder

Identifies columns used for sort-ordering of the resultant table

Specified by:

aggSortDescending in interface AggViewBuilder

Parameters:

aggSortCols - column name(s) which will identify the resultant sorting

Returns:

this AggViewBuilder

aggFormatColumns

@NotNull
public @NotNull AggViewBuilder aggFormatColumns(@NotNull
 @NotNull Collection<String> aggFormatCols)

Description copied from interface: AggViewBuilder

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:

aggFormatColumns in interface AggViewBuilder

Parameters:

aggFormatCols - Columnar formatting to be applied to the resultant table

Returns:

this AggViewBuilder

aggFormatColumnWhere

@NotNull
public @NotNull AggViewBuilder aggFormatColumnWhere(@NotNull
 @NotNull String aggFormatCol,
 @NotNull
 @NotNull String aggFormatCondition,
 String aggFormatColor)

Description copied from interface: AggViewBuilder

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

Specified by:

aggFormatColumnWhere in interface AggViewBuilder

Parameters:

aggFormatCol - the columns which will have conditional formatting applied

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

aggFormatColor - the color to conditionally apply

Returns:

this AggViewBuilder

collapseSideView

@NotNull
public @NotNull AggViewBuilder collapseSideView(boolean startCollapsed)

Description copied from interface: AggViewBuilder

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

Specified by:

collapseSideView in interface AggViewBuilder

Returns:

this AggViewBuilder

linkTo

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

Description copied from interface: AggViewBuilder

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 AggViewBuilder

Parameters:

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

Returns:

this AggViewBuilder

linkFilterColumn

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

Description copied from interface: AggViewBuilder

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 AggViewBuilder

Parameters:

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

Returns:

this AggViewBuilder

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