alma.acsplugins.alarmsystem.gui.table

Class AlarmsReductionContainer

java.lang.Object

alma.acsplugins.alarmsystem.gui.table.AlarmsContainer

alma.acsplugins.alarmsystem.gui.table.AlarmsReductionContainer

public class AlarmsReductionContainer
extends AlarmsContainer

Extends AlarmsContainer to cope with reduced alarms.

Methods of this class ensure that the model is changed from inside the swing EDT.
Methods that queries the model instead are not forced to be executed inside the EDT and immediately return the requested value (i.e. the caller must ensure to query from inside the EDT).

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/interfaces inherited from class alma.acsplugins.alarmsystem.gui.table.AlarmsContainer

AlarmsContainer.AlarmContainerException

Constructor Summary

Constructors

Constructor and Description
AlarmsReductionContainer(int max) Constructor

Method Summary

Modifier and Type	Method and Description
void	add(AlarmTableEntry entry) Add an entry (i.e a alarm) in the collection.
void	clear() Remove all the elements in the container
AlarmTableEntry	get(int pos, boolean reduced) Return the entry in the given position
AlarmCategoryClient	getCategoryClient()
int	hasNotAckAlarms(boolean reduced) Check if the container has alarm not yet acknowledged.
void	remove(AlarmTableEntry alarm) Remove the entry for the passed alarm
AlarmTableEntry	removeOldest() Remove the oldest entry in the container
void	replace(AlarmTableEntry newAlarm) Replace the alarm in a row with passed one.
void	setCategoryClient(AlarmCategoryClient client) Set the CategoryClient
int	size(boolean reduced) Return the number of alarms in the container depending if the reduction rules are applied or not

Methods inherited from class alma.acsplugins.alarmsystem.gui.table.AlarmsContainer

contains, get, get, hasNotAckAlarms, removeInactiveAlarms, size

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmsReductionContainer

public AlarmsReductionContainer(int max)

Constructor

Parameters:

max -

See Also:

AlarmsContainer}

Method Detail

size

public int size(boolean reduced)

Return the number of alarms in the container depending if the reduction rules are applied or not

Parameters:

true - if the reduction rules are applied

Returns:

The number of alarms in the container

add

public 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.

Overrides:

add in class AlarmsContainer

Parameters:

entry - The not null entry to add

Throws:

AlarmsContainer.AlarmContainerException

setCategoryClient

public void setCategoryClient(AlarmCategoryClient client)

Set the CategoryClient

Parameters:

client - The CategoryCLient; it can be null.

get

public AlarmTableEntry get(int pos,
                           boolean reduced)

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

clear

public void clear()

Remove all the elements in the container

Overrides:

clear in class AlarmsContainer

remove

public void remove(AlarmTableEntry alarm)
            throws AlarmsContainer.AlarmContainerException

Remove the entry for the passed alarm

Overrides:

remove in class AlarmsContainer

Parameters:

alarm - The alarm whose entry must be removed

Throws:

AlarmContainerException - If the alarm is not in the container

AlarmsContainer.AlarmContainerException

removeOldest

public AlarmTableEntry removeOldest()
                             throws AlarmsContainer.AlarmContainerException

Remove the oldest entry in the container

Overrides:

removeOldest in class AlarmsContainer

Returns:

The removed item

Throws:

AlarmContainerException - If the container is empty

AlarmsContainer.AlarmContainerException

replace

public 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.

Overrides:

replace in class AlarmsContainer

Parameters:

newAlarm - The not null new alarm

Throws:

AlarmContainerException - if the entry is not in the container

AlarmsContainer.AlarmContainerException

getCategoryClient

public AlarmCategoryClient getCategoryClient()

Returns:

the categoryClient

hasNotAckAlarms

public int hasNotAckAlarms(boolean reduced)
                    throws AlarmsContainer.AlarmContainerException

Check if the container has alarm not yet acknowledged.

if there are active 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.

Returns:

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

Throws:

AlarmsContainer.AlarmContainerException

See Also:

AlarmContainer#hasNotAckAlarms()