Package com.illumon.iris.console.utils

Class LivePivotWidget

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

com.illumon.iris.db.util.liveness.ReferenceCountedLivenessNode

com.illumon.iris.db.util.liveness.LivenessArtifact

com.illumon.iris.console.utils.LivePivotWidget

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, Deflatable<LivePivotWidget>, CloseableWidget, ContextAwareLiveWidget<LivePivotWidget>, LiveWidget<LivePivotWidget>, LiveWidgetAclFilterable<LivePivotWidget>, LivenessManager, LivenessNode, LivenessReferent, Serializable

public class LivePivotWidget
extends LivenessArtifact
implements ContextAwareLiveWidget<LivePivotWidget>, Serializable, CloseableWidget, LiveWidgetAclFilterable<LivePivotWidget>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LivePivotWidget.Aggregation
static enum	LivePivotWidget.ColumnSortType
static class	LivePivotWidget.Options	Deprecated. This class has been replaced by PivotOptions and will be removed in a future release.
static enum	LivePivotWidget.RowSortType

Constructor Summary

Constructors

Constructor	Description
LivePivotWidget(Table tableToPivot, String[] rows, String columnTitleColumn, String[] valueColumns, String[] filterColumns, String[] requiredFilterColumns, LivePivotWidget.Aggregation aggregation, PivotOptions options, Function<Object,Object> colorFormat, Function<Object,Object> columnNameTransform)	This constructor is used to create the widget.
LivePivotWidget(Table tableToPivot, String[] rows, String columnTitleColumn, String[] valueColumns, String[] filterColumns, String[] requiredFilterColumns, LivePivotWidget.Aggregation aggregation, PivotOptions options, Function<Object,Object> colorFormat, Function<Object,Object> columnNameTransform, Comparable<?>[] userRowOrder, Comparable<?>[] userColumnOrder)	This constructor is used to create the widget.
LivePivotWidget(Table tableToPivot, String[] rows, String columnTitleColumn, String[] valueColumns, String[] filterColumns, String[] requiredFilterColumns, LivePivotWidget.Aggregation aggregation, PivotOptions options, Function<Object,Object> colorFormat, Map<String,Function<Object,Object>> colorFormats, Function<Object,Object> columnNameTransform)	This constructor is used to create the widget.
LivePivotWidget(Table tableToPivot, String[] rows, String columnTitleColumn, String[] valueColumns, String[] filterColumns, String[] requiredFilterColumns, LivePivotWidget.Aggregation aggregation, PivotOptions options, Function<Object,Object> colorFormat, Map<String,Function<Object,Object>> colorFormats, Function<Object,Object> columnNameTransform, Comparable<?>[] userRowColumnOrder, Comparable<?>[] userColumnOrder)	This constructor is used to create the widget.
LivePivotWidget(Table tableToPivot, String[] rows, String columnTitleColumn, String valueColumn, LivePivotWidget.Aggregation aggregation, PivotOptions options)	This constructor is used to create the widget.

Method Summary

Modifier and Type	Method	Description
LivePivotWidget	applyAcls(io.deephaven.enterprise.auth.UserContext userContext, RemoteQueryProcessor remoteQueryProcessor, String name)	This method should apply ACLs to all tables in the widget.
Inflatable<LivePivotWidget>	deflate(ExportedObjectClient client)	Convert this object into an Inflatable suitable for serialization.
Function<Object,Object>	getColorFormat()
Map<String,Function<Object,Object>>	getColorFormats()
Function<Object,Object>	getColumnNameTransform()
JComponent	getComponent(AsyncPanel dataPanel, String viewId, Object view, String title, Object irisWidgetSupportObject, com.fishlib.io.logger.Logger log)	Gets the UI component.
String	getName()	Gets the name of the Live Widget.
QueryProcessorConnection	getProcessorConnection()	gets the processor connection.
int	getSessionId()	Gets the session ID for console widgets.
static LiveWidget<LivePivotWidget>	getWidget(Table tableToPivot, String[] rows, String columnTitleColumn, String unitColumn, LivePivotWidget.Aggregation aggregation, PivotOptions options)
void	onClose()
void	setName(String name)	Sets the name of the Live Widget.
void	setProcessorConnection(QueryProcessorConnection processorConnection)	Sets the processor connection.
void	setSessionId(int sessionId)	Sets the session ID for console widgets.
LivePivotWidget	skipAcls()	This method is called in the case that ACLs should be skipped.

