MonitorField (LSST CCS Graphical User Interface 4.2.11 API)

java.lang.Object
- org.lsst.ccs.gconsole.plugins.monitor.MonitorField

Direct Known Subclasses:

MonitorField.Average
```
public class MonitorField
extends Object
```
Descriptor of a field that can be displayed by monitoring views. Static constants of this class enumerate standard types of monitored values. Additional instances may be created at run time.
Instances can be registered as default handlers for data channel attribute keys.
Equality and hash code are based on object identity.

Author:

onoprien

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MonitorField.Average

Nested Classes
Modifier and Type	Class and Description
`static class`	`MonitorField.Average`

Field Summary

Fields
Modifier and Type	Field and Description
`static MonitorField`	`ALERT_HIGH`
`static MonitorField`	`ALERT_LOW`
`static MonitorField`	`AVERAGE_VALUE`
`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`
`protected String`	`DEFAULT_DT_FORMAT`
`protected String`	`DEFAULT_FLOAT_FORMAT`
`static MonitorField`	`DEFAULT_GROUP_FIELD` Default `MonitorField` to be used for displaying a value corresponding to a group of display channels.
`protected String`	`DEFAULT_INT_FORMAT`
`static MonitorField`	`DESCR`
`static MonitorField[]`	`GROUP_FIELDS` Available standard `MonitorField` constants for displaying a value corresponding to a group of display channels.
`static int`	`HA_MULTI`
`static MonitorField`	`HIGH_ALARM`
`static MonitorField`	`HIGH_WARN`
`static MonitorField`	`HOST`
`protected String`	`key`
`protected Set<String>`	`keys`
`protected int`	`LENGTH_LIMIT`
`static MonitorField`	`LOW_ALARM`
`static MonitorField`	`LOW_WARN`
`static MonitorField`	`MAX_VALUE`
`static MonitorField`	`MEDIAN_VALUE`
`static MonitorField`	`MIN_VALUE`
`static MonitorField`	`NAME`
`static MonitorField`	`NULL`
`protected FormattedValue`	`template`
`static String`	`TEXT_MULTI`
`protected String`	`title`
`static MonitorField`	`UNITS`
`static MonitorField`	`VALUE`

Constructor Summary

