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

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

Collaboration diagram for alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry:

Public Member Functions
	AlarmTableEntry (Alarm alarm)
void	updateAlarm (AlarmTableEntry newAlarm)
Alarm	getEncapsulatedAlarm ()
AlarmGUIType	getAlarmType ()
boolean	isNew ()
void	alarmSeen ()
boolean	isReduced ()
boolean	isChild ()
boolean	isParent ()
Object	clone () throws CloneNotSupportedException
String	getAction ()
String	getAlarmId ()
Collection	getCategories ()
String	getCause ()
String	getConsequence ()
URL	getHelpURL ()
String	getIdentifier ()
Location	getLocation ()
String	getPiquetEmail ()
String	getPiquetGSM ()
Integer	getPriority ()
synchronized String	getProblemDescription ()
ResponsiblePerson	getResponsiblePerson ()
Source	getSource ()
Status	getStatus ()
String	getSystemName ()
Triplet	getTriplet ()
boolean	isInstant ()
boolean	isMultiplicityChild ()
boolean	isMultiplicityParent ()
boolean	isNodeChild ()
boolean	isNodeParent ()
Private Attributes
volatile boolean	isNew
Alarm	alarm
AlarmGUIType	alarmType
Static Private Attributes
static final String	baciLevelPropName = "BACI_Level"
static final String	baciDescPropName = "BACI_Description"
static final String	baciValuePropName = "BACI_Value"
static final String	baciPropName = "BACI_Property"

Detailed Description

An entry in the alarm table i.e. a row in the table

It consists of the alarm plus other information to represent the alarm in the table. The AlarmTablemodel finds here all it needs to show an alarm in a row.

Author:: acaproni

Constructor & Destructor Documentation

alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::AlarmTableEntry ( Alarm alarm ) [inline]

Build an AlarmTableEntry from the given alarm.

The passed alarm can't be an AlarmTableEntry otherwise we are nesting alarms on alarms. In that case an exception is thrown.

Parameters:

alarm

The alarm in the entry

Exceptions:

References alarmType, and isNew().

Member Function Documentation

void alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::alarmSeen ( ) [inline]

The user saw the alarm and press one mouse button over its line so the alarm is not new anymore

References isNew().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::alarmSelected().

Object alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::clone ( ) throws CloneNotSupportedException [inline]

Returns:

Exceptions:

CloneNotSupportedException

See also:: cern.laser.client.data.Alarm::clone()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::clone().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getAction ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getAction()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getAction().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getAlarmId ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getAlarmId()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getAlarmId().

AlarmGUIType alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getAlarmType ( ) [inline]

Returns:: The type of the alarm

