org.lsst.ccs.gconsole.plugins.monitor

Class MonitorFormat

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.MonitorFormat

public class MonitorFormat
extends Object

Formatter for monitoring data.

Instances of this class are used by MonitorView to produce formatted values for display. By default, calls are simply forwarded to MonitorField methods. Subclasses can modify this behavior and provide custom formatting.

This class also provides convenience methods for formatting monitoring table cells, etc. All these methods forward to format(MonitorField field, List channels).

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static MonitorFormat	DEFAULT

Constructor Summary

Constructors

Constructor and Description
MonitorFormat()

Method Summary

Modifier and Type	Method and Description
boolean	format(MonitorCell cell) Convenience method that updates FormattedValue associated with the specified cell.
boolean	format(MonitorCell cell, DisplayChannel channelHandle) Convenience method that updates FormattedValue associated with the specified cell, assuming that the only possible reason for a change are changes in the specified channel.
FormattedValue	format(MonitorField field, AgentChannel channel) Produces formatted value, given the monitored field and the data channel whose value needs to be formatted.
FormattedValue	format(MonitorField field, DisplayChannel channelHandle) Convenience method that produces formatted value, given the field and the channel handle.
FormattedValue	format(MonitorField field, List<AgentChannel> channels) Produces formatted value, given the field and the list of contributing channels.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final MonitorFormat DEFAULT

Constructor Detail

MonitorFormat

public MonitorFormat()

Method Detail

format

public FormattedValue format(MonitorField field,
                             List<AgentChannel> channels)

Produces formatted value, given the field and the list of contributing channels. The implementation provided by this class forwards the call to MonitorField.format(List).

Parameters:

field - Monitored field.

channels - Contributing channels.

Returns:

Formatted value.

format

public FormattedValue format(MonitorField field,
                             AgentChannel channel)

Produces formatted value, given the monitored field and the data channel whose value needs to be formatted. The implementation provided by this class forwards the call to MonitorField.format(AgentChannel).

Parameters:

field - Monitored field.

channel - Data channel.

Returns:

Formatted value.

format

public boolean format(MonitorCell cell)

Convenience method that updates FormattedValue associated with the specified cell. The actual formatting is done by format(MonitorField field, List channels).

Parameters:

cell - Cell to be formatted.

Returns:

True if the formatted value associated with the cell has changed as a result of this call.

format

public boolean format(MonitorCell cell,
                      DisplayChannel channelHandle)

Convenience method that updates FormattedValue associated with the specified cell, assuming that the only possible reason for a change are changes in the specified channel.
The implementation provided by this class forwards the call to format(MonitorCell cell), ignoring the channelHandle argument. Subclasses might implement more efficient formatting for cells that depend on multiple channels.

Parameters:

cell - Cell to be formatted.

channelHandle - Handle of the data channel that might have changed.

Returns:

True if the formatted value associated with the cell has changed as a result of this call.

format

public FormattedValue format(MonitorField field,
                             DisplayChannel channelHandle)

Convenience method that produces formatted value, given the field and the channel handle.
The actual formatting is done by format(MonitorField field, AgentChannel channel).

Parameters:

field - Monitored field.

channelHandle - Handle of a data channel whose value needs to be formatted.

Returns:

Formatted value.