Constructors
Constructor and Description
`MonitorField(MonitorField other)` Deep copy constructor.
`MonitorField(String key, String title, FormattedValue template)` Constructs an instance without specifying the set of affecting keys.
`MonitorField(String key, String title, FormattedValue template, Set<String> keys)` Constructs an instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected FormattedValue`	`colorConfigurationParameter(FormattedValue fv, AgentChannel channel)` Applies configuration parameter specific formatting.
`protected FormattedValue`	`defaultFormat(AgentChannel channel, FormattedValue fv)` Applies standard formatting, without overwriting fields already set on the provided `FormattedValue`.
`static String`	`fieldToString(MonitorField field)` Converts `MonitorField` to its string representation.
`FormattedValue`	`format(AgentChannel channel)` Computes the current formatted value of this field in the specified data channel.
`FormattedValue`	`format(List<AgentChannel> channels)` Computes the current formatted value of this field for the specified list of channels.
`static List<MonitorField>`	`getAffectedFields(Collection<String> keys)`
`static List<MonitorField>`	`getAffectedFields(Collection<String> keys, Collection<MonitorField> fields)`
`static List<MonitorField>`	`getDefaultFields(Collection<String> keys)`
`static MonitorField`	`getInstance(String key)` Returns an instance identified by the specified string.
`String`	`getKey()` Returns a unique key of this field.
`Set<String>`	`getKeys()` Returns a set of keys of data channel attributes that might effect the value of this field or its formatting.
`static MonitorField`	`getRegisteredInstance(String key)` Returns an instance registered as the default handler for the attribute identified by the specified key, or `null` if no such instance exists.
`String`	`getTitle()` Returns human readable title associated with this field.
`Object`	`getValue(AgentChannel channel)` Returns the current value of this field in the specified data channel, or `null` if the channel does not contain a value for this field.
`boolean`	`isUpdatable()`
`FormattedValue`	`merge(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.
`static void`	`registerInstance(MonitorField field)` Registers the specified instance as the default handler for the attribute identified by the key returned by its `getKey()` method.
`static MonitorField`	`stringToField(String field)` Returns `MonitorField` given its string representation.
`String`	`toString()` Returns the human readable title of this field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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
  - NULL
```
public static final MonitorField NULL
```
  - NAME
```
public static final MonitorField NAME
```
  - VALUE
```
public static final MonitorField VALUE
```
  - UNITS
```
public static final MonitorField UNITS
```
  - LOW_ALARM
```
public static final MonitorField LOW_ALARM
```
  - LOW_WARN
```
public static final MonitorField LOW_WARN
```
  - ALERT_LOW
```
public static final MonitorField ALERT_LOW
```
  - HIGH_ALARM
```
public static final MonitorField HIGH_ALARM
```
  - HIGH_WARN
```
public static final MonitorField HIGH_WARN
```
  - ALERT_HIGH
```
public static final MonitorField ALERT_HIGH
```
  - DESCR
```
public static final MonitorField DESCR
```
  - AVERAGE_VALUE
```
public static final MonitorField AVERAGE_VALUE
```
  - MAX_VALUE
```
public static final MonitorField MAX_VALUE
```
  - MIN_VALUE
```
public static final MonitorField MIN_VALUE
```
  - MEDIAN_VALUE
```
public static final MonitorField MEDIAN_VALUE
```
  - HOST
```
public static final MonitorField HOST
```
  - DEFAULT_GROUP_FIELD
```
public static final MonitorField DEFAULT_GROUP_FIELD
```
    Default MonitorField to be used for displaying a value corresponding to a group of display channels.
  - GROUP_FIELDS
```
public static final MonitorField[] GROUP_FIELDS
```
    Available standard MonitorField constants for displaying a value corresponding to a group of display channels.
  - 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
```
  - key
```
protected final String key
```
  - title
```
protected final String title
```
  - template
```
protected final FormattedValue template
```
  - keys
```
protected final Set<String> keys
```
- Constructor Detail
  - MonitorField
```
public MonitorField(String key,
                    String title,
                    FormattedValue template,
                    Set<String> keys)
```
    Constructs an instance.
    
    Parameters:
    
    key - Attribute key. Unless overridden, getKey() will return this key. The getValue(channel) method will return the value of the data channel attribute identified by this key.
    
    title - Human readable title.
    
    template - Formatted value template.
    
    keys - Keys of attributes that might affect this field. If null, the field is assumed to be affected by the attribute specified by the key argument. If that argument is null as well, the field is not affected by any parameters.
  - MonitorField
```
public MonitorField(String key,
                    String title,
                    FormattedValue template)
```
    Constructs an instance without specifying the set of affecting keys. Equivalent to MonitorField(key, title, template, null).
    
    Parameters:
    
    key - Attribute key. Unless overridden, getKey() and getKeys() methods will return this key and a singleton set containing this key, respectively. The getValue(channel) method will return the value of the data channel attribute identified by this key.
    
    title - Human readable title.
    
    template - Formatted value template.
  - MonitorField
```
public MonitorField(MonitorField other)
```
    Deep copy constructor.
    
    Parameters:
    
    other - Field to be cloned.
- Method Detail
  - registerInstance
```
public static void registerInstance(MonitorField field)
```
    Registers the specified instance as the default handler for the attribute identified by the key returned by its getKey() method.
    
    Parameters:
    
    field - Instance to register.
    
    Throws:
    
    IllegalArgumentException - if an instance with this key already registered.
  - getInstance
```
public static MonitorField getInstance(String key)
```
    Returns an instance identified by the specified string. If a default handler for the specified key is already registered, it is returned; otherwise, if a standard field with the specified name (static field in this class) exists, it is returned; otherwise, a new instance is created with default parameters:
    new MonitorField(key, key, null), and registered as the default handler for the key.
    
    Parameters:
    
    key - Attribute key.
    
    Returns:
    
    Registered instance for the specified key.
  - getRegisteredInstance
```
public static MonitorField getRegisteredInstance(String key)
```
    Returns an instance registered as the default handler for the attribute identified by the specified key, or null if no such instance exists.
    
    Parameters:
    
    key - Attribute key.
    
    Returns:
    
    Registered instance, or null if no such instance exists.
  - getDefaultFields
```
public static List<MonitorField> getDefaultFields(Collection<String> keys)
```
  - getAffectedFields
```
public static List<MonitorField> getAffectedFields(Collection<String> keys,
                                                   Collection<MonitorField> fields)
```
  - getAffectedFields
```
public static List<MonitorField> getAffectedFields(Collection<String> keys)
```
  - getValue
```
public Object getValue(AgentChannel channel)
```
    Returns the current value of this field in the specified data channel, or null if the channel does not contain a value for this field.
    
    Parameters:
    
    channel - Data channel.
    
    Returns:
    
    Current value of this field.
  - getKey
```
public String getKey()
```
    Returns a unique key of this field.
    
    Returns:
    
    Name of this field.
  - getTitle
```
public String getTitle()
```
    Returns human readable title associated with this field.
    
    Returns:
    
    Title of this field.
  - getKeys
```
public Set<String> getKeys()
```
    Returns a set of keys of data channel attributes that might effect the value of this field or its formatting. For fields that are not updated throughout lifetime of a subsystem, this method returns an empty set.
    
    Returns:
    
    Set of attribute keys that might affect this field.
  - isUpdatable
```
public boolean isUpdatable()
```
  - format
```
public FormattedValue format(AgentChannel channel)
```
    Computes the current formatted value of this field in the specified data channel. Implementation provided by this class clones template and passes it to defaultFormat(...). Subclasses may add processing before or after the call to defaultFormat(...) (or re-implement this method from scratch).
    
    Parameters:
    
    channel - Data channel.
    
    Returns:
    
    Formatted value of this field.
  - format
```
public FormattedValue format(List<AgentChannel> channels)
```
    Computes the current formatted value of this field for the specified list of channels.
    
    Parameters:
    
    channels - List of channels.
    
    Returns:
    
    Formatted value (FormattedValue.NA if this field does not support formatting multiple channels).
  - defaultFormat
```
protected FormattedValue defaultFormat(AgentChannel channel,
                                       FormattedValue fv)
```
    Applies standard formatting, without overwriting fields already set on the provided FormattedValue.
    
    Parameters:
    
    channel - Data channel.
    
    fv - Partially formatted value.
    
    Returns:
    
    Formatted value.
  - colorConfigurationParameter
```
protected FormattedValue colorConfigurationParameter(FormattedValue fv,
                                                     AgentChannel channel)
```
    Applies configuration parameter specific formatting.
    
    Parameters:
    
    fv - Original formatted value. fv.value should be an instance of ConfigurationParameterInfo.
    
    channel - Data channel.
    
    Returns:
    
    Modified formatted value.
  - merge
```
public FormattedValue merge(List<FormattedValue> values)
```
    Merges zero or more formatted values.
    
    Parameters:
    
    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.
  - toString
```
public String toString()
```
    Returns the human readable title of this field.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    Title of this field.
  - stringToField
```
public static MonitorField stringToField(String field)
```
    Returns MonitorField given its string representation. The default implementation selects from #AVAILABLE_GROUP_FIELDS, and returns DEFAULT_GROUP_FIELD if none matches.
    
    Parameters:
    
    field - String representation of MonitorField.
    
    Returns:
    
    MonitorField corresponding to the provided string.
  - fieldToString
```
public static String fieldToString(MonitorField field)
```
    Converts MonitorField to its string representation. The default implementation uses toString().
    
    Parameters:
    
    field - MonitorField constant to convert.
    
    Returns:
    
    String representation.

Class MonitorField

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLOR_FG

COLOR_BG

COLOR_CHANGED

COLOR_GOOD

COLOR_WARN

COLOR_ERR

COLOR_DISABLED

COLOR_OFF

COLOR_POPUP

COLOR_MULTI

COLOR_NA

COLOR_STATE

TEXT_MULTI

HA_MULTI

NULL

NAME

VALUE

UNITS

LOW_ALARM

LOW_WARN

ALERT_LOW

HIGH_ALARM

HIGH_WARN

ALERT_HIGH

DESCR

AVERAGE_VALUE

MAX_VALUE

MIN_VALUE

MEDIAN_VALUE

HOST

DEFAULT_GROUP_FIELD

GROUP_FIELDS

DEFAULT_FLOAT_FORMAT

DEFAULT_INT_FORMAT

DEFAULT_DT_FORMAT

LENGTH_LIMIT

key

title

template

keys

Constructor Detail

MonitorField

MonitorField

MonitorField

Method Detail

registerInstance

getInstance

getRegisteredInstance

getDefaultFields

getAffectedFields

getAffectedFields

getValue

getKey

getTitle

getKeys

isUpdatable

format

format

defaultFormat

colorConfigurationParameter

merge

mergeConfigColor

mergeStateColor

toString

stringToField

fieldToString