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

cern::laser::guiplatform::alarms::AlarmBean Class Reference

Inheritance diagram for cern::laser::guiplatform::alarms::AlarmBean:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 AlarmBean (CommentedAlarm commentedAlarm)
 AlarmBean ()
CommentedAlarm getCommentedAlarm ()
void setCommentedAlarm (CommentedAlarm newCommentedAlarm)
boolean isAlarmNodeActive ()
void setIsAlarmNodeActive ()
boolean isAlarmNodeInhibited ()
void setIsAlarmNodeInhibited (boolean flag)
boolean isAlarmNodeMasked ()
void setIsAlarmNodeMasked (boolean flag)
boolean isAlarmNodeHighlighted ()
void setIsAlarmNodeHighlighted (boolean flag)
boolean isAlarmNodeHighlightedAndKlaxon ()
void setIsAlarmNodeHighlightedAndKlaxon (boolean flag)
int getHighlightedOrKlaxon ()
void setHighlightedOrKlaxon (final int highlightedOrKlaxon)
void setIsAlarmNodeAcknowledged (boolean flag)
boolean isAlarmNodeAcknowledged ()
boolean isAlarmNodeInstant ()
void setIsAlarmNodeInstant (boolean flag)
boolean isOnHighlightedList ()
void setIsOnHighlightedList (boolean flag)
boolean isNew ()
void setIsNew (boolean flag)
void setInfoMode (boolean flag)
boolean infoMode ()
String getAlarmId ()
Integer getPriority ()
Collection getCategories ()
ResponsiblePerson getResponsiblePerson ()
Location getLocation ()
String getProblemDescription ()
Source getSource ()
String getSourceName ()
String getFaultFamily ()
String getFaultMember ()
Integer getFaultCode ()
String getTimestamp ()
String getSourceTimestamp ()
String getUserTimestamp ()
Timestamp getTimestampForSorting ()
String getSourceHostName ()
String getUserData ()
String getIdentifier ()
String getSystemName ()
boolean isActive ()
boolean getIsActive ()
boolean isMasked ()
boolean isNodeChild ()
boolean isNodeParent ()
boolean isNodeReduced ()
boolean isMultiplicityParent ()
boolean isMultiplicityChild ()
boolean isReduced ()
List getTimestamps ()
List getDynamicInfo (boolean withEmptyFields)
List getStaticInfo (boolean withEmptyFields)
String getName ()
String getDisplayName ()
String getDate ()
String getTime ()
String getNodeDefaultAction ()
Image getNewIcon ()
Image getNodeIcon ()
Image getNodeIcon (boolean isSelected)
String[] getNodeActions ()
Color getBackgroundColor ()
Color getForegroundColor ()
Font getFont ()
void details ()
Object clone () throws CloneNotSupportedException
void propertyChange (java.beans.PropertyChangeEvent evt)
boolean equals (Object obj)
int hashCode ()
void registerPropertyChangeListener (PropertyChangeListener listener)
void addPropertyChangeListener (PropertyChangeListener listener)
void removePropertyChangeListener (PropertyChangeListener listener)
String checkIfNull (String str)
SystemAction[] getActions ()
int compareTo (Object o)
void fireFontChanged ()
Color getStandardBackgroundColor ()
Color getStandardForegroundColor ()

Protected Attributes

String consoleTimeStamp = null
PropertyChangeListener propertyListener = null
String[] nodeActions = null
String[] instantNodeActions = null
String defaultActionName = null
Color foregroundColor = Color.black
Color backgroundColor = new Color(70, 92, 113)
boolean isAlarmNodeActive = true
boolean isAlarmNodeInhibited = false
boolean isAlarmNodeMasked = false
boolean isAlarmNodeHighlighted = false
boolean isAlarmNodeHighlightedAndKlaxon = false
boolean isAlarmNodeAcknowledged = false
int highlitedOrKlaxonOrBoth = AlarmConstants.HIGHLIGHTED_ONLY
boolean isAlarmNodeInstant = false
boolean isNew = true
boolean infoMode = false
boolean isOnHighlightedList = false
CommentedAlarm commentedAlarm = null

Static Protected Attributes

