org.lsst.ccs.gconsole.agent

Class AgentStatusEvent

java.lang.Object

java.util.EventObject

org.lsst.ccs.gconsole.agent.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 status.

Author:

onoprien

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AgentChannel>	addedChannels
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
AgentStatusEvent	filter(AgentChannelsFilter filter) Creates a new event, keeping only changes that pass the specified filter.
AgentStatusEvent	filter(Set<String> innerPaths) Creates a new event, keeping only changes in channels whose local (no agent name) paths are contained in the supplied set.
List<AgentChannel>	getAddedChannels() Returns a list of new channels.
AgentStatusAggregator	getAggregator() Returns a reference to the status aggregator that fired this event.
org.lsst.ccs.bus.messages.StatusMessage	getMessage() Returns the bus message that informed the status aggregator of the change.
List<AgentChannel>	getRemovedChannels() Returns a list of channels that are no longer published by the agent.
org.lsst.ccs.bus.data.AgentInfo	getSource() Returns the descriptor of the source agent.
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

statusChanges

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

addedChannels

protected final List<AgentChannel> addedChannels

removedChannels

protected final List<AgentChannel> removedChannels

Method Detail

getSource

public org.lsst.ccs.bus.data.AgentInfo getSource()

Returns the descriptor of the source agent.

Overrides:

getSource in class EventObject

Returns:

Agent descriptor.

getMessage

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

Returns the bus message that informed the status aggregator of the change. This method will only return non-null value for events passed to statusChanged(...) method of the listener.

Returns:

Status message received over the bus.

getAggregator

public AgentStatusAggregator getAggregator()

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

Returns:

Status aggregator instance.

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.

filter

public AgentStatusEvent filter(Set<String> innerPaths)

Creates a new event, keeping only changes in channels whose local (no agent name) paths are contained in the supplied set.

Parameters:

innerPaths - Paths to keep. If null, no changes are included in the output event.

Returns:

Filtered Sub-event.

filter

public AgentStatusEvent filter(AgentChannelsFilter filter)

Creates a new event, keeping only changes that pass the specified filter.

Parameters:

filter -

Returns:

toString

public String toString()

Overrides:

toString in class EventObject