Package com.illumon.iris.console.events.treetable

Class IrisTreeTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

com.illumon.iris.gui.table.IrisTableModel

com.illumon.iris.console.db.BaseDBTableModel

com.illumon.iris.console.events.treetable.IrisTreeTableModel

All Implemented Interfaces:

DBTableFetcher, LayoutHintingModel, TableFormatProvider, ViewportAdjuster, AbstractDataTableModel, AutoFilterModel, FilteredModel, MultiModelTable, QuickFilterable, SortableModel, ToolTipGeneratingTableModel, UpdateListener, Workspace, AdjustmentListener, ComponentListener, Serializable, EventListener, TableModel

public class IrisTreeTableModel
extends BaseDBTableModel
implements ViewportAdjuster, AbstractDataTableModel, AdjustmentListener, ComponentListener, MultiModelTable, FilteredModel, SortableModel, TableFormatProvider, Workspace, QuickFilterable, LayoutHintingModel, ToolTipGeneratingTableModel, AutoFilterModel, DBTableFetcher

A TableModel that supports the display of tables created via Table.treeTable(String, String) or Table.rollup(ComboAggregateFactory, Collection). The model supports expanding and contracting rows within the tree.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IrisTreeTableModel.RowProperties
static enum	IrisTreeTableModel.RowState

Nested classes/interfaces inherited from interface com.illumon.iris.gui.table.AutoFilterModel

AutoFilterModel.AutoFilterListener, AutoFilterModel.AutoFilterRequestHandler

Nested classes/interfaces inherited from interface com.illumon.iris.gui.table.SortableModel

SortableModel.SortingDirective

Nested classes/interfaces inherited from interface com.illumon.iris.console.db.TableFormatProvider

TableFormatProvider.FormatType

Nested classes/interfaces inherited from interface com.illumon.iris.gui.table.ToolTipGeneratingTableModel

ToolTipGeneratingTableModel.GeneratedToolTip

Field Summary

Fields inherited from class com.illumon.iris.gui.table.IrisTableModel

columnSet_, nonViewColumnSet_

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Fields inherited from interface com.illumon.iris.gui.table.QuickFilterable

DEFAULT_MAX_QUICKFILTER_LENGTH

Constructor Summary

Constructors

Constructor	Description
IrisTreeTableModel(com.fishlib.io.logger.Logger log, String name, Table table)

Method Summary

Modifier and Type	Method	Description
void	adjustmentValueChanged(AdjustmentEvent e)
boolean	areSelectedColumnsInViewport(BitSet columns)
boolean	areSelectedRowsInViewport()
void	cancelSorting()	Clear sorting on all columns.
void	closeViewPort()	Close the existing viewport and clean up all table resources.
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
void	computeNewViewport(boolean forceUpdate)	Compute a new viewport.
void	contractNode(int row)	Request contraction for a particular row.
void	disconnectViewport()	Disconnect the current adjuster from the viewport, but do not clean up table resources
void	expandNode(int row)	Request expansion for a particular row.
void	filterChanged()	Notify the implementation that the set of underlying filters have changed.
ToolTipGeneratingTableModel.GeneratedToolTip	generateToolTip(int col, GuiColumn column)
String	getCellFormat(String columnName, int row, TableFormatProvider.FormatType type)
long	getColumnColor(String columnName, int row)
Object	getData(GuiColumn column, int row)
FilterStrategyImpl	getFilterStrategy()	Get the FilterStrategyImpl in use.
Icon	getHeaderRendererIcon(int columnIndex, int size)	Get the sort icon for the specified column and size.
HierarchicalTableInfo	getHierarchicalTableInfo()
int	getInitialFetchSize(String column)	Get the number of unique values to initially fetch for the specified column.
LayoutHintBuilder	getLayoutHints()
TableModel	getModel()	return the single child model, or null if none
<T extends TableModel> T	getModel(Class<T> modelType)	return a model of type modelType, or null if none
TableModel	getOriginalModel()
int[]	getOriginalRowIndices(int[] selectedRows)
int[]	getOriginalRowIndices(int[] selectedRows, boolean sorted)
String	getQuickFilter()	Get the current quick filter string
QuickFilterMode	getQuickFilterMode()	Get the current quick filter mode.
com.fishlib.dataobjects.WAbstractDataObject	getRow(int index)
long	getRowColor(int row)
int	getRowCount()
IrisTreeTableModel.RowProperties	getRowProperties(int row)	Get all of the properties for a row in one synchronized step.
org.jdom2.Element[]	getSavedStrategies()	Get all of the saved strategy workspace Elements
Set<String>	getSortableColumns()	Get the set of sortable columns.
SortableModel.SortingDirective	getSortingDirective(int columnIndex)	Get the sorting status of a single column.
Table	getTable()
UnrolledModelInfo	getUnrolledModel()	Gets the unrolled version of this table model.
Object	getValueAt(int rowIndex, int columnIndex)
org.jdom2.Element	getWorkspaceInfo()	Serialize the class into an element to be stored in the workspace
boolean	hasCellFormat(String columnName, TableFormatProvider.FormatType type)
boolean	hasColumnColor(String columnName)
boolean	hasRowColor(String columnName)
boolean	hasShowStatistics()
void	headerClicked(MouseEvent e)	Called when sorting should be changed based on a header click.
boolean	isFilterable(String column)	Check if the specified column is filterable.
boolean	isFilteringOn()	Check if the model is currently being filtered.
boolean	isSorting()	determine whether there are any sorting directives - similar to empty()
void	markColumnColorUnchanged(String columnName)
void	removeStrategy(String name)	Remove the globally saved filter of the specified name.
AutoFilterModel.AutoFilterRequestHandler	requestAutoFilterData(String columnName, int maxUniqueValues, AutoFilterModel.AutoFilterListener listener)	Requests auto filter data for a given column name.
AutoFilterModel.AutoFilterRequestHandler	requestMoreAutoFilterData(String columnName, AutoFilterModel.AutoFilterListener listener)	Requests more data for the given column.
void	saveStrategy(String name)	Save the current set of filters to the global set of filters by name.
void	setEmbeddedDbConsole(EmbeddedDbConsole console)	Set the EmbeddedDBConsole for issuing queries, if available.
void	setFreezeTable(IrisTable freezeTable)
void	setPersistentQueryClient(PersistentQueryClient client)	Set the PQ client to issue remote queries to.
void	setQuickFilter(String filter, QuickFilterMode mode)	Set the quick filter to apply.
void	setScrollPane(JScrollPane pane)	Set the scroll pane to listen to events from.
void	setSortingStatus(int columnIndex, int status, boolean isAbsolute, boolean clearSorting)	Set the sorting status of a single column.
void	setToolTipDialog(int col, GuiColumn column, JDialog dialog, JLabel label)
void	setTreeTable(IrisTable treeTable)
void	setUnrolledModel(UnrolledModelInfo unrolledModelInfo)	Sets the table model that was used to create this model via a rollup.
void	setView(IrisView view)	Set the IrisView underneath which this adjuster resides.
void	setWorkspaceInfo(org.jdom2.Element workspaceInfo)	Restore the class to the state defined by the data persisted in workspaceInfo
void	showStatistics(JTable table, int col, GuiColumn column)
void	suspendViewport()	Suspend processing of events generated by the underlying model.
IrisTreeTableModel	updateTelemetryInfo(TelemetryLogger.TelemetryInfo telemetryInfo)
IrisTreeTableModel	updateTelemetryInfo(String tableName, long pqSerial, QueryProcessorConnection qpc)
boolean	wasColumnColorChanged(String columnName)

Methods inherited from class com.illumon.iris.console.db.BaseDBTableModel

columnSet, columnSet, columnSet, columnSet, columnSet, doneProcessing, generateThrowableHtmlMessage, getIrisTablePanel, getName, getViewportForTable, removeStatusMessage, setIrisTablePanel, setProcessingMessage, setStatusMessage, setStatusMessageButton, setTabColor, setWarningAndTableSize, showProcessingErrorPopup, showProcessingErrorPopup

Methods inherited from class com.illumon.iris.gui.table.IrisTableModel

dispose, getColumnClass, getColumnCount, getColumnIndex, getColumnName, getColumnSet, getNonViewColumnSet, getTableModelName, isStale, processUpdate, registerAsUpdateListener, setColumnSet

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener, setValueAt

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.gui.table.AbstractDataTableModel

getData

Methods inherited from interface com.illumon.iris.gui.table.AutoFilterModel

getColumnSet

Methods inherited from interface com.illumon.iris.gui.table.FilteredModel

getColumnSet

Methods inherited from interface com.illumon.iris.gui.table.QuickFilterable

getMaxQuickfilterLength

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnClass, getColumnCount, getColumnName, isCellEditable, removeTableModelListener, setValueAt

Methods inherited from interface com.illumon.iris.gui.workspace.Workspace

isGlobalSetting

Constructor Details

IrisTreeTableModel

