com.illumon.iris.console.utils

Class PivotWidgetBuilder

java.lang.Object

com.illumon.iris.console.utils.PivotWidgetBuilder

@ScriptApi
public class PivotWidgetBuilder
extends Object

Helper class to build a Pivot Widget and set all of its options. Example Usage: pw = PivotWidgetBuilder.pivot(t, "rowCol", "titleCol", "valueCol").sum().across().down().show()

Constructor Summary

Constructors

Constructor and Description
PivotWidgetBuilder(Table tableToPivot, String row, String columnTitleColumn, String valueColumn) Creates a Pivot Widget Builder.

Method Summary

Modifier and Type	Method and Description
PivotWidgetBuilder	across() Shorthand to turn on across aggregation.
PivotWidgetBuilder	across(boolean value) Indicates whether or not to aggregate across.
PivotWidgetBuilder	addFilterColumns(String... filterColumns) Adds one or more filter column sto the Pivot Widget.
PivotWidgetBuilder	addRows(String... rows) Adds one or more rows to the Pivot Widget.
PivotWidgetBuilder	addValueColumns(String... valueColumns) Adds one or more value column sto the Pivot Widget.
PivotWidgetBuilder	avg() Sets the aggregation to AVERAGE.
PivotWidgetBuilder	colorRowColumns() If a heatmap is being displayed, this will color the row columns as well.
PivotWidgetBuilder	down() Shorthand to turn on down aggregation.
PivotWidgetBuilder	down(boolean value) Indicates whether or not to aggregate down.
PivotWidgetBuilder	heatMap() Display a heat map with default coloring.
PivotWidgetBuilder	heatMap(boolean value) Indicates whether or not to display a heat map.
PivotWidgetBuilder	heatMap(boolean value, com.illumon.iris.gui.color.Color minColor, com.illumon.iris.gui.color.Color maxColor) If value is true, display a heat map with the given colors.
PivotWidgetBuilder	heatMap(com.illumon.iris.gui.color.Color minColor, com.illumon.iris.gui.color.Color maxColor) Display a heat map with the given colors.
static PivotWidgetBuilder	pivot(Table tableToPivot, String row, String columnTitleColumn, String unitColumn) Starts a Pivot Widget Builder.
PivotWidgetBuilder	setColorFormat(Function<Object,Object> colorFormat) Sets the Color Format for the Pivot Widget.
PivotWidgetBuilder	setColumnNameTransform(Function<Object,Object> columnNameTransform) Sets a transform to rename columns in the Pivot Widget.
PivotWidgetBuilder	setMainDecimalFormat(String format) Sets the decimal format for the main table.
PivotWidgetBuilder	setMainIntegerFormat(String format) Sets the integer format for the main table.
PivotWidgetBuilder	setRowDecimalFormat(String format) Sets the decimal format for the row table
PivotWidgetBuilder	setRowIntegerFormat(String format) Sets the integer format for the row table
PivotWidgetBuilder	setTotalsDecimalFormat(String format) Sets the decimal format for the totals table
PivotWidgetBuilder	setTotalsIntegerFormat(String format) Sets the integer format for the totals table
LiveWidget	show() Shows the Pivot Widget.
PivotWidgetBuilder	sortColumnTitles() Sort Column Titles Ascending
PivotWidgetBuilder	sortColumnTitlesDescending() Sort Column Titles Descending
PivotWidgetBuilder	sortRows() Sort Row Columns Ascending
PivotWidgetBuilder	sortRowsDescending() Sort Row Columns Descending
PivotWidgetBuilder	sum() Sets the aggregation to SUM.
PivotWidgetBuilder	totals(boolean value) Indicates whether or not display totals.
PivotWidgetBuilder	unique() Sets the aggregation to UNIQUE.

Methods inherited from class java.lang.Object

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

Constructor Detail

PivotWidgetBuilder

@ScriptApi
public PivotWidgetBuilder(Table tableToPivot,
                                     String row,
                                     String columnTitleColumn,
                                     String valueColumn)

Creates a Pivot Widget Builder.

Parameters:

tableToPivot - the table to pivot

row - a key column for the rows, more can be added using PivotWidgetBuilder.addRows(String...)

columnTitleColumn - the column used as a title for each column

valueColumn - a column containing values of interest, more can be added using PivotWidgetBuilder.addValueColumns(String...)

Method Detail

pivot

@ScriptApi
public static PivotWidgetBuilder pivot(Table tableToPivot,
                                                  String row,
                                                  String columnTitleColumn,
                                                  String unitColumn)

Starts a Pivot Widget Builder.

Parameters:

tableToPivot - the table to pivot

row - a key column for the rows, more can be added using PivotWidgetBuilder.addRows(String...)

columnTitleColumn - the column used as a title for each column

unitColumn - a column containing values of interest, more can be added using PivotWidgetBuilder.addValueColumns(String...)

show

@ScriptApi
public LiveWidget show()

Shows the Pivot Widget.

Returns:

a LiveWidget containing a Pivot Widget

addRows

@ScriptApi
public PivotWidgetBuilder addRows(String... rows)

