org.lsst.ccs.gconsole.plugins.monitor

Class MonitorTable

java.lang.Object

javax.swing.table.AbstractTableModel

org.lsst.ccs.gconsole.plugins.monitor.MonitorTable

All Implemented Interfaces:

Serializable, TableModel, Updatable

Direct Known Subclasses:

MeshTable, SectionedTable

public abstract class MonitorTable
extends AbstractTableModel
implements Updatable

Skeleton implementation of a table that displays monitored values, and its model.

Functionality:

• Data storage (ArrayList<ArrayList<MonitorCell>>) and simple implementation of TableModel.
• Implements Updatable. update(...) uses getCells(displayChannel, monitorField) to find affected cells, computes new FormattedValue for each of them (firing table model event if necessary), then fires CELLS_EVENT.
• Allows registration of a Listener that is notified of CELLS_EVENT or TABLE_EVENT.
• Provides customized JTable (rendering, mouse clicks, etc.)
• Utility for trimming absent fields.
• DEFAULT_FORMAT, DEFAULT_FIELDS, DEFAULT_COMPACT_FIELDS.

Author:

onoprien

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitorTable.Event
static interface	MonitorTable.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<ArrayList<MonitorCell>>	cells
protected MonitorTable.Event	CELLS_EVENT
static List<MonitorField>	DEFAULT_COMPACT_FIELDS Default list of fields to be displayed by monitoring tables in compact mode.
static List<MonitorField>	DEFAULT_FIELDS Default list of fields to be displayed by monitoring tables in full mode.
static MonitorFormat	DEFAULT_FORMAT Stateless default MonitorFormat instance.
protected MonitorFormat	format
protected boolean	limitMaxWidth
protected MonitorTable.Listener	listener
protected int	nColumns
protected int	nRows
protected MonitorTable.Event	TABLE_EVENT

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MonitorTable() Empty default constructor.
protected	MonitorTable(MonitorCell[][] cells) Constructs the table with the specified content.

Method Summary

Modifier and Type	Method and Description
void	destroy() Called when the table is discarded.
static void	edit(Component parent, org.lsst.ccs.bus.data.ConfigurationParameterInfo conf, MonitorField field, AgentChannel channel)
protected void	fireChangeEvent(MonitorTable.Event.Reason reason)
protected void	fireChangeEvent(MonitorTable.Event event)
protected List<int[]>	getCells(DisplayChannel item, MonitorField field) Returns indices of all cells whose content is affected by the specified item and field.
int	getColumnCount()
int	getRowCount()
JTable	getTable()
FormattedValue	getValueAt(int row, int column)
protected JTable	makeTable()
void	restore(Serializable storageBean) Restores this table to the state described by the provided object, to the extent possible.
Serializable	save() Returns JavaBean that contains data required to restore this table to its current state.
void	setFormat(MonitorFormat format) Sets the formatter to be used by this table.
void	setLimitMaxWidth(boolean limitMaxWidth) Sets limitMaxWidth property.
void	setListener(MonitorTable.Listener listener)
boolean	showHeader()
protected void	tableMouseClicked(MouseEvent evt)
static List<MonitorField>	trimAbsentFields(List<MonitorField> fields, Collection<DisplayChannel> channels, Collection<MonitorField> exclude)
void	update(DisplayChannel channelHandle) Updates this component.
void	update(DisplayChannel item, List<MonitorField> fields) Updates this component.

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getColumnClass, getColumnName, 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 org.lsst.ccs.gconsole.plugins.monitor.Updatable

getAffectedFields

Field Detail

DEFAULT_FORMAT

public static final MonitorFormat DEFAULT_FORMAT

Stateless default MonitorFormat instance.

DEFAULT_FIELDS

public static final List<MonitorField> DEFAULT_FIELDS

Default list of fields to be displayed by monitoring tables in full mode.

DEFAULT_COMPACT_FIELDS

public static final List<MonitorField> DEFAULT_COMPACT_FIELDS

Default list of fields to be displayed by monitoring tables in compact mode.

nRows

protected int nRows

nColumns

protected int nColumns

cells

protected ArrayList<ArrayList<MonitorCell>> cells

format

protected MonitorFormat format

limitMaxWidth

protected boolean limitMaxWidth

listener

protected MonitorTable.Listener listener

CELLS_EVENT

protected final MonitorTable.Event CELLS_EVENT

TABLE_EVENT

protected final MonitorTable.Event TABLE_EVENT

Constructor Detail

MonitorTable

protected MonitorTable()

Empty default constructor.

MonitorTable

protected MonitorTable(MonitorCell[][] cells)

Constructs the table with the specified content.

Method Detail

destroy

public void destroy()

Called when the table is discarded.

setFormat

public void setFormat(MonitorFormat format)

Sets the formatter to be used by this table.

Parameters:

format - Formatter.

setLimitMaxWidth

public void setLimitMaxWidth(boolean limitMaxWidth)

Sets limitMaxWidth property.

Parameters:

limitMaxWidth - If true, the table max width will be limited to its preferred width.

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

getValueAt

public FormattedValue getValueAt(int row,
                                 int column)

Specified by:

getValueAt in interface TableModel

update

public void update(DisplayChannel item,
                   List<MonitorField> fields)

Description copied from interface: Updatable

Updates this component. The default implementation forwards the call to #update(ChannelHandle).

Specified by:

update in interface Updatable

Parameters:

item - Handle of the data channel that might have changed.

fields - List of fields that might need updating.

update

public void update(DisplayChannel channelHandle)

Description copied from interface: Updatable

Updates this component. The implementation should assume all fields might have changed.

Specified by:

update in interface Updatable

Parameters:

channelHandle - Handle of the data channel that might have changed.

getCells

protected List<int[]> getCells(DisplayChannel item,
                               MonitorField field)

Returns indices of all cells whose content is affected by the specified item and field. The implementation provided by this class is universal but very inefficient - subclasses handling specific types of tables are expected to override it.

Parameters:

item - DisplayChannel.

field - Field. If null, all cells affected by the specified item are included.

Returns:

List of cells.

setListener

public void setListener(MonitorTable.Listener listener)

fireChangeEvent

protected void fireChangeEvent(MonitorTable.Event.Reason reason)

fireChangeEvent

protected void fireChangeEvent(MonitorTable.Event event)

getTable

public JTable getTable()

makeTable

protected JTable makeTable()

tableMouseClicked

protected void tableMouseClicked(MouseEvent evt)

showHeader

public boolean showHeader()

trimAbsentFields

public static List<MonitorField> trimAbsentFields(List<MonitorField> fields,
                                                  Collection<DisplayChannel> channels,
                                                  Collection<MonitorField> exclude)

edit

public static void edit(Component parent,
                        org.lsst.ccs.bus.data.ConfigurationParameterInfo conf,
                        MonitorField field,
                        AgentChannel channel)

save

public Serializable save()

Returns JavaBean that contains data required to restore this table to its current state. The default implementation provided by this class returns null, subclasses should override if they need to support saving/restoring their state.

Returns:

JavaBean that contains data required to restore this table to its current state.

restore

public void restore(Serializable storageBean)

Restores this table to the state described by the provided object, to the extent possible. The default implementation provided by this class does nothing.

Parameters:

storageBean - JavaBean that contains data describing the state of this table.