cern::laser::guiplatform::alarms::AlarmContainer Class Reference

Inheritance diagram for cern::laser::guiplatform::alarms::AlarmContainer:
Inheritance graph
[legend]
Collaboration diagram for cern::laser::guiplatform::alarms::AlarmContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void clearContainer ()
void attach (String key, AlarmListener listener)
void detach (String key)
void attach (String key, AlarmsNumberChangeListener listener)
void detachAlarmNumberChangeListener (String key)
void addAlarmSelectionOnExceptionListener (AlarmSelectionOnExceptionListener listener)
void removeAlarmSelectionOnExceptionListener (AlarmSelectionOnExceptionListener listener)
AlarmNodeManager getAlarmNodeManager (String listName)
void initContainer (Map _activeList, Configuration configuration) throws LaserConsoleException
void clearNodeManagers ()
void reloadContainer (Map _activeList, Configuration configuration) throws LaserConsoleException
void inhibit (AlarmBean[] inhibitedAlarm, Comment comment)
void uninhibit (AlarmBean[] uninhibitedAlarms)
void mask (AlarmBean[] maskedAlarm, Comment comment)
void unmask (AlarmBean[] unmaskedAlarms)
void highlightAndKlaxon (AlarmBean[] highlightedAndKlaxonedAlarms, Comment comment, int highlightOption)
void unhighlightAndKlaxon (AlarmBean[] unhighlightedAndKlaxonAlarms)
void highlight (AlarmBean[] highlighted, boolean highlight)
void acknowledge (AlarmBean[] acknowledged, boolean acknowledge, Comment comment)
void removeNewOrTerminatedAlarms (String whichAlarm)
void makeAlarmNotNew ()
void fireFontChanged ()
void clearInhibitList ()
void clearSearchList ()
void clearMaskList ()
void clearAutoHighlightedList ()
void onAlarm (Alarm _alarm)
void onException (LaserSelectionException laserSelectionException)
void setNewIndicator (AlarmBean[] notNew)
void setActiveListFont (boolean isBig)
boolean isSearchCancelled ()
void onSearchAlarm (cern.laser.client.data.Alarm alarm)
void onSearchException (LaserSearchException laserSearchException)
void searchFinished ()

Static Public Member Functions

static AlarmContainer getDefault ()

Private Member Functions

 AlarmContainer ()
CommentedAlarmMap getList (String key)
void processList (Map activeList, CommentedAlarmMap list)
void acknowledge (AlarmBean[] acknowledge, Comment comment)
void unacknowledge (AlarmBean[] unacknowledged)
void updateAlarmNumberChangeListeners (final int fromCounterType, final int toCounterType)
void updateAlarmOnInstantList (Alarm newInstant)
void updateAlarmOnActiveList (Alarm newAlarm)
void updateAlarmOnInhibitList (Alarm newAlarm)
void updateAlarmMaskedOnList (Alarm newAlarm)
void addAlarmToActiveList (Alarm alarm)
void updateAlarmNoChangeListeners (int whichListener)
boolean belongsToSelectedCategories (AlarmBean alarmBean, CategorySelection selectedCategories)

Private Attributes

Map observers = null
Map alarmNumberChangeObservers = null
List onExceptionListeners = null
Map nodeManagers = null
final Mutex lock = new Mutex()
CommentedAlarmMap activeList = null
CommentedAlarmMap inhibitList = null
CommentedAlarmMap maskedList = null
CommentedAlarmMap highlightedAndKlaxonList = null
CommentedAlarmMap instantList = null
CommentedAlarmMap highlightedList = null
CommentedAlarmMap acknowledgedList = null
CommentedAlarmMap notNewAlarmsList = null

Static Private Attributes

static Logger logger
static AlarmContainer INSTANCE = null

Detailed Description