final String[] INSTANT_NODE_ACTIONS
final String DEFAULT_ACTION_NAME = null

Private Member Functions

void addToList (List list, String key, String value, boolean withEmptyFields)
Image prepareIcon (String imagePathNew, String imagePathNotNew)
void changeBackgroundForeground ()
String getPrefix ()
String getSuffix ()

Private Attributes

PropertyChangeSupport changes = new PropertyChangeSupport(this)

Static Private Attributes

final Logger LOGGER
String[] NODE_ACTIONS

Detailed Description

Adapater class wrapping Alarm

Author:
pawlowsk

Constructor & Destructor Documentation

cern::laser::guiplatform::alarms::AlarmBean::AlarmBean (  CommentedAlarm  commentedAlarm  )  [inline]
 

Creates new AlarmAdapter from an Alarm object

cern::laser::guiplatform::alarms::AlarmBean::AlarmBean (   )  [inline]
 

This constructor should be used only for changing column names setTableColumns(Object bean, String[] propertyNames)

Constructor made only because of GP ListTableExplorer.setTableColumns method.

Member Function Documentation

void cern::laser::guiplatform::alarms::AlarmBean::addPropertyChangeListener (  PropertyChangeListener  listener  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::addToList (  List  list,
String  key,
String  value,
boolean  withEmptyFields
)  [inline, private]
 

helper method, which adds static properites to list depending on withEmptyFields value

Parameters:
list 
key key for LabelValueBean
value value for LabelValueBean (property value)
withEmptyFields 

void cern::laser::guiplatform::alarms::AlarmBean::changeBackgroundForeground (   )  [inline, private]
 

String cern::laser::guiplatform::alarms::AlarmBean::checkIfNull (  String  str  )  [inline]
 

Parameters:
str string to be checked if it is null
Returns:
if str is null returm empty string "" else retur str

Object cern::laser::guiplatform::alarms::AlarmBean::clone (   )  throws CloneNotSupportedException [inline]
 

int cern::laser::guiplatform::alarms::AlarmBean::compareTo (  Object  o  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::details (   )  [inline]
 

show details

boolean cern::laser::guiplatform::alarms::AlarmBean::equals (  Object  obj  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::fireFontChanged (   )  [inline]
 

SystemAction [] cern::laser::guiplatform::alarms::AlarmBean::getActions (   )  [inline]
 

String cern::laser::guiplatform::alarms::AlarmBean::getAlarmId (   )  [inline]
 

Returns:
the private identifier as an int

Color cern::laser::guiplatform::alarms::AlarmBean::getBackgroundColor (   )  [inline]
 

See also:
cern.gp.beans.editors.ColorMaster#getBackgroundColor()

Collection cern::laser::guiplatform::alarms::AlarmBean::getCategories (   )  [inline]
 

getter for the categories to which the alarm belongs

Returns:
a collection containing the names of the categories to which commentedAlarm.getAlarm(). alarm belongs

CommentedAlarm cern::laser::guiplatform::alarms::AlarmBean::getCommentedAlarm (   )  [inline]
 

This method is used by AlarmContainer when new Commnet shoud be set (inhibit, mask, etc)

Returns:
CommentedAlarm object, which is used to build this AlarmBean object or null if AlarmBean() constructor was used

String cern::laser::guiplatform::alarms::AlarmBean::getDate (   )  [inline]
 

String cern::laser::guiplatform::alarms::AlarmBean::getDisplayName (   )  [inline]
 

List cern::laser::guiplatform::alarms::AlarmBean::getDynamicInfo (  boolean  withEmptyFields  )  [inline]
 

Parameters:
withEmptyFields indicates whether all fileds should be returned or only not empty
Returns:
dynamic properties as List with LabelValueBean objects

Integer cern::laser::guiplatform::alarms::AlarmBean::getFaultCode (   )  [inline]
 

getter for the fault code

Returns:
the "fault code" of the alarm (as defined in the LEP alarm system)

String cern::laser::guiplatform::alarms::AlarmBean::getFaultFamily (   )  [inline]
 

getter for the fault family

Returns:
the "fault family" of the alarm (as defined in the LEP alarm system)

String cern::laser::guiplatform::alarms::AlarmBean::getFaultMember (   )  [inline]
 

getter for the fault Member

Returns:
the "fault member" of the alarm (as defined in the LEP alarm system)

Font cern::laser::guiplatform::alarms::AlarmBean::getFont (   )  [inline]
 

Color cern::laser::guiplatform::alarms::AlarmBean::getForegroundColor (   )  [inline]
 

See also:
cern.gp.beans.editors.ColorMaster#getForegroundColor()

int cern::laser::guiplatform::alarms::AlarmBean::getHighlightedOrKlaxon (   )  [inline]
 

this metod wheter alarm should be only highlighted or should have klaxon or maybe both

should not be used, this should be check on AutoKlaxon list

String cern::laser::guiplatform::alarms::AlarmBean::getIdentifier (   )  [inline]
 

Returns:
alarm identifier

boolean cern::laser::guiplatform::alarms::AlarmBean::getIsActive (   )  [inline]
 

debug method used to dispaly status on the console

Location cern::laser::guiplatform::alarms::AlarmBean::getLocation (   )  [inline]
 

getter for the location of the equipment

Returns:
the location of the equipment

String cern::laser::guiplatform::alarms::AlarmBean::getName (   )  [inline]
 

Reimplemented in cern::laser::guiplatform::alarms::InfoAlarmBean.

Image cern::laser::guiplatform::alarms::AlarmBean::getNewIcon (   )  [inline]
 

String [] cern::laser::guiplatform::alarms::AlarmBean::getNodeActions (   )  [inline]
 

String cern::laser::guiplatform::alarms::AlarmBean::getNodeDefaultAction (   )  [inline]
 

Image cern::laser::guiplatform::alarms::AlarmBean::getNodeIcon (  boolean  isSelected  )  [inline]
 

Image cern::laser::guiplatform::alarms::AlarmBean::getNodeIcon (   )  [inline]
 

String cern::laser::guiplatform::alarms::AlarmBean::getPrefix (   )  [inline, private]
 

Integer cern::laser::guiplatform::alarms::AlarmBean::getPriority (   )  [inline]
 

getter for the priority of the alarm

Returns:
the priority of the alarm

String cern::laser::guiplatform::alarms::AlarmBean::getProblemDescription (   )  [inline]
 

getter for the problem description

Returns:
the description of the problem from static info

ResponsiblePerson cern::laser::guiplatform::alarms::AlarmBean::getResponsiblePerson (   )  [inline]
 

getter for the responsible person for this equipement

Returns:
the name of the repsonsible person from the static info

Source cern::laser::guiplatform::alarms::AlarmBean::getSource (   )  [inline]
 

getter for the alarm source

Returns:
the alarm source from static info

String cern::laser::guiplatform::alarms::AlarmBean::getSourceHostName (   )  [inline]
 

Returns:
source name from the DynamicInfo class

String cern::laser::guiplatform::alarms::AlarmBean::getSourceName (   )  [inline]
 

getter for the alarm source name

Returns:
the alarm source name

String cern::laser::guiplatform::alarms::AlarmBean::getSourceTimestamp (   )  [inline]
 

Returns:
SourceTimestamp from the DynamicInfo class

Color cern::laser::guiplatform::alarms::AlarmBean::getStandardBackgroundColor (   )  [inline]
 

Color cern::laser::guiplatform::alarms::AlarmBean::getStandardForegroundColor (   )  [inline]
 

List cern::laser::guiplatform::alarms::AlarmBean::getStaticInfo (  boolean  withEmptyFields  )  [inline]
 

Parameters:
withEmptyFields indicates whether all fileds should be returned or only not empty
Returns:
static properties as List with LabelValueBean objects

String cern::laser::guiplatform::alarms::AlarmBean::getSuffix (   )  [inline, private]
 

String cern::laser::guiplatform::alarms::AlarmBean::getSystemName (   )  [inline]
 

Returns:
system name

String cern::laser::guiplatform::alarms::AlarmBean::getTime (   )  [inline]
 

String cern::laser::guiplatform::alarms::AlarmBean::getTimestamp (   )  [inline]
 

Returns:
Timestamp from the DynamicInfo class

Timestamp cern::laser::guiplatform::alarms::AlarmBean::getTimestampForSorting (   )  [inline]
 

Returns:
Timestamp used for sorting

List cern::laser::guiplatform::alarms::AlarmBean::getTimestamps (   )  [inline]
 

Returns:
dynamic properties as List with LabelValueBean objects

String cern::laser::guiplatform::alarms::AlarmBean::getUserData (   )  [inline]
 

Returns:
UserData from the DynamicInfo class

String cern::laser::guiplatform::alarms::AlarmBean::getUserTimestamp (   )  [inline]
 

Returns:
UserTimestamp

int cern::laser::guiplatform::alarms::AlarmBean::hashCode (   )  [inline]
 

Return the object hashcode

Returns:
the object hashcode

boolean cern::laser::guiplatform::alarms::AlarmBean::infoMode (   )  [inline]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isActive (   )  [inline]
 

This is bussines method

Returns:
isActive field from the StatusInfo class

Reimplemented in cern::laser::guiplatform::alarms::InfoAlarmBean.

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeAcknowledged (   )  [inline]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeActive (   )  [inline]
 

Returns:
indicates whether this Node is on active list

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeHighlighted (   )  [inline]
 

Returns:
true if AlarNode is highlited. otherwise false

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeHighlightedAndKlaxon (   )  [inline]
 

Returns:
true if AlarmNode is on highlithed list

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeInhibited (   )  [inline]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeInstant (   )  [inline]
 

Returns:
true if AlarNode is instant, otherwise false

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeMasked (   )  [inline]
 

Returns:
true if AlarNode is masked. otherwise false

boolean cern::laser::guiplatform::alarms::AlarmBean::isMasked (   )  [inline]
 

Returns:
isMasked field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::AlarmBean::isMultiplicityChild (   )  [inline]
 

Returns:
isMultiplicityChild field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::AlarmBean::isMultiplicityParent (   )  [inline]
 

Returns:
isMultiplicityParent field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::AlarmBean::isNew (   )  [inline]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isNodeChild (   )  [inline]
 

Tests if the alarm is a node child

Returns:
boolean

boolean cern::laser::guiplatform::alarms::AlarmBean::isNodeParent (   )  [inline]
 

Tests if the alarm is a node parent

Returns:
boolean

boolean cern::laser::guiplatform::alarms::AlarmBean::isNodeReduced (   )  [inline]
 

Tests if a node reduction is applied on this alarm

Returns:
boolean

boolean cern::laser::guiplatform::alarms::AlarmBean::isOnHighlightedList (   )  [inline]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isReduced (   )  [inline]
 

Returns:
isReduced field from the StatusInfo class

Image cern::laser::guiplatform::alarms::AlarmBean::prepareIcon (  String  imagePathNew,
String  imagePathNotNew
)  [inline, private]
 

Parameters:
imagePathNew 
imagePathNotNew 

void cern::laser::guiplatform::alarms::AlarmBean::propertyChange (  java.beans.PropertyChangeEvent  evt  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::registerPropertyChangeListener (  PropertyChangeListener  listener  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::removePropertyChangeListener (  PropertyChangeListener  listener  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setCommentedAlarm (  CommentedAlarm  newCommentedAlarm  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setHighlightedOrKlaxon (  final int  highlightedOrKlaxon  )  [inline]
 

Sets flag, which indicates whether, this alarm should be only highlighted, or should a klaxon or maybe both

Parameters:
highlightedOrKlaxon AlarmConstans.HIGHLIGHTED_ONLY or AlarmConstans.KLAXON_ONLY or AlarmConstans.HIGHLIGHTED_AND_KLAXON

void cern::laser::guiplatform::alarms::AlarmBean::setInfoMode (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeAcknowledged (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeActive (   )  [inline]
 

This method sets isAlarmNodeActive property param flag true or false

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeHighlighted (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeHighlightedAndKlaxon (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeInhibited (  boolean  flag  )  [inline]
 

Returns:
true if AlarNode is inhibited. otherwise false

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeInstant (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsAlarmNodeMasked (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsNew (  boolean  flag  )  [inline]
 

void cern::laser::guiplatform::alarms::AlarmBean::setIsOnHighlightedList (  boolean  flag  )  [inline]
 

Member Data Documentation

Color cern::laser::guiplatform::alarms::AlarmBean::backgroundColor = new Color(70, 92, 113) [protected]
 

background

PropertyChangeSupport cern::laser::guiplatform::alarms::AlarmBean::changes = new PropertyChangeSupport(this) [private]
 

CommentedAlarm cern::laser::guiplatform::alarms::AlarmBean::commentedAlarm = null [protected]
 

CommentedAlarm

String cern::laser::guiplatform::alarms::AlarmBean::consoleTimeStamp = null [protected]
 

alarm console timestamp

final String cern::laser::guiplatform::alarms::AlarmBean::DEFAULT_ACTION_NAME = null [static, protected]
 

default action name

String cern::laser::guiplatform::alarms::AlarmBean::defaultActionName = null [protected]
 

Color cern::laser::guiplatform::alarms::AlarmBean::foregroundColor = Color.black [protected]
 

foregournd

int cern::laser::guiplatform::alarms::AlarmBean::highlitedOrKlaxonOrBoth = AlarmConstants.HIGHLIGHTED_ONLY [protected]
 

this value indicates wheter alarm should be only highlighted or should have klaxon or maybe both

TODO: reimplement this use AutKlaxon and AutoHighlighed lists

boolean cern::laser::guiplatform::alarms::AlarmBean::infoMode = false [protected]
 

info mode when alarm displayed on lists like "alarm by category", "search list", etc

final String [] cern::laser::guiplatform::alarms::AlarmBean::INSTANT_NODE_ACTIONS [static, protected]
 

Initial value:

 new String [] {
        DetailsAction.class.getName()
    }
instant node actions

String [] cern::laser::guiplatform::alarms::AlarmBean::instantNodeActions = null [protected]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeAcknowledged = false [protected]
 

alarm is acknowledged

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeActive = true [protected]
 

this indicates whether alarm is on active list

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeHighlighted = false [protected]
 

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeHighlightedAndKlaxon = false [protected]
 

used to enabling or disabling appropriate actions, Auto highlighted

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeInhibited = false [protected]
 

this means that alarm in inhibited and is on inhibit list (inhibit explorer)

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeInstant = false [protected]
 

alarm is instant and is on insttant list (instant explorer)

boolean cern::laser::guiplatform::alarms::AlarmBean::isAlarmNodeMasked = false [protected]
 

alarm in masked and is on masked list (masked explorer)

boolean cern::laser::guiplatform::alarms::AlarmBean::isNew = true [protected]
 

alarm is new

boolean cern::laser::guiplatform::alarms::AlarmBean::isOnHighlightedList = false [protected]
 

this variable should be set just after creating new AlarmBean object, and indicates that this alarm is on highlighted list, used when alarm is on highlighted list

final Logger cern::laser::guiplatform::alarms::AlarmBean::LOGGER [static, private]
 

Initial value:


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

String [] cern::laser::guiplatform::alarms::AlarmBean::NODE_ACTIONS [static, private]
 

Initial value:

 new String[] {
        UnacknowledgeAction.class.getName(),
        AcknowledgeAction.class.getName(),
        null,
        HighlightAction.class.getName(),
        UnhighlightAction.class.getName(),
        null,
        InhibitAction.class.getName(),
        UninhibitAction.class.getName(),
        null,
        MaskAction.class.getName(),
        UnmaskAction.class.getName(),
        null,
        HighlightedAndKlaxonAction.class.getName(),
        UnhighlightedAndKlaxonAction.class.getName(),
        null,
        DetailsAction.class.getName(),
        null,
        ShowTimestampsAction.class.getName(),
        null,
        ShowMultiplicityChildrenAction.class.getName(),
        ShowNodeChildrenAction.class.getName(),
        null,
        ShowHelpUrlInBrowserAction.class.getName(),
    }
node actions

String [] cern::laser::guiplatform::alarms::AlarmBean::nodeActions = null [protected]
 

PropertyChangeListener cern::laser::guiplatform::alarms::AlarmBean::propertyListener = null [protected]
 

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