| java.lang.Object
 org.cougaar.lib.aggagent.query.Alert
All known Subclasses: org.cougaar.lib.aggagent.script.SilkAlert, org.cougaar.lib.aggagent.query.AlertDescriptor, org.cougaar.lib.aggagent.test.CycleSizeAlert,
| Alert | | abstract public class Alert implements XmlTransferable,Serializable(Code) | | The Alert class is the abstract superclass of all result set monitors.
Each implementation is responsible for maintaining its own status regarding
the corresponding result set. At first, this will be a simple boolean
status: either the alert is tripped or not. However, more complicated
recording apparati may be supported (or even required) in the future.
When new information becomes available, the handleUpdate method should be
called. Specific implementations will examine the result set and take the
appropriate action, which may include updating the Alert's status and/or
producing events.
At present there is no additional support for Alert activities, so all
necessary work must be done in the Alert implementations.
|
| getQueryAdapter | | public QueryResultAdapter getQueryAdapter()(Code) | | Provide access to the QueryResultAdapter monitored by this Alert.
|
| getQueryId | | public String getQueryId()(Code) | | Provide access to the query ID associated with this alert. The default
implementation is to obtain this from the resident query, but subclasses
may have different behavior.
|
| handleUpdate | | abstract public void handleUpdate()(Code) | | Handle incoming data and adjust the local state. This method is declared
public so that scripts can access it. Otherwise, it is usually invoked
through the update() method.
|
| isAlerted | | public boolean isAlerted()(Code) | | Report the status of this Alert. Either the alert has been tripped
(return true) or it hasn't (return false).
|
| setAlerted | | public void setAlerted(boolean f)(Code) | | Set the alerted status of this Alert. This method is declared
public rather than protected so that scripts can
access it. In general, however, it should not be called by other
agencies.
|
| setQueryAdapter | | public void setQueryAdapter(QueryResultAdapter s)(Code) | | Specify the query (etc.) which the Alert is responsible for monitoring.
In future implementations, this coupling may be handled differently. In
particular, different subclasses of AggregationResultSet may be supported
with class-specific handlers. For now, only one type is available, and
hence only one type is expected.
|
| toXml | | public String toXml()(Code) | | Convert this Alert to an XML format for transfer to clients.
|
| update | | public boolean update()(Code) | |
Notify the Alert that the relevant result set has been updated. This
method returns true if the state of the Alert was changed during the
operation and false otherwise. The bulk of the responsibility is
delegated to the abstract handleUpdate() method. Concrete Alert classes
should provide the appropriate implementation for that method.
The update() method is intentionally not declared final so that
subclasses can use a different strategy for reporting changes, possibly
relating to class-specific state.
|
|
|