Provides methods to create instances of the classes in the org.opengroup.arm40.metric package. More...

Inheritance diagram for org.opengroup.arm40.metric.ArmMetricFactory:

Public Member Functions
ArmMetricCounter32Definition	newArmMetricCounter32Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricCounter64Definition	newArmMetricCounter64Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricCounterFloat32Definition	newArmMetricCounterFloat32Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricGauge32Definition	newArmMetricGauge32Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricGauge64Definition	newArmMetricGauge64Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricGaugeFloat32Definition	newArmMetricGaugeFloat32Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricNumericId32Definition	newArmMetricNumericId32Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricNumericId64Definition	newArmMetricNumericId64Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricString32Definition	newArmMetricString32Definition (ArmApplicationDefinition app, String name, String units, short usage, ArmID id)
	Creates a new metadata instance.
ArmMetricGroupDefinition	newArmMetricGroupDefinition (ArmMetricDefinition[] definitions)
	Creates an ordered set of `ArmMetricDefinition` subclasses ready for binding to transaction definition objects.
ArmTransactionWithMetricsDefinition	newArmTransactionWithMetricsDefinition (ArmApplicationDefinition app, String name, ArmIdentityPropertiesTransaction identityProperties, ArmMetricGroupDefinition definition, ArmID id)
	Creates an object that contains the metadata about a transaction.
ArmMetricCounter32	newArmMetricCounter32 (ArmMetricCounter32Definition definition)
	Creates a new metric instance.
ArmMetricCounter64	newArmMetricCounter64 (ArmMetricCounter64Definition definition)
	Creates a new metric instance.
ArmMetricCounterFloat32	newArmMetricCounterFloat32 (ArmMetricCounterFloat32Definition definition)
	Creates a new metric instance.
ArmMetricGauge32	newArmMetricGauge32 (ArmMetricGauge32Definition definition)
	Creates a new metric instance.
ArmMetricGauge64	newArmMetricGauge64 (ArmMetricGauge64Definition definition)
	Creates a new metric instance.
ArmMetricGaugeFloat32	newArmMetricGaugeFloat32 (ArmMetricGaugeFloat32Definition definition)
	Creates a new metric instance.
ArmMetricNumericId32	newArmMetricNumericId32 (ArmMetricNumericId32Definition definition)
	Creates a new metric instance.
ArmMetricNumericId64	newArmMetricNumericId64 (ArmMetricNumericId64Definition definition)
	Creates a new metric instance.
ArmMetricString32	newArmMetricString32 (ArmMetricString32Definition definition)
	Creates a new metric instance.
ArmMetricGroup	newArmMetricGroup (ArmMetricGroupDefinition groupDefinition, ArmMetric[] metrics)
	Creates an ordered set of `ArmMetric` subclasses ready for binding to transaction objects.
ArmTranReportWithMetrics	newArmTranReportWithMetrics (ArmApplication app, ArmTransactionWithMetricsDefinition definition, ArmMetricGroup group)
	Creates an object that represents an instance of a transaction with an `ArmTranReport` interface.
ArmTransactionWithMetrics	newArmTransactionWithMetrics (ArmApplication app, ArmTransactionWithMetricsDefinition definition, ArmMetricGroup group)
	Creates an object that represents an instance of a transaction.
boolean	setErrorCallback (ArmErrorCallback errorCallback)
	Registers an error callback for objects created through this factory.
Static Public Attributes
static final String	propertyKey = "Arm40.ArmMetricFactory"
	name of system property holding the implementation class name.

Detailed Description

Provides methods to create instances of the classes in the org.opengroup.arm40.metric package.

An error callback method can be registered for objects created with this factory (see setErrorCallback(ArmErrorCallback)). For additional details about error handling philosophy see the description in org.opengroup.arm40.transaction.ArmTransactionFactory.

Semantics of the factory methods are provided in the description of the individual methods below.

ArmMetricFactory is instantiated using a class loader. The actual name of the factory implementation class is obtained from the system property whose name is provided in the propertyKey constant.

Author:: ARM Working Group of The Open Group

Member Function Documentation

