alma.acsplugins.alarmsystem.gui.table

Class AlarmsContainer

java.lang.Object

alma.acsplugins.alarmsystem.gui.table.AlarmsContainer

Direct Known Subclasses:

AlarmsReductionContainer

public class AlarmsContainer
extends java.lang.Object

A container for the alarms as needed by the AlarmTableModel

It is composed of 2 collections:

1. the HashMap stores each entry accessed by its alarmID (the key)
2. the Vector of Strings used to remember the position of each alarm when the max number of alarms has been reached It also allows to access the alarms by row

Basically the array stores the alarmID of each row in the table. The content of the row i.e. the Alarm, is then obtained by the HashMap passing the alarmID.
In this way it is possible to get the entry of a row by getting the key from the Vector. And it is possible to get an alarm from the HashMap.

Synchronization is done by thread confinement (inside the EDT). Invocation of read only methods must be done inside the EDT.

Author:

acaproni

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AlarmsContainer.AlarmContainerException The exception generated by the Alarm Container

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlarmsContainer(int max) Build an AlarmContainer

Method Summary

Modifier and Type	Method and Description
protected void	add(AlarmTableEntry entry) Add an entry (i.e a alarm) in the collection.
protected void	clear() Remove all the elements in the container
boolean	contains(java.lang.String alarmID) Check if an alarm with the given ID is in the container
AlarmTableEntry	get(int pos) Return the entry in the given position
AlarmTableEntry	get(java.lang.String id) Return the entry with the given ID
protected int	hasNotAckAlarms() Check if the container has alarm not yet acknowledged.
protected void	remove(AlarmTableEntry entry) Remove the entry for the passed alarm
protected int	removeInactiveAlarms(AlarmGUIType type) Remove all the inactive alarms of a given type.
protected AlarmTableEntry	removeOldest() Remove the oldest entry in the container
protected void	replace(AlarmTableEntry newAlarm) Replace the alarm in a row with passed one.
int	size() Return the number of alarms in the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmsContainer

protected AlarmsContainer(int max)

Build an AlarmContainer

Parameters:

max - The max number of alarms to store in the container

panel - The AlarmPanel

Method Detail

size

public int size()

Return the number of alarms in the container.

Returns:

The number of alarms in the container

add

protected void add(AlarmTableEntry entry)
            throws AlarmsContainer.AlarmContainerException

Add an entry (i.e a alarm) in the collection.

If there is no room available in the container, an exception is thrown. Checking if there is enough room must be done by the caller.

Parameters:

alarm - The not null entry to add

Throws:

AlarmsContainer.AlarmContainerException

contains

public boolean contains(java.lang.String alarmID)

Check if an alarm with the given ID is in the container

Parameters:

alarmID - The ID of the alarm

Returns:

true if an entries for an alarm with the given ID exists in the container

get

public AlarmTableEntry get(int pos)

Return the entry in the given position

Parameters:

pos - The position of the alarm in the container

reduced - true if the alarms in the table are reduced

Returns:

The AlarmTableEntry in the given position

get

public AlarmTableEntry get(java.lang.String id)

Return the entry with the given ID

Parameters:

id - The not null ID of the alarm in the container

Returns:

The AlarmTableEntry with the given position nullif the container does not contain an entry for the given id

clear

protected void clear()

Remove all the elements in the container

removeOldest

protected AlarmTableEntry removeOldest()
                                throws AlarmsContainer.AlarmContainerException

Remove the oldest entry in the container

Returns:

The removed item

Throws:

AlarmsContainer.AlarmContainerException - If the container is empty

remove

protected void remove(AlarmTableEntry entry)
               throws AlarmsContainer.AlarmContainerException

Remove the entry for the passed alarm

Parameters:

entry - The alarm whose entry must be removed

Throws:

AlarmsContainer.AlarmContainerException - If the alarm is not in the container

removeInactiveAlarms

protected int removeInactiveAlarms(AlarmGUIType type)
                            throws AlarmsContainer.AlarmContainerException

Remove all the inactive alarms of a given type.

If the type is INACTIVE all inactive alarms are deleted regardless of their priority

Parameters:

type - The type of the inactive alarms

Returns:

The number of alarms removed

Throws:

AlarmsContainer.AlarmContainerException

replace

protected void replace(AlarmTableEntry newAlarm)
                throws AlarmsContainer.AlarmContainerException

Replace the alarm in a row with passed one.

The entry to replace the alarm is given by the alarm ID of the parameter.

Parameters:

newAlarm - The not null new alarm

Throws:

AlarmsContainer.AlarmContainerException - if the entry is not in the container

hasNotAckAlarms

protected int hasNotAckAlarms()
                       throws AlarmsContainer.AlarmContainerException

Check if the container has alarm not yet acknowledged.

If there are alarms to be acknowledged by the user, this method returns the highest of their priorities. Note that for alarm system the highest priority is 0 and lowest is 3.

Returns:

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

Throws:

AlarmsContainer.AlarmContainerException - in case of error getting the highest priority to ack