org.lsst.ccs.gconsole.plugins.monitor

Class MonitorFormat

java.lang.Object

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

Direct Known Subclasses:

MonitorFormat.DefaultMonitorFormat

public class MonitorFormat
extends Object

Formatter for monitoring data. This class may be used as is or subclassed to modify formatting logic.

All convenience methods that take MonitorCell or lists of data channels (as AgentChannel or ChannelHandle) eventually forward the call to format(MonitorField field, List channels). Methods that take a single channel (again, as AgentChannel or ChannelHandle), eventually forward the call to format(MonitorField field, AgentChannel channel).

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MonitorFormat.DefaultMonitorFormat

Field Summary

Fields

Modifier and Type	Field and Description
static Color	COLOR_BG
static Color	COLOR_CHANGED
static Color	COLOR_DISABLED
static Color	COLOR_ERR
static Color	COLOR_FG
static Color	COLOR_GOOD
static Color	COLOR_MULTI
static Color	COLOR_NA
static Color	COLOR_OFF
static Color	COLOR_POPUP
static EnumMap<org.lsst.ccs.bus.states.DataProviderState,Color>	COLOR_STATE
static Color	COLOR_WARN
static MonitorFormat.DefaultMonitorFormat	DEFAULT
protected String	DEFAULT_DT_FORMAT
protected String	DEFAULT_FLOAT_FORMAT
protected String	DEFAULT_INT_FORMAT
static int	HA_MULTI
protected int	LENGTH_LIMIT
static String	TEXT_MULTI

Constructor Summary

Constructors

Constructor and Description
MonitorFormat()

Method Summary

Modifier and Type	Method and Description
FormattedValue	format(FormattedValue fv) Completes formatting of a partially formatted value.
boolean	format(MonitorCell cell) Convenience method that updates FormattedValue associated with the specified cell.
boolean	format(MonitorCell cell, ChannelHandle 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, ChannelHandle 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.
Object	getValue(MonitorField field, AgentChannel channel) Extracts unformatted value corresponding to the specified field from a channel.
static void	main(String... arg)
FormattedValue	merge(MonitorField field, List<FormattedValue> values) Merges zero or more formatted values.
Color	mergeConfigColor(Color c1, Color c2) Merges colors used to indicate a state of a configurable parameter.
Color	mergeStateColor(Color c1, Color c2) Merges colors used to indicate the channel state.

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.DefaultMonitorFormat DEFAULT

COLOR_FG

public static final Color COLOR_FG

COLOR_BG

public static final Color COLOR_BG

COLOR_CHANGED

public static final Color COLOR_CHANGED

COLOR_GOOD

public static final Color COLOR_GOOD

COLOR_WARN

public static final Color COLOR_WARN

COLOR_ERR

public static final Color COLOR_ERR

COLOR_DISABLED

public static final Color COLOR_DISABLED

COLOR_OFF

public static final Color COLOR_OFF

COLOR_POPUP

public static final Color COLOR_POPUP

COLOR_MULTI

public static final Color COLOR_MULTI

COLOR_NA

public static final Color COLOR_NA

COLOR_STATE

public static final EnumMap<org.lsst.ccs.bus.states.DataProviderState,Color> COLOR_STATE

TEXT_MULTI

public static final String TEXT_MULTI

See Also:

Constant Field Values

HA_MULTI

public static final int HA_MULTI

See Also:

Constant Field Values

DEFAULT_FLOAT_FORMAT

protected String DEFAULT_FLOAT_FORMAT

DEFAULT_INT_FORMAT

protected String DEFAULT_INT_FORMAT

DEFAULT_DT_FORMAT

protected String DEFAULT_DT_FORMAT

LENGTH_LIMIT

protected int LENGTH_LIMIT

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 calls format(MonitorField field, AgentChannel channel) for each channel, then merges the results using merge(MonitorField field, List formattedValues).

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 first tries to call MonitorField.format(AgentChannel channel). If null is returned, it extracts the unformatted value with a call to getValue(MonitorField field, AgentChannel channel), then formats it with format(Object unformattedValue, MonitorField field, AgentChannel channel).

Parameters:

field - Monitored field.

channel - Data channel.

Returns:

Formatted value.

format

public FormattedValue format(FormattedValue fv)

Completes formatting of a partially formatted value. The instance passed to this method should have its value and optionally format fields set to the unformatted value and the suggested format string, respectively.

Parameters:

fv - Partially formatted value.

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,
                      ChannelHandle 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,
                             ChannelHandle 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.

merge

public FormattedValue merge(MonitorField field,
                            List<FormattedValue> values)

Merges zero or more formatted values.

Parameters:

field - Monitored field.

values - Formatted values to merge.

Returns:

Merged formatted value.

mergeConfigColor

public Color mergeConfigColor(Color c1,
                              Color c2)

Merges colors used to indicate a state of a configurable parameter.
Used internally by merge(MonitorField field, List formattedValues).

Parameters:

c1 - First color.

c2 - Second color.

Returns:

Color of the merged value.

mergeStateColor

public Color mergeStateColor(Color c1,
                             Color c2)

Merges colors used to indicate the channel state.
Used internally by merge(MonitorField field, List formattedValues).

Parameters:

c1 - First color.

c2 - Second color.

Returns:

Color of the merged value.

getValue

public Object getValue(MonitorField field,
                       AgentChannel channel)

Extracts unformatted value corresponding to the specified field from a channel.
The implementation provided by this class forwards the call to fielf.getValue(AgentChannel channel).

Parameters:

field - Monitored field.

channel - Data channel.

Returns:

Unformatted value,or null if the value cannot be extracted.

main

public static void main(String... arg)