This class store all alarm lists (active, inhibited, masked, etc This is in fact alarm manager. This class is used to creating AlarmNodeManager for each list

Author:
pawlowsk

Constructor & Destructor Documentation

cern::laser::guiplatform::alarms::AlarmContainer::AlarmContainer (  )  [inline, private]

Member Function Documentation

void cern::laser::guiplatform::alarms::AlarmContainer::acknowledge ( AlarmBean[]  acknowledge,
Comment  comment 
) [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::acknowledge ( AlarmBean[]  acknowledged,
boolean  acknowledge,
Comment  comment 
) [inline]
Parameters:
acknowledged 
acknowledge indicates whether alarms should be acknowledged or not
comment if alarm should be acknowledged, this is comment if acknowledge is false this can be null

References unacknowledge().

void cern::laser::guiplatform::alarms::AlarmContainer::addAlarmSelectionOnExceptionListener ( AlarmSelectionOnExceptionListener  listener  )  [inline]
Parameters:
(i. e. AlarmStaticInfoPanel)

References onExceptionListeners.

void cern::laser::guiplatform::alarms::AlarmContainer::addAlarmToActiveList ( Alarm  alarm  )  [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::attach ( String  key,
AlarmsNumberChangeListener  listener 
) [inline]

This method is used to add AlarmNubmerChangeListener (i. e. for adding AlarmStaticInfoPanel

Parameters:
key temporarily not used

References activeList, alarmNumberChangeObservers, inhibitList, maskedList, cern::laser::guiplatform::alarms::AlarmsNumberChangeListener::update(), and cern::laser::console::CommentedAlarmMap::values().

void cern::laser::guiplatform::alarms::AlarmContainer::attach ( String  key,
AlarmListener  listener 
) [inline]

This method is used for adding listeners (Alarm Listeners)

Parameters:
key list name "ACTIVE_LISTENER_KEY"
listener listener

References observers.

boolean cern::laser::guiplatform::alarms::AlarmContainer::belongsToSelectedCategories ( AlarmBean  alarmBean,
CategorySelection  selectedCategories 
) [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::clearAutoHighlightedList (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::clearContainer (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::clearInhibitList (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::clearMaskList (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::clearNodeManagers (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::clearSearchList (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::detach ( String  key  )  [inline]

This method is used for removing listener

Parameters:
key list name "ACTIVE_LISTENER_KEY"

References observers.

void cern::laser::guiplatform::alarms::AlarmContainer::detachAlarmNumberChangeListener ( String  key  )  [inline]

Method used for removing AlarmNumberChangeListener

Parameters:
key 

References alarmNumberChangeObservers.

void cern::laser::guiplatform::alarms::AlarmContainer::fireFontChanged (  )  [inline]
AlarmNodeManager cern::laser::guiplatform::alarms::AlarmContainer::getAlarmNodeManager ( String  listName  )  [inline]
static AlarmContainer cern::laser::guiplatform::alarms::AlarmContainer::getDefault (  )  [inline, static]

This method gives default (and only one) AlarmContainer

Returns:
alarmConstainer

References AlarmContainer(), and INSTANCE.

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::getList ( String  key  )  [inline, private]

This method returns apropriate list

Parameters:
key this should be one of: Constants.ACTIVE_LISTENER_KEY, Constants.INHIBIT_LISTENER_KEY,
Returns:
list

References activeList, highlightedAndKlaxonList, inhibitList, instantList, and maskedList.

Referenced by highlightAndKlaxon(), and mask().

void cern::laser::guiplatform::alarms::AlarmContainer::highlight ( AlarmBean[]  highlighted,
boolean  highlight 
) [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::highlightAndKlaxon ( AlarmBean[]  highlightedAndKlaxonedAlarms,
Comment  comment,
int  highlightOption 
) [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::inhibit ( AlarmBean[]  inhibitedAlarm,
Comment  comment 
) [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::initContainer ( Map  _activeList,
Configuration  configuration 
) throws LaserConsoleException [inline]
Parameters:
key 
manager This method initializes alarm container, what means: initialize active list, (all list in general) as well as change configuration according to active list
activeList Map with Alarm object
configuration Configuration, which should be used to initialize alarm container

References acknowledgedList, activeList, alarmNumberChangeObservers, belongsToSelectedCategories(), cern::laser::console::CommentedAlarmMap::containsKey(), cern::laser::console::CommentedAlarmMap::get(), cern::laser::console::CommentedAlarm::getAlarm(), cern::laser::guiplatform::alarms::AlarmBean::getAlarmId(), cern::laser::client::data::Alarm::getAlarmId(), cern::laser::guiplatform::alarms::AlarmBean::getName(), highlightedAndKlaxonList, highlightedList, inhibitList, cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeAcknowledged, cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeActive, cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeHighlightedAndKlaxon, cern::laser::guiplatform::alarms::AlarmBean::isNew, cern::laser::guiplatform::alarms::AlarmBean::isOnHighlightedList, logger, maskedList, nodeManagers, notNewAlarmsList, processList(), cern::laser::guiplatform::alarms::AlarmNodeManager::programmagbleInitManager(), cern::laser::console::CommentedAlarmMap::put(), cern::laser::guiplatform::alarms::AlarmBean::registerPropertyChangeListener(), cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeAcknowledged(), cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeHighlighted(), cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeHighlightedAndKlaxon(), cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeInhibited(), cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeMasked(), cern::laser::guiplatform::alarms::AlarmBean::setIsNew(), cern::laser::guiplatform::alarms::AlarmBean::setIsOnHighlightedList(), cern::laser::console::CommentedAlarmMap::size(), cern::laser::guiplatform::alarms::AlarmsNumberChangeListener::update(), and cern::laser::console::CommentedAlarmMap::values().

boolean cern::laser::guiplatform::alarms::AlarmContainer::isSearchCancelled (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::makeAlarmNotNew (  )  [inline]

This method check all new alarm as not new

References getAlarmNodeManager(), and cern::laser::guiplatform::alarms::AlarmNodeManager::makeAlarmsNotNew().

void cern::laser::guiplatform::alarms::AlarmContainer::mask ( AlarmBean[]  maskedAlarm,
Comment  comment 
) [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::onAlarm ( Alarm  _alarm  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::onException ( LaserSelectionException  laserSelectionException  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::onSearchAlarm ( cern.laser.client.data.Alarm  alarm  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::onSearchException ( LaserSearchException  e  )  [inline]

Callback method. Called on communication problems

Parameters:
e the LaserSelectionException carrying the exception code

Implements cern::laser::client::services::selection::AlarmSearchListener.

void cern::laser::guiplatform::alarms::AlarmContainer::processList ( Map  activeList,
CommentedAlarmMap  list 
) [inline, private]

this method romoves alarms from activeList depending on list (inhibit, mask)

Parameters:
activeList - Map which contains Alarm object, create as a result of AlarmSelectionHandler.select(Selection, AlarmSelectionListener)
list - one of the inhibit, or mask list

References cern::laser::client::data::Alarm::getAlarmId(), logger, and cern::laser::console::CommentedAlarmMap::values().

Referenced by initContainer(), and reloadContainer().

void cern::laser::guiplatform::alarms::AlarmContainer::reloadContainer ( Map  _activeList,
Configuration  configuration 
) throws LaserConsoleException [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::removeAlarmSelectionOnExceptionListener ( AlarmSelectionOnExceptionListener  listener  )  [inline]

References onExceptionListeners.

void cern::laser::guiplatform::alarms::AlarmContainer::removeNewOrTerminatedAlarms ( String  whichAlarm  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::searchFinished (  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::setActiveListFont ( boolean  isBig  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::setNewIndicator ( AlarmBean[]  notNew  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::unacknowledge ( AlarmBean[]  unacknowledged  )  [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::unhighlightAndKlaxon ( AlarmBean[]  unhighlightedAndKlaxonAlarms  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::uninhibit ( AlarmBean[]  uninhibitedAlarms  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::unmask ( AlarmBean[]  unmaskedAlarms  )  [inline]
void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmMaskedOnList ( Alarm  newAlarm  )  [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmNoChangeListeners ( int  whichListener  )  [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmNumberChangeListeners ( final int  fromCounterType,
final int  toCounterType 
) [inline, private]

Move alarm numbres from one label to other. This method substracts 1 from fromCounterType and adds 1 to toCounterType

Parameters:
fromCounterType 
toCounterType // synchronized here should be tested

References alarmNumberChangeObservers, and cern::laser::guiplatform::alarms::AlarmsNumberChangeListener::moveAlarmNumber().

Referenced by clearInhibitList(), clearMaskList(), inhibit(), and mask().

void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmOnActiveList ( Alarm  newAlarm  )  [inline, private]
void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmOnInhibitList ( Alarm  newAlarm  )  [inline, private]

after last discusion do nothing

Referenced by onAlarm().

void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmOnInstantList ( Alarm  newInstant  )  [inline, private]

Member Data Documentation

instance

Referenced by clearContainer(), and getDefault().

final Mutex cern::laser::guiplatform::alarms::AlarmContainer::lock = new Mutex() [private]

alarmNanagers AlarmNodeManagersImpl objects

Referenced by AlarmContainer(), clearContainer(), clearNodeManagers(), fireFontChanged(), getAlarmNodeManager(), and initContainer().

onExcetpion listeners (i.e. AlarmStatisticInfoPanel ) this map keps AlarmSelectionOnExceptionListener objects

Referenced by addAlarmSelectionOnExceptionListener(), AlarmContainer(), clearContainer(), onException(), and removeAlarmSelectionOnExceptionListener().


The documentation for this class was generated from the following file:

Generated by  doxygen 1.6.2