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

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

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

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

Logger logger
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]
 

Creates a new instance of AlarmContainer


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

void cern::laser::guiplatform::alarms::AlarmContainer::addAlarmSelectionOnExceptionListener AlarmSelectionOnExceptionListener  listener  )  [inline]
 

Parameters:
(i. e. AlarmStaticInfoPanel)

void cern::laser::guiplatform::alarms::AlarmContainer::addAlarmToActiveList Alarm  alarm  )  [inline, private]
 

This method adds alarm to actvie list and updates all observers

Parameters:
alarm 

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

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

boolean cern::laser::guiplatform::alarms::AlarmContainer::belongsToSelectedCategories AlarmBean  alarmBean,
CategorySelection  selectedCategories
[inline, private]
 

void cern::laser::guiplatform::alarms::AlarmContainer::clearAutoHighlightedList  )  [inline]
 

This method removes all alarm from "autohighilighted" list In order to remove alarms from autoKlaxon list use clearAutoKlaxonList (implement this method)

void cern::laser::guiplatform::alarms::AlarmContainer::clearContainer  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmContainer::clearInhibitList  )  [inline]
 

This method removes all alarms from inhibit list and adds to active list and updates all listeners

void cern::laser::guiplatform::alarms::AlarmContainer::clearMaskList  )  [inline]
 

This method removes all alarms from mask list and adds to active list and updates all listeners

void cern::laser::guiplatform::alarms::AlarmContainer::clearNodeManagers  )  [inline]
 

this method clears all node mangers and all lists

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"

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

Method used for removing AlarmNumberChangeListener

Parameters:
key 

void cern::laser::guiplatform::alarms::AlarmContainer::fireFontChanged  )  [inline]
 

AlarmNodeManager cern::laser::guiplatform::alarms::AlarmContainer::getAlarmNodeManager String  listName  )  [inline]
 

AlarmNodeManager factory

Parameters:
listName this should be one of: Constants.ACTIVE_LISTENER_KEY, Constants.INHIBIT_LISTENER_KEY,
Exceptions:
IllegalArgumentException if list name is not one of Constants.ACTIVE_LISTENER_KEY, Constants.INHIBIT_LISTENER_KEY, etc

AlarmContainer cern::laser::guiplatform::alarms::AlarmContainer::getDefault  )  [inline, static]
 

This method gives default (and only one) AlarmContainer

Returns:
alarmConstainer

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

void cern::laser::guiplatform::alarms::AlarmContainer::highlight AlarmBean[]  highlighted,
boolean  highlight
[inline]
 

this methods highlights alarm (not auto highlight)

Parameters:
highlighted 
highlight indicates whether alarms should be highlighted or not

void cern::laser::guiplatform::alarms::AlarmContainer::highlightAndKlaxon AlarmBean[]  highlightedAndKlaxonedAlarms,
Comment  comment,
int  highlightOption
[inline]
 

this method masks set of alarms, when user selects set of alarm and then chooses MaskAction

Parameters:
maskedAlarm alarms to be masked
comment commnet which will be applied to all alarms from maskedAlarm
highlightOption one of AlarmConstants.HIGHLIGHTED_ONLY, AlarmConstants.KLAXON_ONLY, AlarmConstants.HIGHLIGHTED_AND_KLAXON

void cern::laser::guiplatform::alarms::AlarmContainer::inhibit AlarmBean[]  inhibitedAlarm,
Comment  comment
[inline]
 

this method inhibits set of alarms, when user selects set of alarm and then chooses InhibitAction

Remove that alarms from active list and node managers and add that alarms to inhibit list and node managers (nothing else)

Parameters:
inhibitedAlarm alarms to be inhibited
comment commnet which will be applied to all alarms from inhibitedAlarm

void cern::laser::guiplatform::alarms::AlarmContainer::initContainer Map  _activeList,
Configuration  configuration
throws LaserConsoleException [inline]
 

This method initializes alarm container, what means: initialize active list, (all list in general) as well as change configuration according to active list

Parameters:
activeList Map with Alarm object
configuration Configuration, which should be used to initialize alarm container

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

void cern::laser::guiplatform::alarms::AlarmContainer::mask AlarmBean[]  maskedAlarm,
Comment  comment
[inline]
 

this method masks set of alarms, when user selects set of alarm and then chooses MaskAction

Parameters:
maskedAlarm alarms to be masked
comment commnet which will be applied to all alarms from maskedAlarm

void cern::laser::guiplatform::alarms::AlarmContainer::onAlarm Alarm  _alarm  )  [inline]
 

this method will be invoked by business layer when on alarm arrives

Parameters:
alarm alarm from business layer

void cern::laser::guiplatform::alarms::AlarmContainer::onException LaserSelectionException  laserSelectionException  )  [inline]
 

callback method

void cern::laser::guiplatform::alarms::AlarmContainer::onSearchAlarm cern.laser.client.data.Alarm  alarm  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmContainer::onSearchException LaserSearchException  laserSearchException  )  [inline]
 

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

void cern::laser::guiplatform::alarms::AlarmContainer::reloadContainer Map  _activeList,
Configuration  configuration
throws LaserConsoleException [inline]
 

void cern::laser::guiplatform::alarms::AlarmContainer::removeAlarmSelectionOnExceptionListener AlarmSelectionOnExceptionListener  listener  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmContainer::removeNewOrTerminatedAlarms String  whichAlarm  )  [inline]
 

Removes all new alarms from active list (Remove all new indicators, or clear all terminated)

Parameters:
which alarm should be deleted ("NEW", "TERMINATE")

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]
 

this method removes node from autohighlihted list only

void cern::laser::guiplatform::alarms::AlarmContainer::uninhibit AlarmBean[]  uninhibitedAlarms  )  [inline]
 

this method uninhibits set of alarms, when user selects set of alarm and then chooses InhibitAction

Parameters:
inhibitedAlarm alarms to be inhibited

void cern::laser::guiplatform::alarms::AlarmContainer::unmask AlarmBean[]  unmaskedAlarms  )  [inline]
 

this method unmasks set of alarms, when user selects set of alarm and then chooses UnmaskAction

Parameters:
unmaskedAlarms alarms to be inhibited

void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmMaskedOnList Alarm  newAlarm  )  [inline, private]
 

void cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmNoChangeListeners int  whichListener  )  [inline, private]
 

Parameters:
whichListener one of: AlarmsNumberChangeListener.INHIBITED_ALARM_COUNTER AlarmsNumberChangeListener.MASKED_ALARM_COUNTER AlarmsNumberChangeListener.ACTIVE_ALARM_COUNTER, etc

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

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

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


Member Data Documentation

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::acknowledgedList = null [private]
 

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::activeList = null [private]
 

lists

Map cern::laser::guiplatform::alarms::AlarmContainer::alarmNumberChangeObservers = null [private]
 

AlarmNumberChangeListener observers

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::highlightedAndKlaxonList = null [private]
 

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::highlightedList = null [private]
 

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::inhibitList = null [private]
 

AlarmContainer cern::laser::guiplatform::alarms::AlarmContainer::INSTANCE = null [static, private]
 

instance

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::instantList = null [private]
 

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

mutex

Logger cern::laser::guiplatform::alarms::AlarmContainer::logger [static, private]
 

Initial value:

LogFactory.getLogger(AlarmContainer.class.getName())
logger

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::maskedList = null [private]
 

Map cern::laser::guiplatform::alarms::AlarmContainer::nodeManagers = null [private]
 

alarmNanagers AlarmNodeManagersImpl objects

CommentedAlarmMap cern::laser::guiplatform::alarms::AlarmContainer::notNewAlarmsList = null [private]
 

Map cern::laser::guiplatform::alarms::AlarmContainer::observers = null [private]
 

observers (AlarmListener)

List cern::laser::guiplatform::alarms::AlarmContainer::onExceptionListeners = null [private]
 

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


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