alma.acsplugins.alarmsystem.gui.table

Class AlarmTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

alma.acsplugins.alarmsystem.gui.table.AlarmTableModel

All Implemented Interfaces:

AlarmSelectionListener, java.io.Serializable, java.lang.Runnable, javax.swing.table.TableModel

public class AlarmTableModel
extends javax.swing.table.AbstractTableModel
implements AlarmSelectionListener, java.lang.Runnable

The table model for the table alarms

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlarmTableModel.AlarmTableColumn The title of each column.
class	AlarmTableModel.Priority The content of the priority columns is composed of the label and a reference to the AlarmTableEntry needed to compare two entries and sort.
static class	AlarmTableModel.PriorityLabel The label of the priority column of the table

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ALARMS The max number of alarms in the table When the max has been reach, the oldest alarm is removed before adding a new one
static int	REFRESH_TIMEINTERVAL The time interval (seconds) between 2 updates of the content of the table

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
AlarmTableModel(javax.swing.JComponent owner, boolean reduce, boolean addInactiveAlarms, UndocAlarmTableModel undocModel) Constructor

Method Summary

Modifier and Type	Method and Description
void	acknowledge(AlarmTableEntry alarm) Acknowledge an alarm that in this version ends up to removing from the table
void	alarmSelected(int row) The user pressed one mouse button over a row
void	applyReductions(boolean reduce) Enable/disable the applying of reduction rules in the table.
void	autoAckAlarms(AlarmGUIType type) Auto-acknowledge the terminated alarms is priority is equal or lower then the passed priority.
void	clear() Clear the content of the model
void	close() Terminate the thread and free the resources.
AlarmTableEntry	getAlarmAt(int rowIndex) Return the alarm shown at the rowIndex row of the table.
java.util.concurrent.atomic.AtomicInteger	getAlarmCounter(AlarmGUIType type) Return the counter for the given alarm type
AlarmCategoryClient	getCategoryClient() Get the CategoryClient from the AlarmsContainer
java.lang.Object	getCellContent(int rowIndex, int columnIndex) Return the text to display in a cell as it is read by the alarm without any formatting (the table add some formatting for example the color)
java.lang.Class<?>	getColumnClass(int columnIndex) The model needs to know that class of the PRIORITY column in order to sort by priority (otherwise the table sorts for the displayed string).
int	getColumnCount()
java.lang.String	getColumnName(int col)
AlarmTableEntry	getRowAlarm(int row) Return the alarm whose content fills the given row
int	getRowCount()
AlarmTableEntry	getRowEntry(int row) Return the entry the given row
java.lang.Object	getValueAt(int rowIndex, int columnIndex)
int	hasNotAckAlarms() Check if the container has alarm not yet acknowledged.
boolean	isRowAlarmNew(int row)
void	onAlarm(Alarm alarm) Each received alarm is temporarily stored in the alarmsToAdd map so that if it appears more then once the last occurrence replaces the old one.
void	onException(LaserSelectionException e) Get exception from the client.
void	pause(boolean pause) Pause/un-pause the update of the table
void	removeInactiveAlarms(AlarmGUIType type) Remove all the inactive alarms of a given type delegating to the AlarmsContainer.
void	run() The thread refreshes the content of the table at a fixed rate.
void	setAutoAckLevel(Toolbar.ComboBoxValues lvl) Set the auto acknowledge level i.e.
void	setCategoryClient(AlarmCategoryClient client) Set the CategoryClient in the AlarmsContainer
void	setConnectionListener(ConnectionListener listener) Set the connection listener
void	start() Start the thread.

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

Field Detail

MAX_ALARMS

public static final int MAX_ALARMS

The max number of alarms in the table When the max has been reach, the oldest alarm is removed before adding a new one

See Also:

Constant Field Values

REFRESH_TIMEINTERVAL

public static final int REFRESH_TIMEINTERVAL

The time interval (seconds) between 2 updates of the content of the table

See Also:

Constant Field Values

Constructor Detail

AlarmTableModel

public AlarmTableModel(javax.swing.JComponent owner,
                       boolean reduce,
                       boolean addInactiveAlarms,
                       UndocAlarmTableModel undocModel)

Constructor

Parameters:

owner - The component that owns the table

reduce - true if the reduction rules must be applied

panel - The AlarmPanel

undocModel) - The model of the undocumented table

Method Detail

onAlarm

public void onAlarm(Alarm alarm)

Each received alarm is temporarily stored in the alarmsToAdd map so that if it appears more then once the last occurrence replaces the old one. The thread will get alarms from this map and flush them in the container to updated the table (@see run()).

Specified by:

onAlarm in interface AlarmSelectionListener

Parameters:

alarm - The alarm to add to the table.

See Also:

AlarmSelectionListener

acknowledge

public void acknowledge(AlarmTableEntry alarm)

Acknowledge an alarm that in this version ends up to removing from the table

Parameters:

alarm - The inactive alarm to acknowledge

onException

public void onException(LaserSelectionException e)

