org.arm4.arm40.metric
Class ArmMetric

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

All Implemented Interfaces:

ArmMetric, ArmInterface

Direct Known Subclasses:

ArmMetricCounter32, ArmMetricCounter64, ArmMetricCounterFloat32, ArmMetricGauge32, ArmMetricGauge64, ArmMetricGaugeFloat32, ArmMetricNumericId32, ArmMetricNumericId64, ArmMetricString32

public class ArmMetric
extends ArmInterface
implements ArmMetric

The superclass for all the metric interfaces. The common behavior of all metric subclasses is:

• getDefinition() returns the descriptive metadata (name, units, usage, ID) about the metric. The returned object will be the appropriate subclass of ArmMetricDefinition
• Each subclass is also expected to implement get() and set() methods that take and/or return data of the appropriate type for the subclass. These methods are not defined in this interface because they have different signatures, depending on the type of metric.

Objects that implement a subclass of ArmMetric are used with ArmTransactionWithMetrics and / or ArmTranReportWithMetrics. They are bound via ArmMetricGroup when the ArmTransactionWithMetrics or ArmTranReportWithMetrics instance is created. Each ArmMetric instance can be bound to any number of transaction instances.

Setting the value of the ArmMetric instance effectively sets the value for all the transaction instances to which it is bound. The value affects each ArmTransactionWithMetrics instance the next time a start(), update(), or stop() is executed on the instance. The value affects each ArmTranReportWithMetrics instance the next time a report() is executed on the instance.

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

Version:

$Revision$ $Date$

Author:

dcarter

Field Summary

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

m_errorCode, m_factory

Constructor Summary

protected

ArmMetric(ArmMetricDefinition definition) Create ARM Metric.

Method Summary

ArmMetricDefinition

getDefinition()

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

Constructor Detail

ArmMetric

protected ArmMetric(ArmMetricDefinition definition)

Create ARM Metric.

Parameters:

definition - the descriptive metadata (name, units, usage, ID) for the metric

Method Detail

getDefinition

public ArmMetricDefinition getDefinition()

Specified by:

getDefinition in interface ArmMetric

Returns:

the descriptive metadata (name, units, usage, ID) about the metric.