public class IltAlarmSystem
extends ilog.tgo.model.internal.IltBaseSystem
implements ilog.tgo.model.internal.IltStateCollection
Users who are interested in customizing their own alarm systems, must create an instance of this class and define which are the alarm severities that will be considered.
For each configured alarm severity, an alarm state is created, that stores a counter of new alarms and a counter of acknowledged alarms.
Modifier and Type | Class and Description |
---|---|
static class |
IltAlarmSystem.State
This class provides a representation model for generic alarms carried by a
telecom object.
|
Modifier and Type | Field and Description |
---|---|
static ilog.tgo.model.internal.IltAlarmSeverityStateFactory |
DefaultAlarmSeverityStateFactory
Default factory used to create states which represents alarm severities
counters.
|
Modifier | Constructor and Description |
---|---|
protected |
IltAlarmSystem(String name) |
protected |
IltAlarmSystem(String name,
ilog.tgo.mapper.state.IltAlarmSystemMapper mapper) |
Modifier and Type | Method and Description |
---|---|
boolean |
add(IltAlarmSeverity severity)
Add a new severity in the system.
|
boolean |
add(IltState state)
Add a new state in the collection.
|
Object |
clone()
Return a copy of this model
|
protected ilog.tgo.mapper.IltMapper |
createMapper()
Creates the mapper for the system.
|
void |
fireSeverityAdded(ilog.tgo.model.state.event.IltAlarmSystemEvent event)
Notify all listeners that a given state was added to the alarm system.
|
void |
fireSeverityRemoved(ilog.tgo.model.state.event.IltAlarmSystemEvent event)
Notify all listeners that a given state was removed from the alarm
system.
|
ilog.tgo.model.internal.IltAlarmSeverityState |
get(IltAlarmSeverity severity)
Retrieves the alarm state responsible for a certain severity.
|
ilog.tgo.model.internal.IltStatePath |
getAcknowledgedAlarmPath(IltAlarmSeverity severity)
Return the state path of the acknowledged alarms state for a given
severity.
|
ilog.tgo.model.internal.IltStatePath |
getAlarmStatePath()
Return the path to the alarm aggregate state.
|
ilog.tgo.model.internal.IltStatePath[] |
getAllPaths(IlpFilter filter)
Return all the paths found which corresponds to the criteria given
by the filter.
|
ilog.tgo.mapper.state.IltStateMapper |
getMapper(IltAlarmSeverity severity)
Return the alarm mapping created to the alarm severity state which
represents the given severity in the system or
null , if such a
state does not exist. |
ilog.tgo.model.internal.IltStatePath |
getNewAlarmPath(IltAlarmSeverity severity)
Return the state path of the new alarms state for a given severity.
|
ilog.tgo.model.internal.IltStatePath |
getPath(IltAlarmSeverity severity)
Return the path used to set the value of the alarm severity information.
|
ilog.tgo.model.internal.IltStatePath |
getPath(String name)
Return the state from the model that corresponds to the given name.
|
boolean |
has(IltAlarmSeverity severity)
Verifies if the given severity is part of the alarm model.
|
boolean |
has(IltState state)
Return
true if the given state is part of the collection or
subcollections. |
boolean |
has(ilog.tgo.model.internal.IltStatePath path)
Return
true if the state given by this path is present in
the alarm system. |
boolean |
hasLocal(ilog.tgo.model.internal.IltStatePath path)
Verifies if the given path is present only in this state system.
|
protected void |
initialize() |
void |
map(IltObject object,
IltCompositeGraphic graphic)
Maps an entire IltObjectState.
|
void |
mapState(IltObject object,
IltCompositeGraphic graphic,
ilog.tgo.model.internal.IltStatePath path,
Object value)
Maps a specific state in the system.
|
void |
merge(IltAlarmSystem other)
Created for serialization purposes.
|
static IltAlarmSystem |
New(String name)
Static method which is responsible for creating a new state model instance,
and registering this new instance in the controller.
|
static IltAlarmSystem |
New(String name,
ilog.tgo.mapper.state.IltAlarmSystemMapper mapper) |
boolean |
remove(IltAlarmSeverity severity)
Remove the given severity from the alarm model.
|
boolean |
remove(IltState state)
Remove a state from the collection.
|
void |
setAlarmSeverityStateFactory(ilog.tgo.model.internal.IltAlarmSeverityStateFactory factory)
Sets the alarm state factory used to create the states that represent alarm
severities.
|
void |
setMapper(ilog.tgo.mapper.IltMapper mapper)
Sets the mapper which will be responsible for mapping the state information
into decorations.
|
Enumeration |
severities()
Return all the severities being handled by this alarm system.
|
Enumeration |
severityStates()
Return all the severity states being handled by this alarm system.
|
Enumeration |
states()
Return an enumeration with all the states that are part of this table
|
String |
toString()
Return the String representation of this IltStateModel's values.
|
protected boolean |
validateListener(EventListener listener)
This method should be overwritten by the subclasses to define which
are the listeners which are allowed.
|
protected boolean |
validateMapper(ilog.tgo.mapper.IltMapper mapper)
Verifies if the given mapper can be used with the system.
|
public static ilog.tgo.model.internal.IltAlarmSeverityStateFactory DefaultAlarmSeverityStateFactory
IltAlarmSeverityState
protected IltAlarmSystem(String name)
protected IltAlarmSystem(String name, ilog.tgo.mapper.state.IltAlarmSystemMapper mapper)
public static IltAlarmSystem New(String name)
public static IltAlarmSystem New(String name, ilog.tgo.mapper.state.IltAlarmSystemMapper mapper)
protected void initialize()
public ilog.tgo.model.internal.IltStatePath getAlarmStatePath()
public String toString()
public boolean add(IltState state)
add
in interface ilog.tgo.model.internal.IltStateCollection
state
- state to be added in the model.public boolean remove(IltState state)
remove
in interface ilog.tgo.model.internal.IltStateCollection
state
- state to be removed from the model.public boolean has(IltState state)
true
if the given state is part of the collection or
subcollections.has
in interface ilog.tgo.model.internal.IltStateCollection
state
- state being queried.true
when the state is part of the collection.public Enumeration states()
states
in interface ilog.tgo.model.internal.IltStateCollection
public boolean has(ilog.tgo.model.internal.IltStatePath path)
true
if the state given by this path is present in
the alarm system.public boolean hasLocal(ilog.tgo.model.internal.IltStatePath path)
public ilog.tgo.model.internal.IltStatePath[] getAllPaths(IlpFilter filter)
filter
- criteria to match the state instances.public Enumeration severities()
public Enumeration severityStates()
public boolean has(IltAlarmSeverity severity)
true
if the severity is contained in the model.public boolean add(IltAlarmSeverity severity)
The alarm state factory is used to create a state which will represent an alarm severity in the state information of a telecom object.
severity
- The severity to be added.public boolean remove(IltAlarmSeverity severity)
public ilog.tgo.model.internal.IltAlarmSeverityState get(IltAlarmSeverity severity)
public ilog.tgo.model.internal.IltStatePath getPath(IltAlarmSeverity severity)
set
.public ilog.tgo.model.internal.IltStatePath getPath(String name)
name
- complete state name, formed by the concatenation of the states
which compose the path inside the model, separated by the
character '.'public ilog.tgo.model.internal.IltStatePath getNewAlarmPath(IltAlarmSeverity severity)
set
.public ilog.tgo.model.internal.IltStatePath getAcknowledgedAlarmPath(IltAlarmSeverity severity)
set
.public void setAlarmSeverityStateFactory(ilog.tgo.model.internal.IltAlarmSeverityStateFactory factory)
public void fireSeverityAdded(ilog.tgo.model.state.event.IltAlarmSystemEvent event)
public void fireSeverityRemoved(ilog.tgo.model.state.event.IltAlarmSystemEvent event)
public void setMapper(ilog.tgo.mapper.IltMapper mapper) throws IllegalArgumentException
setMapper
in class ilog.tgo.model.internal.IltBaseSystem
IllegalArgumentException
protected boolean validateMapper(ilog.tgo.mapper.IltMapper mapper)
validateMapper
in class ilog.tgo.model.internal.IltBaseSystem
protected ilog.tgo.mapper.IltMapper createMapper()
createMapper
in class ilog.tgo.model.internal.IltBaseSystem
public ilog.tgo.mapper.state.IltStateMapper getMapper(IltAlarmSeverity severity)
null
, if such a
state does not exist.public void map(IltObject object, IltCompositeGraphic graphic)
object
- the telecom object containing this semantic stategraphic
- a graphic object representing the telecom objectpublic void mapState(IltObject object, IltCompositeGraphic graphic, ilog.tgo.model.internal.IltStatePath path, Object value)
object
- the telecom object containing this semantic stategraphic
- a graphic object representing the telecom objectpath
- the pathvalue
- the valueprotected boolean validateListener(EventListener listener)
validateListener
in class ilog.tgo.model.internal.IltBaseSystem
public Object clone()
clone
in class ilog.tgo.model.internal.IltBaseSystem
public void merge(IltAlarmSystem other)
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.