Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer Class Reference

Inheritance diagram for alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer:

Inheritance graph
[legend]
Collaboration diagram for alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AlarmsReductionContainer (int max)
synchronized int size (boolean reduced)
synchronized void add (AlarmTableEntry entry) throws AlarmContainerException
void setCategoryClient (CategoryClient client)
synchronized AlarmTableEntry get (int pos, boolean reduced)
synchronized void clear ()
synchronized void remove (Alarm alarm) throws AlarmContainerException
synchronized AlarmTableEntry removeOldest () throws AlarmContainerException
synchronized void replace (Alarm newAlarm) throws AlarmContainerException
CategoryClient getCategoryClient ()

Private Member Functions

void hideReducedChildren (AlarmTableEntry entry)
void showActiveChildren (Alarm alarm, int pos)

Private Attributes

final Vector< String > indexWithReduction = new Vector<String>()
CategoryClient categoryClient = null

Detailed Description

Extends AlarmsContainer for the reduced alarms.

Author:
acaproni


Constructor & Destructor Documentation

alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::AlarmsReductionContainer int  max  )  [inline]
 

Constructor

Parameters:
max 
See also:
AlarmsContainer


Member Function Documentation

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::add AlarmTableEntry  entry  )  throws AlarmContainerException [inline]
 

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:
entry The not null entry to add
Exceptions:
{@link AlarmContainerException} If the entry is already in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::clear  )  [inline]
 

Remove all the elements in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

synchronized AlarmTableEntry alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::get int  pos,
boolean  reduced
[inline]
 

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

CategoryClient alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::getCategoryClient  )  [inline]
 

Returns:
the categoryClient

void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hideReducedChildren AlarmTableEntry  entry  )  [inline, private]
 

Hide the active alarms of this entry.

Parameters:
entry The not null entry to hide active children

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::remove Alarm  alarm  )  throws AlarmContainerException [inline]
 

Remove the entry for the passed alarm

Parameters:
alarm The alarm whose entry must be removed
Exceptions:
AlarmContainerException If the alarm is not in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

synchronized AlarmTableEntry alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::removeOldest  )  throws AlarmContainerException [inline]
 

Remove the oldest entry in the container

Returns:
The removed item
Exceptions:
AlarmContainerException If the container is empty

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::replace Alarm  newAlarm  )  throws AlarmContainerException [inline]
 

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
Exceptions:
AlarmContainerException if the entry is not in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::setCategoryClient CategoryClient  client  )  [inline]
 

Set the CategoryClient

Parameters:
client The CategoryCLient; it can be null.

void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::showActiveChildren Alarm  alarm,
int  pos
[inline, private]
 

Show the active children of the passed alarms

Parameters:
alarm The alarm whose active children must be displayed
pos The position in the table where the active children must be shown

synchronized int alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::size boolean  reduced  )  [inline]
 

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

Parameters:
<code>true</code> if the reduction rules are applied
Returns:
The number of alarms in the container


Member Data Documentation

CategoryClient alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::categoryClient = null [private]
 

The CategoryClient to ask for parents/children while reducing alarms.

It can be null so needs to be checked before invoking methods.

final Vector<String> alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::indexWithReduction = new Vector<String>() [private]
 

The index when the reduction rules are in place

Each item in the vector represents the ID of the entry shown in a table row when the reduction rules are used.


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:00:37 2009 for ACS Java API by doxygen 1.3.8