Methods inherited from class com.illumon.iris.db.util.liveness.LivenessArtifact

manageWithCurrentScope, unmanage, unmanage

Methods inherited from class com.illumon.iris.db.util.liveness.ReferenceCountedLivenessNode

destroy, dropReference, getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryRetainReference

Methods inherited from class com.illumon.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessManager

manage

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessReferent

getReferentDescription, retainReference

Methods inherited from interface com.illumon.iris.db.tables.utils.LiveWidget

getComponent, updateTelemetryInfo

Constructor Details

LivePivotWidget

public LivePivotWidget(Table tableToPivot,
 String[] rows,
 String columnTitleColumn,
 String valueColumn,
 LivePivotWidget.Aggregation aggregation,
 @NotNull
 PivotOptions options)

This constructor is used to create the widget.

Parameters:

tableToPivot - the table to pivot

rows - the key columns for the rows

columnTitleColumn - the column used as a title for each column

valueColumn - the column containing the value of interest

aggregation - how to aggregate the data

options - a struct of booleans that control how the widget presents the data

LivePivotWidget

public LivePivotWidget(Table tableToPivot,
 String[] rows,
 String columnTitleColumn,
 String[] valueColumns,
 String[] filterColumns,
 String[] requiredFilterColumns,
 LivePivotWidget.Aggregation aggregation,
 @NotNull
 PivotOptions options,
 Function<Object,Object> colorFormat,
 Function<Object,Object> columnNameTransform)

This constructor is used to create the widget.

Parameters:

tableToPivot - the table to pivot

rows - the key columns for the rows

columnTitleColumn - the column used as a title for each column

valueColumns - the columns containing the values of interest

aggregation - how to aggregate the data

options - a struct that control how the widget presents the data

colorFormat - an optional function for creating heatmap colors

columnNameTransform - an optional function for transforming column names

LivePivotWidget

public LivePivotWidget(Table tableToPivot,
 String[] rows,
 String columnTitleColumn,
 String[] valueColumns,
 String[] filterColumns,
 String[] requiredFilterColumns,
 LivePivotWidget.Aggregation aggregation,
 @NotNull
 PivotOptions options,
 Function<Object,Object> colorFormat,
 Function<Object,Object> columnNameTransform,
 Comparable<?>[] userRowOrder,
 Comparable<?>[] userColumnOrder)

This constructor is used to create the widget.

Parameters:

tableToPivot - the table to pivot

rows - the key columns for the rows

columnTitleColumn - the column used as a title for each column

valueColumns - the columns containing the values of interest

aggregation - how to aggregate the data

options - a struct that control how the widget presents the data

colorFormat - an optional function for creating heatmap colors

columnNameTransform - an optional function for transforming column names

userRowOrder - A custom order for row-columns

LivePivotWidget

public LivePivotWidget(Table tableToPivot,
 String[] rows,
 String columnTitleColumn,
 String[] valueColumns,
 String[] filterColumns,
 String[] requiredFilterColumns,
 LivePivotWidget.Aggregation aggregation,
 @NotNull
 PivotOptions options,
 Function<Object,Object> colorFormat,
 Map<String,Function<Object,Object>> colorFormats,
 Function<Object,Object> columnNameTransform)

This constructor is used to create the widget.

Parameters:

tableToPivot - the table to pivot

rows - the key columns for the rows

columnTitleColumn - the column used as a title for each column

valueColumns - the columns containing the values of interest

aggregation - how to aggregate the data

options - a struct that control how the widget presents the data

colorFormat - an optional function for creating heatmap colors

colorFormats - an optional map of columns to functions for creating heatmap colors

columnNameTransform - an optional function for transforming column names

LivePivotWidget

public LivePivotWidget(Table tableToPivot,
 String[] rows,
 String columnTitleColumn,
 String[] valueColumns,
 String[] filterColumns,
 String[] requiredFilterColumns,
 LivePivotWidget.Aggregation aggregation,
 @NotNull
 PivotOptions options,
 Function<Object,Object> colorFormat,
 Map<String,Function<Object,Object>> colorFormats,
 Function<Object,Object> columnNameTransform,
 Comparable<?>[] userRowColumnOrder,
 Comparable<?>[] userColumnOrder)

This constructor is used to create the widget.

