org.arm4.arm40.metric

Class ArmMetricDefinition

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:

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 shortARM_METRIC_FORMAT_CNTRDIVR32
protected static shortARM_METRIC_FORMAT_COUNTER32
protected static shortARM_METRIC_FORMAT_COUNTER64
protected static shortARM_METRIC_FORMAT_GAUGE32
protected static shortARM_METRIC_FORMAT_GAUGE64
protected static shortARM_METRIC_FORMAT_GAUGEDIVR32
protected static shortARM_METRIC_FORMAT_NUMERICID32
protected static shortARM_METRIC_FORMAT_NUMERICID64
protected static shortARM_METRIC_FORMAT_STRING32
protected ArmApplicationDefinitionm_appDefinition
protected shortm_format
protected ArmIDm_metricId
protected Stringm_name
protected Stringm_units
protected shortm_usage
static shortMETRIC_USE_GENERAL
No specific usage semantics are declared.
static shortMETRIC_USE_TRAN_SIZE
Metric represents the "size" of the transaction (counter & gauge only).
static shortMETRIC_USE_TRAN_STATUS
Metric represents status, like an error code (numeric ID & string only).
Constructor Summary
ArmMetricDefinition(ArmApplicationDefinition definition, String name, String units, short usage, short format, ArmID id)
Create the Arm Metric Definition.
Method Summary
ArmApplicationDefinitiongetApplicationDefinition()
ArmIDgetID()
StringgetName()
StringgetUnits()
shortgetUsage()

Field Detail

ARM_METRIC_FORMAT_CNTRDIVR32

protected static final short ARM_METRIC_FORMAT_CNTRDIVR32

ARM_METRIC_FORMAT_COUNTER32

protected static final short ARM_METRIC_FORMAT_COUNTER32

ARM_METRIC_FORMAT_COUNTER64

protected static final short ARM_METRIC_FORMAT_COUNTER64

ARM_METRIC_FORMAT_GAUGE32

protected static final short ARM_METRIC_FORMAT_GAUGE32

ARM_METRIC_FORMAT_GAUGE64

protected static final short ARM_METRIC_FORMAT_GAUGE64

ARM_METRIC_FORMAT_GAUGEDIVR32

protected static final short ARM_METRIC_FORMAT_GAUGEDIVR32

ARM_METRIC_FORMAT_NUMERICID32

protected static final short ARM_METRIC_FORMAT_NUMERICID32

ARM_METRIC_FORMAT_NUMERICID64

protected static final short ARM_METRIC_FORMAT_NUMERICID64

ARM_METRIC_FORMAT_STRING32

protected static final short ARM_METRIC_FORMAT_STRING32

m_appDefinition

protected ArmApplicationDefinition m_appDefinition

m_format

protected short m_format

m_metricId

protected ArmID m_metricId

m_name

protected String m_name

m_units

protected String m_units

m_usage

protected short m_usage

METRIC_USE_GENERAL

public static final short METRIC_USE_GENERAL
No specific usage semantics are declared.

METRIC_USE_TRAN_SIZE

public static final short METRIC_USE_TRAN_SIZE
Metric represents the "size" of the transaction (counter & gauge only).

METRIC_USE_TRAN_STATUS

public static final short METRIC_USE_TRAN_STATUS
Metric represents status, like an error code (numeric ID & string only).

Constructor Detail

ArmMetricDefinition

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

Parameters: definition name units usage format id

Method Detail

getApplicationDefinition

public ArmApplicationDefinition getApplicationDefinition()

getID

public ArmID getID()

getName

public String getName()

getUnits

public String getUnits()

getUsage

public short getUsage()