Package com.illumon.iris.console.utils.oneclick

Class LiveOneClickTable

java.lang.Object

com.illumon.iris.console.utils.oneclick.LiveOneClickTable

All Implemented Interfaces:

Deflatable<LiveOneClickTable>, CloseableWidget, ContextAwareLiveWidget<LiveOneClickTable>, LiveWidget<LiveOneClickTable>, LiveWidgetVisibilityProvider, Serializable

@ScriptApi
public class LiveOneClickTable
extends Object
implements ContextAwareLiveWidget<LiveOneClickTable>, LiveWidgetVisibilityProvider, CloseableWidget, Serializable

A One Click Table displays an OneClickTablePanel which is blank until the user filters the table via a One Click.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
Inflatable<LiveOneClickTable>	deflate(ExportedObjectClient client)	Convert this object into an Inflatable suitable for serialization.
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.
String[]	getValidGroups()	Gets the valid groups for visibility of this widget.
void	onClose()
static LiveOneClickTable	oneClickTable(Table table, String oneClickColumn)	Creates a LiveOneClickTableSupplier.
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.
void	setValidGroups(String... validGroups)	Sets the valid groups for visibility of this widget.
void	setValidGroups(Collection<String> validGroups)	Sets the valid groups for visibility of this widget.

Methods inherited from class java.lang.Object

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

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

getComponent, updateTelemetryInfo

Method Details

oneClickTable

@ScriptApi public static LiveOneClickTable oneClickTable(Table table, String oneClickColumn)

Creates a LiveOneClickTableSupplier.

Parameters:

table - the table to one click

oneClickColumn - the column on which to listen for One Clicks

Returns:

a LiveOneClickTableSupplier

getValidGroups

@ScriptApi public String[] getValidGroups()

Gets the valid groups for visibility of this widget.

Specified by:

getValidGroups in interface LiveWidgetVisibilityProvider

Returns:

the valid groups, null if it has not been set

setValidGroups

@ScriptApi public void setValidGroups(String... validGroups)

Sets the valid groups for visibility of this widget.

Parameters:

validGroups - the valid groups

setValidGroups

@ScriptApi public void setValidGroups(Collection<String> validGroups)

Sets the valid groups for visibility of this widget.

Parameters:

validGroups - the valid groups

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<LiveOneClickTable>

Parameters:

dataPanel - data panel

viewId - view id

view - view

title - title

irisWidgetSupportObject - widget support object

log - log

Returns:

UI component

setName

public void setName(String name)

Description copied from interface: ContextAwareLiveWidget

Sets the name of the Live Widget.

Specified by:

setName in interface ContextAwareLiveWidget<LiveOneClickTable>

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<LiveOneClickTable>

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<LiveOneClickTable>

Parameters:

processorConnection - the processor connection

getProcessorConnection

public QueryProcessorConnection getProcessorConnection()

Description copied from interface: ContextAwareLiveWidget

gets the processor connection.

Specified by:

getProcessorConnection in interface ContextAwareLiveWidget<LiveOneClickTable>

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<LiveOneClickTable>

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<LiveOneClickTable>

Returns:

the session ID

onClose

public void onClose()

Specified by:

onClose in interface CloseableWidget

deflate

public Inflatable<LiveOneClickTable> deflate(ExportedObjectClient client)

Description copied from interface: Deflatable

Convert this object into an Inflatable suitable for serialization.

Specified by:

deflate in interface Deflatable<LiveOneClickTable>

Parameters:

client - the ExportedObjectClient we are deflating for.

Returns:

an Inflatable for serializing to the client