Parameters:

tableToPivot - the table to pivot

rows - the key columns for the rows

columnTitleColumn - the column used as a title for each column

valueColumns - the columns containing the values of interest

aggregation - how to aggregate the data

options - a struct that control how the widget presents the data

colorFormat - an optional function for creating heatmap colors

colorFormats - an optional map of columns to functions for creating heatmap colors

columnNameTransform - an optional function for transforming column names

userRowColumnOrder - a user specified row column ordering

Method Details

onClose

public void onClose()

Specified by:

onClose in interface CloseableWidget

getColorFormat

public Function<Object,Object> getColorFormat()

getColorFormats

public Map<String,Function<Object,Object>> getColorFormats()

getColumnNameTransform

public Function<Object,Object> getColumnNameTransform()

applyAcls

public LivePivotWidget applyAcls(io.deephaven.enterprise.auth.UserContext userContext,
 RemoteQueryProcessor remoteQueryProcessor,
 String name)

Description copied from interface: LiveWidgetAclFilterable

This method should apply ACLs to all tables in the widget. For each table in the widget, this method should call:

t = RemoteDatabase.applyAcls(t, userContext, remoteQueryProcessor, name);

Specified by:

applyAcls in interface LiveWidgetAclFilterable<LivePivotWidget>

Parameters:

userContext - the user context

remoteQueryProcessor - the remote query

name - the name of the widget

skipAcls

public LivePivotWidget skipAcls()

Description copied from interface: LiveWidgetAclFilterable

This method is called in the case that ACLs should be skipped.

Specified by:

skipAcls in interface LiveWidgetAclFilterable<LivePivotWidget>

setName

public void setName(String name)

Description copied from interface: ContextAwareLiveWidget

Sets the name of the Live Widget.

Specified by:

setName in interface ContextAwareLiveWidget<LivePivotWidget>

Parameters:

name - the name of the Live Widget

getName

public String getName()

Description copied from interface: ContextAwareLiveWidget

Gets the name of the Live Widget.

Specified by:

getName in interface ContextAwareLiveWidget<LivePivotWidget>

Returns:

the name of the Live Widget

setProcessorConnection

public void setProcessorConnection(QueryProcessorConnection processorConnection)

Description copied from interface: ContextAwareLiveWidget

Sets the processor connection.

Specified by:

setProcessorConnection in interface ContextAwareLiveWidget<LivePivotWidget>

Parameters:

processorConnection - the processor connection

getProcessorConnection

public QueryProcessorConnection getProcessorConnection()

Description copied from interface: ContextAwareLiveWidget

gets the processor connection.

Specified by:

getProcessorConnection in interface ContextAwareLiveWidget<LivePivotWidget>

Returns:

the processor connection

setSessionId

public void setSessionId(int sessionId)

Description copied from interface: ContextAwareLiveWidget

Sets the session ID for console widgets.

Specified by:

setSessionId in interface ContextAwareLiveWidget<LivePivotWidget>

Parameters:

sessionId - the session ID

getSessionId

public int getSessionId()

Description copied from interface: ContextAwareLiveWidget

Gets the session ID for console widgets.

Specified by:

getSessionId in interface ContextAwareLiveWidget<LivePivotWidget>

Returns:

the session ID

deflate

public Inflatable<LivePivotWidget> deflate(ExportedObjectClient client)

Description copied from interface: Deflatable

Convert this object into an Inflatable suitable for serialization.

Specified by:

deflate in interface Deflatable<LivePivotWidget>

Parameters:

client - the ExportedObjectClient we are deflating for.

Returns:

an Inflatable for serializing to the client

getWidget

public static LiveWidget<LivePivotWidget> getWidget(Table tableToPivot,
 String[] rows,
 String columnTitleColumn,
 String unitColumn,
 LivePivotWidget.Aggregation aggregation,
 PivotOptions options)

getComponent

public JComponent getComponent(AsyncPanel dataPanel,
 String viewId,
 Object view,
 String title,
 Object irisWidgetSupportObject,
 com.fishlib.io.logger.Logger log)

Description copied from interface: LiveWidget

Gets the UI component.

Specified by:

getComponent in interface LiveWidget<LivePivotWidget>

Parameters:

dataPanel - data panel

viewId - view id

view - view

title - title

irisWidgetSupportObject - widget support object

log - log

Returns:

UI component