References alarmType.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::addAlarm(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::replaceAlarm(), and alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::run().

Collection alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getCategories ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getCategories()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getCategories().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getCause ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getCause()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getCause().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getConsequence ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getConsequence()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getConsequence().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

Alarm alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getEncapsulatedAlarm ( ) [inline]

Returns:: The CERN alarm encapsulated in this object.

References alarm.

Referenced by updateAlarm().

URL alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getHelpURL ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getHelpURL()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getHelpURL().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getIdentifier ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getIdentifier()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getIdentifier().

Location alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getLocation ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getLocation()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getLocation().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getPiquetEmail ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getPiquetEmail()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getPiquetEmail().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getPiquetGSM ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getPiquetGSM()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getPiquetGSM().

Integer alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getPriority ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getPriority()

Implements cern::laser::client::data::Alarm.

References alarm, baciLevelPropName, cern::laser::client::data::Alarm::getPriority(), cern::laser::client::data::Alarm::getStatus(), and cern::laser::client::data::Status::getUserProperties().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::autoAcknowledge(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent(), alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hasNotAckAlarms(), alma::acsplugins::alarmsystem::gui::table::AlarmsContainer::hasNotAckAlarms(), and alma::acsplugins::alarmsystem::gui::table::AlarmsContainer::removeInactiveAlarms().

synchronized String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getProblemDescription ( ) [inline]

Return the description of the alarm.

The description is usually contained in the Alarms branch of the CDB. However, if the alarm is generated by BACY then we take some of the user properties added by baci to build a more readable description of the alarm.

Returns:: The description of the alarm

See also:: cern.laser.client.data.Alarm::getProblemDescription()

Implements cern::laser::client::data::Alarm.

References alarm, baciDescPropName, baciValuePropName, cern::laser::client::data::Alarm::getProblemDescription(), cern::laser::client::data::Alarm::getStatus(), and cern::laser::client::data::Status::getUserProperties().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

ResponsiblePerson alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getResponsiblePerson ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getResponsiblePerson()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getResponsiblePerson().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

Source alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getSource ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getSource()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getSource().

Status alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getStatus ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getStatus()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getStatus().

String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getSystemName ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getSystemName()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getSystemName().

Triplet alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getTriplet ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::getTriplet()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::getTriplet().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCellContent().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isChild ( ) [inline]

Returns:: true if the alarm is a node or multiplicity child

References alarm, cern::laser::client::data::Alarm::isMultiplicityChild(), and cern::laser::client::data::Alarm::isNodeChild().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isInstant ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::isInstant()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::isInstant().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isMultiplicityChild ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::isMultiplicityChild()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::isMultiplicityChild().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isMultiplicityParent ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::isMultiplicityParent()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::isMultiplicityParent().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hideReducedChildren(), alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::showActiveChildren(), and alma::acsplugins::alarmsystem::gui::table::AlarmTable::AlarmTableMouseAdapter::showPopup().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isNew ( ) [inline]

Return true if the alarm is new

Returns:: true if the alarm is new

Referenced by alarmSeen(), AlarmTableEntry(), and updateAlarm().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isNodeChild ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::isNodeChild()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::isNodeChild().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isNodeParent ( ) [inline]

Returns:

See also:: cern.laser.client.data.Alarm::isNodeParent()

Implements cern::laser::client::data::Alarm.

References alarm, and cern::laser::client::data::Alarm::isNodeParent().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hideReducedChildren(), alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::showActiveChildren(), and alma::acsplugins::alarmsystem::gui::table::AlarmTable::AlarmTableMouseAdapter::showPopup().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isParent ( ) [inline]

Returns:: true if the alarm is a node or multiplicity parent

References alarm, cern::laser::client::data::Alarm::isMultiplicityParent(), and cern::laser::client::data::Alarm::isNodeParent().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTable::prepareRenderer().

boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isReduced ( ) [inline]

Returns:: true if the alarm is reduced

References alarm, cern::laser::client::data::Alarm::getStatus(), and cern::laser::client::data::Status::isReduced().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTable::prepareRenderer().

void alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::updateAlarm ( AlarmTableEntry newAlarm ) [inline]

Update the alarm with the new one.

Replace the alarm with the one but only if they have the same ID

Parameters:

newAlarm

The not null new alarm

References alarm, alarmType, cern::laser::client::data::Alarm::getAlarmId(), getAlarmId(), getEncapsulatedAlarm(), getStatus(), cern::laser::client::data::Status::isActive(), and isNew().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmsContainer::replace().

Member Data Documentation

Alarm alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::alarm [private]

The alarm received by the alarm system

Referenced by clone(), getAction(), getAlarmId(), getCategories(), getCause(), getConsequence(), getEncapsulatedAlarm(), getHelpURL(), getIdentifier(), getLocation(), getPiquetEmail(), getPiquetGSM(), getPriority(), getProblemDescription(), getResponsiblePerson(), getSource(), getStatus(), getSystemName(), getTriplet(), isChild(), isInstant(), isMultiplicityChild(), isMultiplicityParent(), isNodeChild(), isNodeParent(), isParent(), isReduced(), and updateAlarm().

AlarmGUIType alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::alarmType [private]

The type of the alarm

Referenced by AlarmTableEntry(), getAlarmType(), and updateAlarm().

final String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::baciDescPropName = "BACI_Description" [static, private]

The property set by baci to define the description

Referenced by getProblemDescription().

final String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::baciLevelPropName = "BACI_Level" [static, private]

The property set by baci to define the priority

Referenced by getPriority().

final String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::baciPropName = "BACI_Property" [static, private]

The property set by baci to define the name of the property

final String alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::baciValuePropName = "BACI_Value" [static, private]

The property set by baci to define the value of the property

Referenced by getProblemDescription().

volatile boolean alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isNew [private]

An entry is new till the user look at it by pressing one mouse button over the row of the alarm

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hasNotAckAlarms(), alma::acsplugins::alarmsystem::gui::table::AlarmsContainer::hasNotAckAlarms(), and alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::isRowAlarmNew().

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

AlarmTableEntry.java

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

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation