org.arm4.arm40.metric
Class ArmMetricDefinition

java.lang.Object
  extended by org.arm4.arm40.transaction.ArmInterface
      extended by 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:

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()