public class AlarmModel extends java.lang.Object implements java.io.Serializable, java.beans.PropertyChangeListener, DataBoxListener, Batchable
AlarmModel is alarm container used to contains alarms.
AlarmModel is a alarm data model working with data box.
Each data box contains one alarm model instance used to
contains all alarms for the data box. You can access the
alarm model via method TDataBox.getAlarmModel()
.
Via alarm model, you can manage the alarms, you can add,
acknowledge, update, clear, remove or visit the alarms.
Each alarm can associate with an element of the data box
via 'elementID' property. If the alarm elementID is set and
the related element can be found in the data box, then the
alarm will affect the AlarmState
of the element
automatically.
isAutoSyncAlarmState
to disable the auto-sync-alarm function.
For example:
TDataBox box = new TDataBox(); Node node = new Node("node1"); box.addElement(node); ... Alarm alarm = new Alarm(); alarm.setElementID("node1"); //this alarm occured on 'node1' box.getAlarmModel().addElement(alarm); System.out.println(node.getAlarmState().getAlarmCount()); // print: 1
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAlarm(Alarm alarm) |
void |
acknowledgeAlarmByID(java.lang.Object alarmID)
Acknowledge specified alarm.
|
void |
acknowledgeAlarmByID(java.lang.Object alarmID,
java.util.Date ackTime,
java.lang.String ackUserID)
Acknowledge specified alarm instance.
|
void |
addAlarm(Alarm alarm)
Add new alarm into the model.
|
void |
addAlarmModelListener(AlarmModelListener l)
add an AlarmModelListener into the alarm model.
|
void |
addAlarmPropertyChangeListener(java.beans.PropertyChangeListener l)
add a PropertyChangeListener into the alarm model.
|
void |
addAlarms(java.util.List alarms) |
void |
addBatchListener(BatchListener l)
Adds a batch listener to this
Batchable |
void |
clear()
Remove all alarm instances of the alarm model.
|
void |
clearAlarmByID(java.lang.Object alarmID)
Clear the alarm by given alarm id.
|
void |
clearAlarmByID(java.lang.Object alarmID,
java.util.Date clearTime)
Get the specified id alarm instance and
change its severity to 'AlarmSeverity.CLEARED'.
|
void |
confirmAlarmByID(java.lang.Object alarmID)
Equavalent of
acknowledgeAlarmByID . |
void |
confirmAlarmByID(java.lang.Object alarmID,
java.util.Date ackTime,
java.lang.String ackUserID)
Equavalent of
acknowledgeAlarmByID . |
AlarmModelQuickFinder |
createAlarmFinder(java.lang.String propertyName) |
void |
elementAdded(DataBoxEvent e)
Called when an element has been added.
|
void |
elementRemoved(DataBoxEvent e)
Called when an element has been removed.
|
void |
elementsCleared(DataBoxEvent e)
Called when all elements have been cleared.
|
void |
endBatch()
Terminates a batch of modifications.
|
Alarm |
getAlarmByID(java.lang.Object id)
get alarm instance by given id.
|
AlarmElementMapping |
getAlarmElementMapping() |
java.util.Collection |
getAlarmsByElement(Element element)
Get all alarms which associate with given element instance.
|
java.util.List |
getAllAlarms() |
TDataBox |
getDataBox()
Get the data box working with.
|
java.util.Collection |
getElementsByAlarm(Alarm alarm) |
int |
getLimit() |
boolean |
isAlarmExists(java.lang.Object alarmID)
Tells whether the alarm with given id is exists in the alarm model.
|
boolean |
isAutoRemoveAlarmWhenCleared() |
boolean |
isAutoRemoveAlarmWhenElementIsRemoved() |
boolean |
isBatching()
Checks whether
Batchable |
boolean |
isEmpty() |
java.util.Iterator |
iterator()
Get the iterator of the alarm collection.
|
void |
propertyChange(java.beans.PropertyChangeEvent e) |
void |
removeAlarm(Alarm alarm)
remove the specified alarm instance from the alarm model.
|
void |
removeAlarmByID(java.lang.Object alarmID)
remove the alarm with specified id from the alarm model.
|
void |
removeAlarmModelListener(AlarmModelListener l)
remove an AlarmModelListener from the alarm model.
|
void |
removeAlarmPropertyChangeListener(java.beans.PropertyChangeListener l)
remove an PropertyChangeListener from the alarm model.
|
void |
removeAlarmsByElement(Element element)
Remove all alarms which associate with specified element instance.
|
void |
removeAllAlarms()
Equal to
clear . |
void |
removeBatchListener(BatchListener l)
Removes a batch listener from this
Batchable |
void |
removeFirstAlarm(int count) |
void |
setAlarmElementMapping(AlarmElementMapping alarmElementMapping) |
void |
setAutoRemoveAlarmWhenCleared(boolean autoRemoveAlarmWhenCleared) |
void |
setAutoRemoveAlarmWhenElementIsRemoved(boolean autoRemoveAlarmWhenElementIsRemoved) |
void |
setLimit(int limit) |
int |
size()
return the total number of the alarms in the alarm model.
|
void |
startBatch()
Starts a batch of modifications.
|
public boolean isBatching()
Batchable
Batchable instance is in batch phase.
If true means someone has called #startBatch() and hasn't been called #endBatch().
isBatching
in interface Batchable
public void startBatch()
Batchable
startBatch
in interface Batchable
Batchable.endBatch()
public void endBatch()
Batchable
endBatch
in interface Batchable
Batchable.startBatch()
public void addBatchListener(BatchListener l)
Batchable
Batchable instance.
addBatchListener
in interface Batchable
l
- a batch listener to be added.Batchable.removeBatchListener(BatchListener)
public void removeBatchListener(BatchListener l)
Batchable
Batchable instance.
removeBatchListener
in interface Batchable
l
- a batch listener to be removed.Batchable.addBatchListener(BatchListener)
public TDataBox getDataBox()
public java.util.Iterator iterator()
public java.util.List getAllAlarms()
public boolean isEmpty()
public void removeFirstAlarm(int count)
public int getLimit()
public void setLimit(int limit)
public int size()
public void addAlarmModelListener(AlarmModelListener l)
l
- AlarmModelListener the listener objectpublic void removeAlarmModelListener(AlarmModelListener l)
l
- AlarmModelListener the listener objectpublic void addAlarmPropertyChangeListener(java.beans.PropertyChangeListener l)
l
- PropertyChangeListener the listener objectpublic void removeAlarmPropertyChangeListener(java.beans.PropertyChangeListener l)
l
- PropertyChangeListener the listener objectpublic void addAlarms(java.util.List alarms)
public void addAlarm(Alarm alarm)
alarm
- Alarm the alarm instance need to addpublic Alarm getAlarmByID(java.lang.Object id)
id
- Object alarm idpublic void clearAlarmByID(java.lang.Object alarmID)
alarmID
- Object alarm idpublic void clearAlarmByID(java.lang.Object alarmID, java.util.Date clearTime)
alarmID
- Object alarm idclearTime
- Date alarm cleared time.public void confirmAlarmByID(java.lang.Object alarmID)
acknowledgeAlarmByID
.alarmID
- Object alarm idpublic void acknowledgeAlarmByID(java.lang.Object alarmID)
alarmID
- Object alarm id which need to be acknowledgedpublic void acknowledgeAlarm(Alarm alarm)
public void confirmAlarmByID(java.lang.Object alarmID, java.util.Date ackTime, java.lang.String ackUserID)
acknowledgeAlarmByID
.alarmID
- Object alarm idackTime
- Date Acknowledged timeackUserID
- String the user id who acknowledge the alarm.public void acknowledgeAlarmByID(java.lang.Object alarmID, java.util.Date ackTime, java.lang.String ackUserID)
alarmID
- Object alarm idackTime
- Date acknowledged timeackUserID
- String the user name who acknowledge this alarm.public boolean isAlarmExists(java.lang.Object alarmID)
alarmID
- Object the alarm idpublic void removeAllAlarms()
clear
.public void clear()
public void removeAlarmByID(java.lang.Object alarmID)
alarmID
- alarm id.public void removeAlarm(Alarm alarm)
alarm
- Alarm the alarm need to remove from the alarm model.public java.util.Collection getAlarmsByElement(Element element)
element
- Element the element objectpublic java.util.Collection getElementsByAlarm(Alarm alarm)
public void removeAlarmsByElement(Element element)
element
- Element the element instance.public void propertyChange(java.beans.PropertyChangeEvent e)
propertyChange
in interface java.beans.PropertyChangeListener
e
- PropertyChangeEvent the property change eventpublic void elementRemoved(DataBoxEvent e)
elementRemoved
in interface DataBoxListener
e
- DataBoxEventpublic void elementsCleared(DataBoxEvent e)
elementsCleared
in interface DataBoxListener
e
- DataBoxEventpublic void elementAdded(DataBoxEvent e)
elementAdded
in interface DataBoxListener
e
- DataBoxEventpublic AlarmElementMapping getAlarmElementMapping()
public void setAlarmElementMapping(AlarmElementMapping alarmElementMapping)
public boolean isAutoRemoveAlarmWhenCleared()
public void setAutoRemoveAlarmWhenCleared(boolean autoRemoveAlarmWhenCleared)
public AlarmModelQuickFinder createAlarmFinder(java.lang.String propertyName)
public boolean isAutoRemoveAlarmWhenElementIsRemoved()
public void setAutoRemoveAlarmWhenElementIsRemoved(boolean autoRemoveAlarmWhenElementIsRemoved)
Copyright © 2002 - 2010 Serva Software. All Rights Reserved.