org.opengroup.arm40.metric
Interface ArmMetricDefinition

All Superinterfaces:

ArmInterface

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface ArmMetricDefinition
extends ArmInterface

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.

Author:

ARM Working Group of The Open Group

Field Summary

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

Method Summary

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 interface org.opengroup.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, setErrorCode

Field Detail

METRIC_USE_GENERAL

static final short METRIC_USE_GENERAL

No specific usage semantics are declared.

See Also:

Constant Field Values

METRIC_USE_TRAN_SIZE

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

static final short METRIC_USE_TRAN_STATUS

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

See Also:

Constant Field Values

Method Detail

getID

ArmID getID()

Gets the (optional) ID for this definition.

Returns:

the ID or null.

getName

java.lang.String getName()

Gets the name of this definition.

Returns:

the definition name.

getUnits

java.lang.String getUnits()

Gets the (optional) units description.

Returns:

the units desciption or null.

getUsage

short getUsage()

Gets the usage semantics.

Returns:

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