public IrisTreeTableModel(com.fishlib.io.logger.Logger log,
 String name,
 Table table)

Method Details

areSelectedRowsInViewport

public boolean areSelectedRowsInViewport()

areSelectedColumnsInViewport

public boolean areSelectedColumnsInViewport(BitSet columns)

updateTelemetryInfo

public IrisTreeTableModel updateTelemetryInfo(@Nullable
 TelemetryLogger.TelemetryInfo telemetryInfo)

updateTelemetryInfo

public IrisTreeTableModel updateTelemetryInfo(@Nullable
 String tableName,
 long pqSerial,
 @Nullable
 QueryProcessorConnection qpc)

getLayoutHints

public LayoutHintBuilder getLayoutHints()

Specified by:

getLayoutHints in interface LayoutHintingModel

Returns:

A LayoutHintBuilder defining the layout hints for this model, or null if none were present.

setTreeTable

public void setTreeTable(IrisTable treeTable)

setFreezeTable

public void setFreezeTable(@Nullable
 IrisTable freezeTable)

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getValueAt

public Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

getData

public Object getData(GuiColumn column,
 int row)

Specified by:

getData in interface AbstractDataTableModel

getRowProperties

@NotNull
public IrisTreeTableModel.RowProperties getRowProperties(int row)

Get all of the properties for a row in one synchronized step.

Parameters:

row - The row to get.

Returns:

A IrisTreeTableModel.RowProperties object defining the row.

getRow

public com.fishlib.dataobjects.WAbstractDataObject getRow(int index)

Specified by:

getRow in interface AbstractDataTableModel

expandNode

public void expandNode(int row)

Request expansion for a particular row. This method has no effect if the row is already expanded. The expansion itself will occur on the server side and generate a new viewport.

Parameters:

row - The row to expand

contractNode

public void contractNode(int row)

Request contraction for a particular row. This method has no effect if the row is already contracted.

Parameters:

row - The row to contract.

computeNewViewport

public void computeNewViewport(boolean forceUpdate)

Description copied from interface: ViewportAdjuster

Compute a new viewport.

Specified by:

computeNewViewport in interface ViewportAdjuster

Parameters:

forceUpdate - force an update, even if no changes were detected.

closeViewPort

public void closeViewPort()

Description copied from interface: ViewportAdjuster

Close the existing viewport and clean up all table resources.

Specified by:

closeViewPort in interface ViewportAdjuster

disconnectViewport

public void disconnectViewport()

Description copied from interface: ViewportAdjuster

Disconnect the current adjuster from the viewport, but do not clean up table resources

Specified by:

disconnectViewport in interface ViewportAdjuster

suspendViewport

public void suspendViewport()

Description copied from interface: ViewportAdjuster

Suspend processing of events generated by the underlying model.

Specified by:

suspendViewport in interface ViewportAdjuster

setView

public void setView(IrisView view)

Description copied from interface: ViewportAdjuster

Set the IrisView underneath which this adjuster resides.

Specified by:

setView in interface ViewportAdjuster

Parameters:

view - the IrisView.

setPersistentQueryClient

public void setPersistentQueryClient(PersistentQueryClient client)

Description copied from interface: ViewportAdjuster

Set the PQ client to issue remote queries to.

Specified by:

setPersistentQueryClient in interface ViewportAdjuster

Parameters:

client - the PQ Client

setEmbeddedDbConsole

public void setEmbeddedDbConsole(EmbeddedDbConsole console)

Description copied from interface: ViewportAdjuster

Set the EmbeddedDBConsole for issuing queries, if available. Note that only ViewportAdjuster.setPersistentQueryClient(PersistentQueryClient) or this should be called, not both.

Specified by:

setEmbeddedDbConsole in interface ViewportAdjuster

Parameters:

console - the Console

setScrollPane

public void setScrollPane(JScrollPane pane)

Description copied from interface: ViewportAdjuster

Set the scroll pane to listen to events from.

Specified by:

setScrollPane in interface ViewportAdjuster

Parameters:

pane - The scrollpane

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

adjustmentValueChanged

public void adjustmentValueChanged(AdjustmentEvent e)

Specified by:

adjustmentValueChanged in interface AdjustmentListener

getModel

public <T extends TableModel> T getModel(Class<T> modelType)

Description copied from interface: MultiModelTable

return a model of type modelType, or null if none

Specified by:

getModel in interface MultiModelTable

getModel

public TableModel getModel()

Description copied from interface: MultiModelTable

return the single child model, or null if none

Specified by:

getModel in interface MultiModelTable

getOriginalModel