Adds one or more rows to the Pivot Widget.

Parameters:

rows - key columns for the rows

addValueColumns

@ScriptApi
public PivotWidgetBuilder addValueColumns(String... valueColumns)

Adds one or more value column sto the Pivot Widget.

Parameters:

valueColumns - columns containing values of interest

addFilterColumns

@ScriptApi
public PivotWidgetBuilder addFilterColumns(String... filterColumns)

Adds one or more filter column sto the Pivot Widget.

Parameters:

filterColumns - columns to be used for filtering

sum

@ScriptApi
public PivotWidgetBuilder sum()

Sets the aggregation to SUM. Note that only one aggregation can be set.

avg

@ScriptApi
public PivotWidgetBuilder avg()

Sets the aggregation to AVERAGE. Note that only one aggregation can be set.

unique

@ScriptApi
public PivotWidgetBuilder unique()

Sets the aggregation to UNIQUE. Note that only one aggregation can be set.

across

@ScriptApi
public PivotWidgetBuilder across(boolean value)

Indicates whether or not to aggregate across. Defaults to false.

Parameters:

value - true to aggregate across

across

@ScriptApi
public PivotWidgetBuilder across()

Shorthand to turn on across aggregation.

down

@ScriptApi
public PivotWidgetBuilder down(boolean value)

Indicates whether or not to aggregate down. Defaults to false.

Parameters:

value - true to aggregate down

down

@ScriptApi
public PivotWidgetBuilder down()

Shorthand to turn on down aggregation.

totals

@ScriptApi
public PivotWidgetBuilder totals(boolean value)

Indicates whether or not display totals. Defaults to true.

Parameters:

value - true to display totals

sortRows

@ScriptApi
public PivotWidgetBuilder sortRows()

Sort Row Columns Ascending

sortRowsDescending

@ScriptApi
public PivotWidgetBuilder sortRowsDescending()

Sort Row Columns Descending

sortColumnTitles

@ScriptApi
public PivotWidgetBuilder sortColumnTitles()

Sort Column Titles Ascending

sortColumnTitlesDescending

@ScriptApi
public PivotWidgetBuilder sortColumnTitlesDescending()

Sort Column Titles Descending

heatMap

@ScriptApi
public PivotWidgetBuilder heatMap()

Display a heat map with default coloring.

heatMap

@ScriptApi
public PivotWidgetBuilder heatMap(com.illumon.iris.gui.color.Color minColor,
                                             com.illumon.iris.gui.color.Color maxColor)

Display a heat map with the given colors.

Parameters:

minColor - foreground color at or below the minimum value of the heat map

maxColor - foreground color at or below the maximum value of the heat map

heatMap

@ScriptApi
public PivotWidgetBuilder heatMap(boolean value)

Indicates whether or not to display a heat map. Defaults to false. If value is true, this heat map will the use default colors.

Parameters:

value - true to display a heat map

heatMap

@ScriptApi
public PivotWidgetBuilder heatMap(boolean value,
                                             com.illumon.iris.gui.color.Color minColor,
                                             com.illumon.iris.gui.color.Color maxColor)

If value is true, display a heat map with the given colors. If value is false, do not display a heat map.

Parameters:

value - true to display a heat map

minColor - foreground color at or below the minimum value of the heat map

maxColor - foreground color at or below the maximum value of the heat map

setMainDecimalFormat

@ScriptApi
public PivotWidgetBuilder setMainDecimalFormat(String format)

Sets the decimal format for the main table.

Parameters:

format - the decimal format for the main table

setRowDecimalFormat

@ScriptApi
public PivotWidgetBuilder setRowDecimalFormat(String format)

Sets the decimal format for the row table

Parameters:

format - the decimal format for the row table

setTotalsDecimalFormat

@ScriptApi
public PivotWidgetBuilder setTotalsDecimalFormat(String format)

Sets the decimal format for the totals table

Parameters:

format - the decimal format for the totals table

setMainIntegerFormat

@ScriptApi
public PivotWidgetBuilder setMainIntegerFormat(String format)

Sets the integer format for the main table.

Parameters:

format - the integer format for the main table

setRowIntegerFormat

@ScriptApi
public PivotWidgetBuilder setRowIntegerFormat(String format)

Sets the integer format for the row table

Parameters:

format - the integer format for the row table

setTotalsIntegerFormat

@ScriptApi
public PivotWidgetBuilder setTotalsIntegerFormat(String format)

Sets the integer format for the totals table

Parameters:

format - the integer format for the totals table

setColumnNameTransform

@ScriptApi
public PivotWidgetBuilder setColumnNameTransform(Function<Object,Object> columnNameTransform)

Sets a transform to rename columns in the Pivot Widget.

Parameters:

columnNameTransform - the column name transform

setColorFormat

@ScriptApi
public PivotWidgetBuilder setColorFormat(Function<Object,Object> colorFormat)

Sets the Color Format for the Pivot Widget.

Parameters:

colorFormat - the color format

colorRowColumns

@ScriptApi
public PivotWidgetBuilder colorRowColumns()

If a heatmap is being displayed, this will color the row columns as well.