ArmMetricCounter32 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricCounter32 ( ArmMetricCounter32Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricCounter32Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricCounter32Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

See also:: ArmMetricDefinition

ArmMetricCounter64 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricCounter64 ( ArmMetricCounter64Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricCounter64Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricCounter64Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricCounterFloat32 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricCounterFloat32 ( ArmMetricCounterFloat32Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricCounterFloat32Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricCounterFloat32Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricGauge32 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGauge32 ( ArmMetricGauge32Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricGauge32Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGauge32Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricGauge64 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGauge64 ( ArmMetricGauge64Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricGauge64Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGauge64Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricGaugeFloat32 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGaugeFloat32 ( ArmMetricGaugeFloat32Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricGaugeFloat32Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGaugeFloat32Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricGroup org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGroup	(	ArmMetricGroupDefinition	groupDefinition,
		ArmMetric[]	metrics
	)

Creates an ordered set of ArmMetric subclasses ready for binding to transaction objects.

Parameters:

	groupDefinition	metadata object describing the metrics provided through the `metrics` parameter.
	metrics	an array of ArmMetric objects.

The ordering in the array is important. The array can have up to seven elements and is position-sensitive. To remain consistent with ARM 2.0, any ArmMetric subclass except ArmMetricString32 can be assigned to elements 0:5 and only ArmMetricString32 can be assigned to element 6. The ArmMetricDefinition objects associated with each ArmMetric object must have the exact same values as the ArmMetricDefinition objects associated with the ArmMetricGroupDefinition object (they will often be the same objects, though this is not mandatory).

Any element can be null. If the input array has fewer than seven elements, the rest of the elements are assigned a value of null. The array can be sparsely populated. For example, there can be a non-null ArmMetric reference in element 0 and 6, and null references in elements 1:5.

Returns:: a new metric group instance.

ArmMetricGroupDefinition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricGroupDefinition ( ArmMetricDefinition[] definitions )

Creates an ordered set of ArmMetricDefinition subclasses ready for binding to transaction definition objects.

Parameters:

definitions

An array of ArmMetricDefinition objects.

The ordering in the array is important. The array can have up to seven elements and is position-sensitive. To remain consistent with ARM 2.0, any ArmMetricDefinition subclass except ArmMetricString32Definition can be assigned to elements 0:5 and only ArmMetricString32Definition can be assigned to element 6.

Any element can be null. If the input array has fewer than seven elements, the rest of the elements are assigned a value of null. The array can be sparsely populated. For example, there can be a non-null ArmMetricDefinition reference in element 0 and 6, and null references in elements 1:5.

Returns:: a new metadata instance for the metric definition group.

ArmMetricNumericId32 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricNumericId32 ( ArmMetricNumericId32Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricNumericId32Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricNumericId32Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricNumericId64 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricNumericId64 ( ArmMetricNumericId64Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricNumericId64Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricNumericId64Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmMetricString32 org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricString32 ( ArmMetricString32Definition definition )

Creates a new metric instance.

Parameters:

definition

the metadata describing this metric.

Returns:: a new metric instance.

ArmMetricString32Definition org.opengroup.arm40.metric.ArmMetricFactory.newArmMetricString32Definition	(	ArmApplicationDefinition	app,
		String	name,
		String	units,
		short	usage,
		ArmID	id
	)

Creates a new metadata instance.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	units	units descrioption, or `null`.
	usage	One of ArmMetricDefinition#METRIC_USE_GENERAL, ArmMetricDefinition#METRIC_USE_TRAN_SIZE, ArmMetricDefinition#METRIC_USE_TRAN_STATUS, or an application-specific negative value.
	id	ID provided by the application for this metric definition, or `null`.

Returns:: a new metadata instance for this definition.

ArmTranReportWithMetrics org.opengroup.arm40.metric.ArmMetricFactory.newArmTranReportWithMetrics	(	ArmApplication	app,
		ArmTransactionWithMetricsDefinition	definition,
		ArmMetricGroup	group
	)

Creates an object that represents an instance of a transaction with an ArmTranReport interface.

Parameters:

	app	instance of the containing application (scope).
	definition	metadata about the transaction.
	group	metrics binding object.

If the metric group reference is null, the resulting ArmTranReportWithMetrics has no metrics, so it would have no more functions than an ArmTranReport object, except to return null to the ArmTranReportWithMetrics#getMetricGroup method.

Returns:: a new transaction instance associated with metrics.

ArmTransactionWithMetrics org.opengroup.arm40.metric.ArmMetricFactory.newArmTransactionWithMetrics	(	ArmApplication	app,
		ArmTransactionWithMetricsDefinition	definition,
		ArmMetricGroup	group
	)

Creates an object that represents an instance of a transaction.

Parameters:

	app	instance of the containing application (scope).
	definition	metadata about the transaction.
	group	metrics binding object.

If the metric group reference is null, the resulting ArmTranReportWithMetrics has no metrics, so it would have no more functions than an ArmTranReport object, except to return null to the ArmTranReportWithMetrics#getMetricGroup method.

Returns:: a new transaction instance associated with metrics.

ArmTransactionWithMetricsDefinition org.opengroup.arm40.metric.ArmMetricFactory.newArmTransactionWithMetricsDefinition	(	ArmApplicationDefinition	app,
		String	name,
		ArmIdentityPropertiesTransaction	identityProperties,
		ArmMetricGroupDefinition	definition,
		ArmID	id
	)

Creates an object that contains the metadata about a transaction.

Details about the metadata are found in the org.opengroup.arm40.transaction.ArmTransactionDefinition section. In addition, a binding to a set of metadata about metrics is added via an ArmMetricGroupDefinition object.

Parameters:

	app	metadata about the containing application.
	name	name for this definition.
	identityProperties	an initialized set of identity properties.
	definition	the metric definitions to be used with this transaction.
	id	ID provided by the application for this transaction definition, or `null`.

Returns:: a new metadata instance for a transaction associated with metrics.

boolean org.opengroup.arm40.metric.ArmMetricFactory.setErrorCallback ( ArmErrorCallback errorCallback )

Registers an error callback for objects created through this factory.

See the error handling philosophy comment in the description of org.opengroup.arm40.transaction.ArmTransactionFactory.

Parameters:

errorCallback an application object implementing the ArmErrorCallback interface.

Returns:: true if registration is accepted.

See also:: org.opengroup.arm40.transaction.ArmTransactionFactory.setErrorCallback

The documentation for this interface was generated from the following file:

org/opengroup/arm40/metric/ArmMetricFactory.java

All Classes Functions Variables

MyARM - Application Response Measurement (ARM) supported APIs

org.opengroup.arm40.metric.ArmMetricFactory Interface Reference
[ARM 4.0 Metrics, ARM 4.0 Factories]

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

MyARM - Application Response Measurement (ARM) supported APIs

org.opengroup.arm40.metric.ArmMetricFactory Interface Reference [ARM 4.0 Metrics, ARM 4.0 Factories]

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

org.opengroup.arm40.metric.ArmMetricFactory Interface Reference
[ARM 4.0 Metrics, ARM 4.0 Factories]