org.lsst.ccs.gconsole.plugins.monitor

Class DisplayChannelMulti

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.DisplayChannelMulti

All Implemented Interfaces:

DisplayChannel

public class DisplayChannelMulti
extends Object
implements DisplayChannel

DisplayChannel that can be associated with multiple original data channels.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
DisplayChannelMulti(String path)

Method Summary

Modifier and Type	Method and Description
void	addChannel(AgentChannel channel) Adds an original published data channel to the list of channels associated with this display channel.
List<AgentChannel>	getChannels() Returns an unmodifiable list of original published data channels associated with this display channel.
String	getPath() Returns the display path associated with this channel.
Updatable	getTarget() Returns the object that should be notified whenever there are changes to data channels associated with this display channel.
boolean	purgeOfflineChannels(String agentName) Removes all offline channels from the specified agent.
boolean	removeChannel(String path) Removes an original published data channel from the list of channels associated with this display channel.
void	setChannel(AgentChannel channel) Sets the original published data channel associated with this display channel.
void	setChannels(Collection<AgentChannel> channels) Sets the list of original published data channels associated with this display channel.
void	setTarget(Updatable target) Set the object that should be notified whenever there are changes to data channels associated with this display channel.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.plugins.monitor.DisplayChannel

getChannel, update

Constructor Detail

DisplayChannelMulti

public DisplayChannelMulti(String path)

Method Detail

getPath

public String getPath()

Description copied from interface: DisplayChannel

Returns the display path associated with this channel.

Specified by:

getPath in interface DisplayChannel

Returns:

Display path.

getTarget

public Updatable getTarget()

Description copied from interface: DisplayChannel

Returns the object that should be notified whenever there are changes to data channels associated with this display channel.

Specified by:

getTarget in interface DisplayChannel

Returns:

Target to be notified of changes.

setTarget

public void setTarget(Updatable target)

Description copied from interface: DisplayChannel

Set the object that should be notified whenever there are changes to data channels associated with this display channel.

Specified by:

setTarget in interface DisplayChannel

Parameters:

target - Target to be notified of changes.

getChannels

public List<AgentChannel> getChannels()

Description copied from interface: DisplayChannel

Returns an unmodifiable list of original published data channels associated with this display channel.

Specified by:

getChannels in interface DisplayChannel

Returns:

Data channel.

setChannel

public void setChannel(AgentChannel channel)

Description copied from interface: DisplayChannel

Sets the original published data channel associated with this display channel.

Specified by:

setChannel in interface DisplayChannel

Parameters:

channel - Data channel.

setChannels

public void setChannels(Collection<AgentChannel> channels)

Description copied from interface: DisplayChannel

Sets the list of original published data channels associated with this display channel. Any previously associated channels are removed.

Specified by:

setChannels in interface DisplayChannel

Parameters:

channels - Data channels to be associated with this display channel.

addChannel

public void addChannel(AgentChannel channel)

Description copied from interface: DisplayChannel

Adds an original published data channel to the list of channels associated with this display channel. If a channel with the same path already exists, it is replaced.

Specified by:

addChannel in interface DisplayChannel

Parameters:

channel - Data channel.

removeChannel

public boolean removeChannel(String path)

Description copied from interface: DisplayChannel

Removes an original published data channel from the list of channels associated with this display channel.

Specified by:

removeChannel in interface DisplayChannel

Parameters:

path - Original path of the channel to be removed.

Returns:

True if this display channel no longer has any data channels associated with it.

purgeOfflineChannels

public boolean purgeOfflineChannels(String agentName)

Description copied from interface: DisplayChannel

Removes all offline channels from the specified agent. The default implementation does nothing and returns false.

Specified by:

purgeOfflineChannels in interface DisplayChannel

Parameters:

agentName - Agent name.

Returns:

True if this display channel no longer has any data channels associated with it.