public TableModel getOriginalModel()

Specified by:

getOriginalModel in interface MultiModelTable

getOriginalRowIndices

public int[] getOriginalRowIndices(int[] selectedRows)

Specified by:

getOriginalRowIndices in interface MultiModelTable

getOriginalRowIndices

public int[] getOriginalRowIndices(int[] selectedRows,
 boolean sorted)

Specified by:

getOriginalRowIndices in interface MultiModelTable

filterChanged

public void filterChanged()

Description copied from interface: FilteredModel

Notify the implementation that the set of underlying filters have changed.

Specified by:

filterChanged in interface FilteredModel

getFilterStrategy

@NotNull
public FilterStrategyImpl getFilterStrategy()

Description copied from interface: FilteredModel

Get the FilterStrategyImpl in use.

Specified by:

getFilterStrategy in interface AutoFilterModel

Specified by:

getFilterStrategy in interface FilteredModel

Returns:

the FilterStrategy

getSavedStrategies

@NotNull
public org.jdom2.Element[] getSavedStrategies()

Description copied from interface: FilteredModel

Get all of the saved strategy workspace Elements

Specified by:

getSavedStrategies in interface FilteredModel

Returns:

an array of saved filter strategy elements.

saveStrategy

public void saveStrategy(String name)

Description copied from interface: FilteredModel

Save the current set of filters to the global set of filters by name.

Specified by:

saveStrategy in interface FilteredModel

Parameters:

name - the name of the filter

removeStrategy

public void removeStrategy(String name)

Description copied from interface: FilteredModel

Remove the globally saved filter of the specified name.

Specified by:

removeStrategy in interface FilteredModel

Parameters:

name - the name of the filter to remove

isFilteringOn

public boolean isFilteringOn()

Description copied from interface: FilteredModel

Check if the model is currently being filtered.

Specified by:

isFilteringOn in interface FilteredModel

Returns:

true if filters are currently applied

setQuickFilter

public void setQuickFilter(String filter,
 QuickFilterMode mode)

Description copied from interface: QuickFilterable

Set the quick filter to apply.

Specified by:

setQuickFilter in interface QuickFilterable

Parameters:

filter - the filter text

mode - the QuickFilterMode to apply with

getQuickFilter

public String getQuickFilter()

Description copied from interface: QuickFilterable

Get the current quick filter string

Specified by:

getQuickFilter in interface QuickFilterable

Returns:

the current filter

getQuickFilterMode

public QuickFilterMode getQuickFilterMode()

Description copied from interface: QuickFilterable

Get the current quick filter mode.

Specified by:

getQuickFilterMode in interface QuickFilterable

Returns:

the quickfilter mode

isFilterable

public boolean isFilterable(String column)

Description copied from interface: FilteredModel

Check if the specified column is filterable.

Specified by:

isFilterable in interface AutoFilterModel

Specified by:

isFilterable in interface FilteredModel

Parameters:

column - the column name.

Returns:

true if the column is filterable.

cancelSorting

public void cancelSorting()

Description copied from interface: SortableModel

Clear sorting on all columns.

Specified by:

cancelSorting in interface SortableModel

setSortingStatus

public void setSortingStatus(int columnIndex,
 int status,
 boolean isAbsolute,
 boolean clearSorting)

Description copied from interface: SortableModel

Set the sorting status of a single column. Adds to existing sort definition.

Specified by:

setSortingStatus in interface SortableModel

getSortingDirective

@NotNull
public SortableModel.SortingDirective getSortingDirective(int columnIndex)

Description copied from interface: SortableModel

Get the sorting status of a single column.

Specified by:

getSortingDirective in interface SortableModel

isSorting

public boolean isSorting()

Description copied from interface: SortableModel

determine whether there are any sorting directives - similar to empty()

Specified by:

isSorting in interface SortableModel

headerClicked

public void headerClicked(MouseEvent e)

Description copied from interface: SortableModel

Called when sorting should be changed based on a header click.

Specified by:

headerClicked in interface SortableModel

Parameters:

e - the driving MouseEvent

getHeaderRendererIcon

public Icon getHeaderRendererIcon(int columnIndex,
 int size)

Description copied from interface: SortableModel

Get the sort icon for the specified column and size. May return null, for no icon.

Specified by:

getHeaderRendererIcon in interface SortableModel

Parameters:

columnIndex - the column

size - the icon size

Returns:

an icon to render for sorting.

getSortableColumns

@NotNull
public Set<String> getSortableColumns()

Description copied from interface: SortableModel

Get the set of sortable columns.

Specified by:

getSortableColumns in interface SortableModel

Overrides:

getSortableColumns in class IrisTableModel

Returns:

the set of sortable columns

getColumnColor

public long getColumnColor(String columnName,
 int row)

Specified by:

getColumnColor in interface TableFormatProvider

getRowColor

public long getRowColor(int row)

Specified by:

getRowColor in interface TableFormatProvider

getCellFormat

public String getCellFormat(String columnName,
 int row,
 TableFormatProvider.FormatType type)

Specified by:

getCellFormat in interface TableFormatProvider

hasColumnColor

public boolean hasColumnColor(String columnName)

Specified by:

hasColumnColor in interface TableFormatProvider

hasRowColor

public boolean hasRowColor(String columnName)

Specified by:

hasRowColor in interface TableFormatProvider

hasCellFormat

public boolean hasCellFormat(String columnName,
 TableFormatProvider.FormatType type)

Specified by:

hasCellFormat in interface TableFormatProvider

wasColumnColorChanged

public boolean wasColumnColorChanged(String columnName)

Specified by:

wasColumnColorChanged in interface TableFormatProvider

markColumnColorUnchanged

public void markColumnColorUnchanged(String columnName)

Specified by:

markColumnColorUnchanged in interface TableFormatProvider

getWorkspaceInfo

public org.jdom2.Element getWorkspaceInfo()

Description copied from interface: Workspace

Serialize the class into an element to be stored in the workspace

Specified by:

getWorkspaceInfo in interface Workspace

Overrides:

getWorkspaceInfo in class IrisTableModel

Returns:

An Element containing the data to persist.

setWorkspaceInfo

public void setWorkspaceInfo(org.jdom2.Element workspaceInfo)

Description copied from interface: Workspace

Restore the class to the state defined by the data persisted in workspaceInfo

Specified by:

setWorkspaceInfo in interface Workspace

Overrides:

setWorkspaceInfo in class IrisTableModel

Parameters:

workspaceInfo - An Element containing the persisted state.

setUnrolledModel

public void setUnrolledModel(UnrolledModelInfo unrolledModelInfo)

Sets the table model that was used to create this model via a rollup.

Parameters:

unrolledModelInfo - the unrolled version of this model

getUnrolledModel

public UnrolledModelInfo getUnrolledModel()

Gets the unrolled version of this table model. Null if it was not create from another table model.

Returns:

the unrolled table model or null

generateToolTip

public ToolTipGeneratingTableModel.GeneratedToolTip generateToolTip(int col,
 GuiColumn column)

Specified by:

generateToolTip in interface ToolTipGeneratingTableModel

hasShowStatistics

public boolean hasShowStatistics()

Specified by:

hasShowStatistics in interface ToolTipGeneratingTableModel

showStatistics

public void showStatistics(JTable table,
 int col,
 GuiColumn column)

Specified by:

showStatistics in interface ToolTipGeneratingTableModel

setToolTipDialog

public void setToolTipDialog(int col,
 GuiColumn column,
 JDialog dialog,
 JLabel label)

Specified by:

setToolTipDialog in interface ToolTipGeneratingTableModel

requestAutoFilterData

public AutoFilterModel.AutoFilterRequestHandler requestAutoFilterData(String columnName,
 int maxUniqueValues,
 AutoFilterModel.AutoFilterListener listener)

Description copied from interface: AutoFilterModel

Requests auto filter data for a given column name.

Specified by:

requestAutoFilterData in interface AutoFilterModel

Parameters:

columnName - the name of the column

maxUniqueValues - the maximum number of unique values to return

listener - a listener for the data

Returns:

a handler for the request

requestMoreAutoFilterData

public AutoFilterModel.AutoFilterRequestHandler requestMoreAutoFilterData(String columnName,
 AutoFilterModel.AutoFilterListener listener)

Description copied from interface: AutoFilterModel

Requests more data for the given column.

Specified by:

requestMoreAutoFilterData in interface AutoFilterModel

Parameters:

columnName - the name of the column

listener - a listener for the data

Returns:

a handler for the request

getInitialFetchSize

public int getInitialFetchSize(String column)

Description copied from interface: AutoFilterModel

Get the number of unique values to initially fetch for the specified column.

Specified by:

getInitialFetchSize in interface AutoFilterModel

Parameters:

column - The column to get the fetch size for

Returns:

The number of unique values to fetch

getTable

public Table getTable()

Specified by:

getTable in interface DBTableFetcher

getHierarchicalTableInfo

public HierarchicalTableInfo getHierarchicalTableInfo()