org.arm4.arm40.metric
Class ArmMetricDefinition

java.lang.Object
  org.arm4.arm40.transaction.ArmInterface
      org.arm4.arm40.metric.ArmMetricDefinition

All Implemented Interfaces:

ArmMetricDefinition, ArmInterface

Direct Known Subclasses:

ArmMetricCounter32Definition, ArmMetricCounter64Definition, ArmMetricCounterFloat32Definition, ArmMetricGauge32Definition, ArmMetricGauge64Definition, ArmMetricGaugeFloat32Definition, ArmMetricNumericId32Definition, ArmMetricNumericId64Definition, ArmMetricString32Definition

public class ArmMetricDefinition
extends ArmInterface
implements ArmMetricDefinition

The superclass for all the metric definition interfaces. All the methods are defined in ArmMetricDefinition. The subclasses serve as markers for the data types. All the publicly accessible attributes are immutable and have a getter method for them.

The attributes are:

• The definition of the application that contains the transaction. It must not be null.
• Name. The maximum length is 127 characters. The name must not be null or zero-length.
• Units. An optional string describing the units of measurement, such as "files" or "jobs in queue". It may be null.
• Usage. Describes any additional information about the semantics of the metric. Most metrics will be classified as "general", indicating that there is no specific semantic declared. The two specific semantics are the size of the transaction, such as the number of files that were backed up, and a status that could contain data, such as an error code that describes why a transaction failed. See the field descriptions of METRIC_USE_... below for the defined values. Any negative value is also permitted; the negative range is reserved for application-specific values.
• Optional ID. An optional 16-byte ID may be associated with the identity of a metric definition. The returned value, which could be null, is the same value passed to the factory method [e.g., ArmMetricFactory.newArmMetricCounter32Definition(org.opengroup.arm40.transaction.ArmApplicationDefinition, java.lang.String, java.lang.String, short, org.opengroup.arm40.transaction.ArmID)]. The ID value is bound to a unique combination of the metric format (e.g., Counter32), name, usage, and unit properties. When provided, the ID may be used as a concise alias for the unique combination. It may be null.

This class cannot be instantiated. Objects that implement a subclass of ArmMetricDefinition are created using the newArmMetric...Definition() methods of ArmMetricFactory.

Version:

$Revision$ $Date$

Author:

dcarter

Field Summary

protected static short	ARM_METRIC_FORMAT_CNTRDIVR32
protected static short	ARM_METRIC_FORMAT_COUNTER32
protected static short	ARM_METRIC_FORMAT_COUNTER64
protected static short	ARM_METRIC_FORMAT_GAUGE32
protected static short	ARM_METRIC_FORMAT_GAUGE64
protected static short	ARM_METRIC_FORMAT_GAUGEDIVR32
protected static short	ARM_METRIC_FORMAT_NUMERICID32
protected static short	ARM_METRIC_FORMAT_NUMERICID64
protected static short	ARM_METRIC_FORMAT_STRING32
protected ArmApplicationDefinition	m_appDefinition
protected short	m_format
protected ArmID	m_metricId
protected java.lang.String	m_name
protected java.lang.String	m_units
protected short	m_usage
static short	METRIC_USE_GENERAL No specific usage semantics are declared.
static short	METRIC_USE_TRAN_SIZE Metric represents the "size" of the transaction (counter & gauge only).
static short	METRIC_USE_TRAN_STATUS Metric represents status, like an error code (numeric ID & string only).

Fields inherited from class org.arm4.arm40.transaction.ArmInterface

m_errorCode, m_factory

Constructor Summary

ArmMetricDefinition(ArmApplicationDefinition definition, java.lang.String name, java.lang.String units, short usage, short format, ArmID id)
Create the Arm Metric Definition.

Method Summary

ArmApplicationDefinition	getApplicationDefinition()
ArmID	getID() Gets the (optional) ID for this definition.
java.lang.String	getName() Gets the name of this definition.
java.lang.String	getUnits() Gets the (optional) units description.
short	getUsage() Gets the usage semantics.

Methods inherited from class org.arm4.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, setErrorCode

Field Detail

METRIC_USE_GENERAL

public static final short METRIC_USE_GENERAL

No specific usage semantics are declared.

See Also:

Constant Field Values

METRIC_USE_TRAN_SIZE

public static final short METRIC_USE_TRAN_SIZE

Metric represents the "size" of the transaction (counter & gauge only).

See Also:

Constant Field Values

METRIC_USE_TRAN_STATUS

public static final short METRIC_USE_TRAN_STATUS

Metric represents status, like an error code (numeric ID & string only).

See Also:

Constant Field Values

ARM_METRIC_FORMAT_COUNTER32

protected static final short ARM_METRIC_FORMAT_COUNTER32

See Also:

Constant Field Values

ARM_METRIC_FORMAT_COUNTER64

protected static final short ARM_METRIC_FORMAT_COUNTER64

See Also:

Constant Field Values

ARM_METRIC_FORMAT_CNTRDIVR32

protected static final short ARM_METRIC_FORMAT_CNTRDIVR32

See Also:

Constant Field Values

ARM_METRIC_FORMAT_GAUGE32

protected static final short ARM_METRIC_FORMAT_GAUGE32

See Also:

Constant Field Values

ARM_METRIC_FORMAT_GAUGE64

protected static final short ARM_METRIC_FORMAT_GAUGE64

See Also:

Constant Field Values

ARM_METRIC_FORMAT_GAUGEDIVR32

protected static final short ARM_METRIC_FORMAT_GAUGEDIVR32

See Also:

Constant Field Values

ARM_METRIC_FORMAT_NUMERICID32

protected static final short ARM_METRIC_FORMAT_NUMERICID32

See Also:

Constant Field Values

ARM_METRIC_FORMAT_NUMERICID64

protected static final short ARM_METRIC_FORMAT_NUMERICID64

See Also:

Constant Field Values

ARM_METRIC_FORMAT_STRING32

protected static final short ARM_METRIC_FORMAT_STRING32

See Also:

Constant Field Values

m_appDefinition

protected ArmApplicationDefinition m_appDefinition

m_name

protected java.lang.String m_name

m_units

protected java.lang.String m_units

m_usage

protected short m_usage

m_format

protected short m_format

m_metricId

protected ArmID m_metricId

Constructor Detail

ArmMetricDefinition

public ArmMetricDefinition(ArmApplicationDefinition definition,
                           java.lang.String name,
                           java.lang.String units,
                           short usage,
                           short format,
                           ArmID id)

Create the Arm Metric Definition.

Parameters:

definition -

name -

units -

usage -

format -

id -

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ArmMetricDefinition

Gets the name of this definition.

Specified by:

getName in interface ArmMetricDefinition

Returns:

the definition name.

getUnits

public java.lang.String getUnits()

Description copied from interface: ArmMetricDefinition

Gets the (optional) units description.

Specified by:

getUnits in interface ArmMetricDefinition

Returns:

the units desciption or null.

getUsage

public short getUsage()

Description copied from interface: ArmMetricDefinition

Gets the usage semantics.

Specified by:

getUsage in interface ArmMetricDefinition

Returns:

One of ArmMetricDefinition.METRIC_USE_GENERAL, ArmMetricDefinition.METRIC_USE_TRAN_SIZE, ArmMetricDefinition.METRIC_USE_TRAN_STATUS, or an application-specific negative value.

getID

public ArmID getID()

Description copied from interface: ArmMetricDefinition

Gets the (optional) ID for this definition.

Specified by:

getID in interface ArmMetricDefinition

Returns:

the ID or null.

getApplicationDefinition

public ArmApplicationDefinition getApplicationDefinition()