org.lsst.ccs.gconsole.plugins.monitor

Class MonitorField

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.MonitorField

public class MonitorField
extends Object

Identifier for a data, metadata, or attribute that may be associated with a monitored channel. Also identifies a column in a monitoring table, and may contain hints on how that column should be rendered.

Equality and hash code are based on the name parameter provided to the constructor and returned by name() method.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static MonitorField	ALERT_HIGH
static MonitorField	ALERT_LOW
static MonitorField	DESCR
static String	FORMAT_KEY
static MonitorField	HIGH
static MonitorField	HIGH_WARN
static String	ID_KEY
static MonitorField	LOW
static MonitorField	LOW_WARN
static MonitorField	NAME
static MonitorField	NULL
static String	PAGE_KEY
static String	SECTION_KEY
static String	STATE_KEY
static MonitorField	UNITS
static MonitorField	VALUE

Constructor Summary

Constructors

Constructor and Description
MonitorField(String name, String title, boolean updatable, boolean editable) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static MonitorField	getInstance(String name) Returns an instance with the specified name.
static MonitorField	getInstance(String name, String title, boolean updatable, boolean editable) Returns a newly created instance with the specified parameters.
String	getTitle() Returns human readable title associated with this field.
int	hashCode()
boolean	isEditable()
boolean	isUpdatable()
String	name() Returns a unique name of this field.
String	toString() Returns the name of this field.
static MonitorField	valueOf(String name) Returns an instance with the specified name, or null if no such instance exists.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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

public static final MonitorField LOW

ALERT_LOW

public static final MonitorField ALERT_LOW

HIGH

public static final MonitorField HIGH

ALERT_HIGH

public static final MonitorField ALERT_HIGH

DESCR

public static final MonitorField DESCR

LOW_WARN

public static final MonitorField LOW_WARN

HIGH_WARN

public static final MonitorField HIGH_WARN

ID_KEY

public static final String ID_KEY

See Also:

Constant Field Values

PAGE_KEY

public static final String PAGE_KEY

See Also:

Constant Field Values

STATE_KEY

public static final String STATE_KEY

See Also:

Constant Field Values

FORMAT_KEY

public static final String FORMAT_KEY

See Also:

Constant Field Values

SECTION_KEY

public static final String SECTION_KEY

See Also:

Constant Field Values

Constructor Detail

MonitorField

public MonitorField(String name,
                    String title,
                    boolean updatable,
                    boolean editable)

Constructs an instance.

Parameters:

name - Unique string ID. Used as the last key segment in status messages.

title - Human readable title.

updatable - true if this field is not guaranteed to remain constant.

editable - true if this field is editable through monitoring views.

Method Detail

getInstance

public static MonitorField getInstance(String name,
                                       String title,
                                       boolean updatable,
                                       boolean editable)

Returns a newly created instance with the specified parameters. Instances created with this method can be later looked up by calling valueOf(String).

Parameters:

name - Unique string ID. Used as the last key segment in status messages.

title - Human readable title.

updatable - true if this field is not guaranteed to remain constant.

editable - true if this field is editable through monitoring views.

Returns:

New instance.

Throws:

IllegalArgumentException - if an instance with this id already exists.

getInstance

public static MonitorField getInstance(String name)

Returns an instance with the specified name. If an instance with the specified name already exists, it is returned; otherwise, a new instance is created with default parameters (title equal to name, updatable, not editable).

Parameters:

name - Unique string ID. Used as the last key segment in status messages.

Returns:

An instance with the specified name.

valueOf

public static MonitorField valueOf(String name)

Returns an instance with the specified name, or null if no such instance exists.

Parameters:

name - Field name.

Returns:

Instance with the specified name, or null if no such instance exists.

name

public String name()

Returns a unique name 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.

isUpdatable

public boolean isUpdatable()

isEditable

public boolean isEditable()

toString

public String toString()

Returns the name of this field.

Overrides:

toString in class Object

Returns:

Name of this field.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object