Package com.illumon.iris.console.utils.pivot

Class PivotOptions

java.lang.Object

com.illumon.iris.console.utils.pivot.PivotOptions

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LivePivotWidget.Options

@InternalUseOnly
public class PivotOptions
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PivotOptions.OverrideFormatOption

Field Summary

Fields

Modifier and Type	Field	Description
boolean	aggregateAcross
boolean	aggregateDown
boolean	colorRowColumns
Map<String,Integer>	filterFetchSizes
boolean	fixedTotalColumn
boolean	heatMap
Color	heatMapMaxColor
Color	heatMapMinColor
int	sortColumns
LivePivotWidget.ColumnSortType	sortColumnsBy
int	sortRows
LivePivotWidget.RowSortType	sortRowsBy
String	sortRowsByName
LivePivotWidget.Aggregation	totalsAggregation
boolean	useColorFormat
boolean	useColumnNameTransform

Constructor Summary

Constructors

Constructor	Description
PivotOptions()

Method Summary

Modifier and Type	Method	Description
Format	getDecimalFormat(PivotRole role, String valueColumnName)	Get the decimal format for the specified value column and role.
Format	getIntegerFormat(PivotRole role, String valueColumnName)	Get the integer format for the specified value column and role.
protected Format	maybeGetLegacyFormat(PivotRole role, boolean isDecimal)	Get any legacy formats.
void	overrideDecimalFormat(PivotRole role, String valueColumnName, Format format)
void	overrideIntegerFormat(PivotRole role, String valueColumnName, Format format)
void	setDecimalFormat(PivotRole role, String valueColumnName, String format)
void	setDefaultDecimalFormat(PivotRole role, String format)
void	setDefaultIntegerFormat(PivotRole role, String format)
void	setIntegerFormat(PivotRole role, String valueColumnName, String format)

Methods inherited from class java.lang.Object

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

Field Details

aggregateAcross

public boolean aggregateAcross

aggregateDown

public boolean aggregateDown

totalsAggregation

public LivePivotWidget.Aggregation totalsAggregation

sortColumnsBy

public LivePivotWidget.ColumnSortType sortColumnsBy

sortColumns

public int sortColumns

fixedTotalColumn

public boolean fixedTotalColumn

sortRows

public int sortRows

sortRowsBy

public LivePivotWidget.RowSortType sortRowsBy

sortRowsByName

public String sortRowsByName

heatMap

public boolean heatMap

useColorFormat

public boolean useColorFormat

colorRowColumns

public boolean colorRowColumns

useColumnNameTransform

public boolean useColumnNameTransform

heatMapMinColor

public Color heatMapMinColor

heatMapMaxColor

public Color heatMapMaxColor

filterFetchSizes

public Map<String,Integer> filterFetchSizes

Constructor Details

PivotOptions

public PivotOptions()

Method Details

getIntegerFormat

public Format getIntegerFormat(@NotNull
 PivotRole role,
 @NotNull
 String valueColumnName)

Get the integer format for the specified value column and role. If none was specified via header menus or builder then the default one is used.

Parameters:

role - the role to get the integer format for

valueColumnName - the value column being rendered

Returns:

the format

getDecimalFormat

public Format getDecimalFormat(@NotNull
 PivotRole role,
 @NotNull
 String valueColumnName)

Get the decimal format for the specified value column and role. If none was specified via header menus or builder then the default one is used.

Parameters:

role - the role to get the integer format for

valueColumnName - the value column being rendered

Returns:

the format

setDefaultIntegerFormat

public void setDefaultIntegerFormat(@NotNull
 PivotRole role,
 @NotNull
 String format)

setDefaultDecimalFormat

public void setDefaultDecimalFormat(@NotNull
 PivotRole role,
 @NotNull
 String format)

setIntegerFormat

public void setIntegerFormat(@NotNull
 PivotRole role,
 @NotNull
 String valueColumnName,
 @NotNull
 String format)

setDecimalFormat

public void setDecimalFormat(@NotNull
 PivotRole role,
 @NotNull
 String valueColumnName,
 @NotNull
 String format)

overrideIntegerFormat

public void overrideIntegerFormat(@NotNull
 PivotRole role,
 @NotNull
 String valueColumnName,
 @Nullable
 Format format)

overrideDecimalFormat

public void overrideDecimalFormat(@NotNull
 PivotRole role,
 @NotNull
 String valueColumnName,
 @Nullable
 Format format)

maybeGetLegacyFormat

@Nullable
protected Format maybeGetLegacyFormat(@NotNull
 PivotRole role,
 @NotNull
 boolean isDecimal)

Get any legacy formats. This method should be deleted when LivePivotWidget.Options is deleted.

Parameters:

role - the pivot role

isDecimal - is it a decimal format?

Returns:

the format, or null.