org.lsst.ccs.gconsole.services.aggregator

Class AgentStatusEvent

java.lang.Object

java.util.EventObject

org.lsst.ccs.gconsole.services.aggregator.AgentStatusEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MutableAgentStatusEvent

public class AgentStatusEvent
extends EventObject

An event fired by AgentStatusAggregator to notify AgentStatusListeners of changes in the agent's published data.

Author:

onoprien

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AgentChannel>	addedChannels
protected List<org.lsst.ccs.bus.data.AgentInfo>	agents
protected org.lsst.ccs.bus.messages.StatusMessage	message
protected List<AgentChannel>	removedChannels
protected Map<AgentChannel,List<String>>	statusChanges

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
List<AgentChannel>	getAddedChannels() Returns a list of new channels.
List<String>	getAgentNames() Returns the list of names of remote agents whose data is included in this event.
List<org.lsst.ccs.bus.data.AgentInfo>	getAgents() Returns the list of remote agents whose data is included in this event.
org.lsst.ccs.bus.messages.StatusMessage	getMessage() Returns the status message that triggered this event.
List<AgentChannel>	getRemovedChannels() Returns a list of channels that are no longer published by the agent.
AgentStatusAggregator	getSource() Returns a reference to the status aggregator that fired this event.
Map<AgentChannel,List<String>>	getStatusChanges() Returns a map of modified channels to lists of keys of changed attributes.
boolean	isEmpty() Returns true if this event has no added, modified, or removed channels.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

agents

protected final List<org.lsst.ccs.bus.data.AgentInfo> agents

message

protected final org.lsst.ccs.bus.messages.StatusMessage message

statusChanges

protected final Map<AgentChannel,List<String>> statusChanges

addedChannels

protected final List<AgentChannel> addedChannels

removedChannels

protected final List<AgentChannel> removedChannels

Method Detail

getSource

public AgentStatusAggregator getSource()

Returns a reference to the status aggregator that fired this event.

Overrides:

getSource in class EventObject

Returns:

Status aggregator instance.

getAgents

public List<org.lsst.ccs.bus.data.AgentInfo> getAgents()

Returns the list of remote agents whose data is included in this event.

Returns:

List of contributing agents.

getAgentNames

public List<String> getAgentNames()

Returns the list of names of remote agents whose data is included in this event.

Returns:

List of names of contributing agents.

getMessage

public org.lsst.ccs.bus.messages.StatusMessage getMessage()

Returns the status message that triggered this event.

Returns:

Status message that triggered this event, or null if this event was not triggered by a bus message.

getStatusChanges

public Map<AgentChannel,List<String>> getStatusChanges()

Returns a map of modified channels to lists of keys of changed attributes. Removed or added channels do not appear in this map. This method may return non-empty map only for events passed to statusChanged(...) method of the listener.

Returns:

Map of channels to modified attributes lists.

getAddedChannels

public List<AgentChannel> getAddedChannels()

Returns a list of new channels. This method may return non-empty list only for events passed to configure(...) and statusChanged(...) methods of the listener.

Returns:

List of new channels.

getRemovedChannels

public List<AgentChannel> getRemovedChannels()

Returns a list of channels that are no longer published by the agent. The strings in the returned list are original channel paths. This method returns (possibly) non-empty map only for events passed to statusChanged(...) method of the listener.

Note: with the current implementation, this method never gets called. It is declared in anticipation of implementing filter and dictionary updates.

Returns:

List of removed channels.

isEmpty

public boolean isEmpty()

Returns true if this event has no added, modified, or removed channels.

Returns:

true if this event has no added, modified, or removed channels.

toString

public String toString()

Overrides:

toString in class EventObject