org.lsst.ccs.gconsole.plugins.monitor

Interface ChannelHandle

All Known Implementing Classes:

DefaultChannelHandle

public interface ChannelHandle

Data channel handle used by monitoring data views. The handle provides access to the underlying channel, its display path, and the Updatable target component that displays it and should be notified of changes.

Author:

onoprien

Method Summary

Modifier and Type	Method and Description
AgentChannel	getChannel() Returns data channel object wrapped by this handle.
String	getPath() Returns the display path associated with the underlying data channel in the monitoring view.
Updatable	getTarget() Returns the object that handles an updatable display of the data channel.
void	setChannel(AgentChannel channel) Sets data channel object wrapped by this handle.
void	setPath(String path) Sets the display path associated with the underlying data channel.
void	setTarget(Updatable target) Set the object that handles an updatable display of the data channel.
default void	update(List<String> attributes) Updates the target.

Method Detail

getChannel

AgentChannel getChannel()

Returns data channel object wrapped by this handle.

Returns:

Data channel.

getPath

String getPath()

Returns the display path associated with the underlying data channel in the monitoring view.

Returns:

Display path.

getTarget

Updatable getTarget()

Returns the object that handles an updatable display of the data channel.

Returns:

Target display for the underlying channel.

setChannel

void setChannel(AgentChannel channel)

Sets data channel object wrapped by this handle.

Parameters:

channel -

setPath

void setPath(String path)

Sets the display path associated with the underlying data channel.

Parameters:

path - Display path.

setTarget

void setTarget(Updatable target)

Set the object that handles an updatable display of the data channel.

Parameters:

target - Target display for the underlying channel.

update

default void update(List<String> attributes)

Updates the target. The default implementation converts the list of attributes into the list of monitored fields using the target's getAffectedFields(...) method, then calls the appropriate update(...) method of the target. Most classes implementing this interface will not override this method.

Parameters:

attributes - List of attributes whose values might have changed, or null if all attribute values might have changed.