Get exception from the client. A message is notified to the listener or written in the standard error if the listener is null.

Specified by:

onException in interface AlarmSelectionListener

Parameters:

e - the LaserSelectionException carrying the exception code

See Also:

AlarmSelectionListener

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface javax.swing.table.TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface javax.swing.table.TableModel

getAlarmAt

public AlarmTableEntry getAlarmAt(int rowIndex)

Return the alarm shown at the rowIndex row of the table.

Parameters:

rowIndex - The index of the alarm in the model

Returns:

the alarm shown at the rowIndex row of the table

getCellContent

public java.lang.Object getCellContent(int rowIndex,
                                       int columnIndex)

Return the text to display in a cell as it is read by the alarm without any formatting (the table add some formatting for example the color)

Parameters:

rowIndex - The row of the cell

columnIndex - The col of the cell

Returns:

The string to display in the cell

setAutoAckLevel

public void setAutoAckLevel(Toolbar.ComboBoxValues lvl)

Set the auto acknowledge level i.e. All the inactive alarms having a level equal or lower the the passed level automatically disappear from the table (i.e. with no user intervention)

Parameters:

lvl - The new auto acknowledge level

getValueAt

public java.lang.Object getValueAt(int rowIndex,
                                   int columnIndex)

Specified by:

getValueAt in interface javax.swing.table.TableModel

See Also:

AbstractTableModel

getColumnName

public java.lang.String getColumnName(int col)

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class javax.swing.table.AbstractTableModel

getColumnClass

public java.lang.Class<?> getColumnClass(int columnIndex)

The model needs to know that class of the PRIORITY column in order to sort by priority (otherwise the table sorts for the displayed string).

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class javax.swing.table.AbstractTableModel

See Also:

AbstractTableModel.getColumnClass(int)

getRowAlarm

public AlarmTableEntry getRowAlarm(int row)

Return the alarm whose content fills the given row

Parameters:

row - The number of the row showing the alarm

Returns:

The alarm shown in the row

getRowEntry

public AlarmTableEntry getRowEntry(int row)

Return the entry the given row

Parameters:

row - The number of the row showing the alarm

Returns:

The entry

isRowAlarmNew

public boolean isRowAlarmNew(int row)

Parameters:

row - Return true if the alarm is new

getAlarmCounter

public java.util.concurrent.atomic.AtomicInteger getAlarmCounter(AlarmGUIType type)

Return the counter for the given alarm type

Parameters:

type - The type of the alarm

Returns:

The counter for the alarm type

alarmSelected

public void alarmSelected(int row)

The user pressed one mouse button over a row

removeInactiveAlarms

public void removeInactiveAlarms(AlarmGUIType type)

Remove all the inactive alarms of a given type delegating to the AlarmsContainer. If the type is INACTIVE all inactive alarms are deleted regardless of their priority

Parameters:

type - The type of the inactive alarms

See Also:

AlarmsContainer.removeInactiveAlarms

autoAckAlarms

public void autoAckAlarms(AlarmGUIType type)

Auto-acknowledge the terminated alarms is priority is equal or lower then the passed priority.

This method delegates to removeInactiveAlarms(AlarmGUIType) but it is called for each priority equal or lower then the passed priority.

Parameters:

priority -

setConnectionListener

public void setConnectionListener(ConnectionListener listener)

Set the connection listener

Parameters:

listener - The listener

applyReductions

public void applyReductions(boolean reduce)

Enable/disable the applying of reduction rules in the table.

by applying reduction rules, the table will not show reduced alarms.

Parameters:

reduce - if true apply the reduction rules hiding reduced alarms; if reduce is false all the alarms are shown by the table independently of the reduction rules

setCategoryClient

public void setCategoryClient(AlarmCategoryClient client)

Set the CategoryClient in the AlarmsContainer

Parameters:

client - The CategoryCLient; it can be null.

getCategoryClient

public AlarmCategoryClient getCategoryClient()

Get the CategoryClient from the AlarmsContainer

Parameters:

client - The CategoryCLient; it can be null.

clear

public void clear()

Clear the content of the model

pause

public void pause(boolean pause)

Pause/un-pause the update of the table

If it is paused then the alarms received in onAlarm are not added in the model but queued until the application is unpaused.

Parameters:

pause - if true no new alarms are added in the table

run

public void run()

The thread refreshes the content of the table at a fixed rate. It is the executor that schedules the execution of this thread at REFRESH_TIMEINTERVAL (2) msecs.

The thread flushes all the alarms from the alarmsToAdd vector in the table before firing the event to refresh the content of the table.

Specified by:

run in interface java.lang.Runnable

start

public void start()

Start the thread.

close

public void close()

Terminate the thread and free the resources.

hasNotAckAlarms

public int hasNotAckAlarms()

Check if the container has alarm not yet acknowledged.

Returns:

-1 if there are not alarm to acknowledge; the highest priority of the alarm to acknowledge

See Also:

AlarmsContainer.hasNotAckAlarms()