org.opengroup.arm40.metric
public interface ArmMetricFactory extends ArmInterface
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.
Field Summary | |
---|---|
static String | propertyKey
name of system property holding the implementation class name. |
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
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.
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
Parameters: definition the metadata describing this metric.
Returns: a new metric instance.
Parameters: app metadata about the containing application. name name for this definition. units units descrioption, or null
. usage One of
METRIC_USE_GENERAL,
METRIC_USE_TRAN_SIZE,
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.
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 method.
Returns: a new transaction instance associated with metrics.
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 method.
Returns: a new transaction instance associated with metrics.
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.
Parameters: errorCallback an application object implementing the
ArmErrorCallback> interface.
Returns: true
if registration is accepted.
See Also: ArmTransactionFactory