org.opengroup.arm40.metric.ArmMetricDefinition Interface Reference
[ARM 4.0 MetricsARM 4.0 Definitions]

The superclass for all the metric definition interfaces. More...

Inheritance diagram for org.opengroup.arm40.metric.ArmMetricDefinition:
org.opengroup.arm40.transaction.ArmInterface org.opengroup.arm40.metric.ArmMetricCounter32Definition org.opengroup.arm40.metric.ArmMetricCounter64Definition org.opengroup.arm40.metric.ArmMetricCounterFloat32Definition org.opengroup.arm40.metric.ArmMetricGauge32Definition org.opengroup.arm40.metric.ArmMetricGauge64Definition org.opengroup.arm40.metric.ArmMetricGaugeFloat32Definition org.opengroup.arm40.metric.ArmMetricNumericId32Definition org.opengroup.arm40.metric.ArmMetricNumericId64Definition org.opengroup.arm40.metric.ArmMetricString32Definition

List of all members.

Public Member Functions

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

Static Public Attributes

static final short METRIC_USE_GENERAL = 0
 No specific usage semantics are declared.
static final short METRIC_USE_TRAN_SIZE = 1
 Metric represents the "size" of the transaction (counter & gauge only).
static final short METRIC_USE_TRAN_STATUS = 2
 Metric represents status, like an error code (numeric ID & string only).
static final short EXT_METRIC_USE_TRAN_CONCURRENCY = -3
 Metric explains the concurrent usage of a transaction.

Detailed Description

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]. 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.

ARM Working Group of The Open Group

Member Function Documentation

ArmID org.opengroup.arm40.metric.ArmMetricDefinition.getID (  ) 

Gets the (optional) ID for this definition.

the ID or null.
String org.opengroup.arm40.metric.ArmMetricDefinition.getName (  ) 

Gets the name of this definition.

the definition name.
String org.opengroup.arm40.metric.ArmMetricDefinition.getUnits (  ) 

Gets the (optional) units description.

the units desciption or null.
short org.opengroup.arm40.metric.ArmMetricDefinition.getUsage (  ) 

Gets the usage semantics.


Member Data Documentation

Metric explains the concurrent usage of a transaction.

(gauge only)

The documentation for this interface was generated from the following file:
  • org/opengroup/arm40/metric/