org.arm4.arm40.metric
Class ArmTransactionWithMetrics

java.lang.Object
  extended by org.arm4.arm40.transaction.ArmInterface
      extended by org.arm4.arm40.transaction.ArmTransaction
          extended by org.arm4.arm40.metric.ArmTransactionWithMetrics
All Implemented Interfaces:
ArmTransactionWithMetrics, ArmInterface, ArmTransaction

public class ArmTransactionWithMetrics
extends ArmTransaction
implements ArmTransactionWithMetrics

ArmTransactionWithMetrics is a subclass of ArmTransaction that is used if the application wishes to use metrics. Instances of ArmTransactionWithMetrics are created using the newArmTransactionWithMetrics() method of ArmMetricFactory.

Version:
$Revision$ $Date$
Author:
dcarter

Field Summary
 
Fields inherited from class org.arm4.arm40.transaction.ArmTransaction
ARM_SUCCESS, m_application, m_arrivalTime, m_contextUri, m_contextValues, m_currentCorrelator, m_definition, m_metricGroup, m_parentCorrelator, m_status, m_traceRequested, m_transactionHandle, m_user
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmTransactionWithMetrics(ArmApplication app, ArmTransactionWithMetricsDefinition def, ArmMetricGroup group, ArmFactory factory)
          Create ARM Transaction with Metrics.
 
Method Summary
 ArmMetricGroup getMetricGroup()
          Get the metric group.
 ArmTransactionWithMetricsDefinition getTransactionWithMetricsDefinition()
           
 
Methods inherited from class org.arm4.arm40.transaction.ArmTransaction
bindThread, blocked, getApplication, getContextURIValue, getContextValue, getCorrelator, getDefinition, getParentCorrelator, getStatus, getUser, isTraceRequested, reset, setArrivalTime, setContextURIValue, setContextValue, setCorrelator, setParentCorrelator, setTraceRequested, setUser, start, start, start, start, stop, stop, unbindThread, unblocked, update
 
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.ArmTransaction
bindThread, blocked, getApplication, getContextURIValue, getContextValue, getCorrelator, getDefinition, getParentCorrelator, getStatus, getUser, isTraceRequested, reset, setArrivalTime, setContextURIValue, setContextValue, setTraceRequested, setUser, start, start, start, start, stop, stop, unbindThread, unblocked, update
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Constructor Detail

ArmTransactionWithMetrics

public ArmTransactionWithMetrics(ArmApplication app,
                                 ArmTransactionWithMetricsDefinition def,
                                 ArmMetricGroup group,
                                 ArmFactory factory)
Create ARM Transaction with Metrics.

Parameters:
app -
def -
group -
factory -
Method Detail

getTransactionWithMetricsDefinition

public ArmTransactionWithMetricsDefinition getTransactionWithMetricsDefinition()
Specified by:
getTransactionWithMetricsDefinition in interface ArmTransactionWithMetrics
Returns:
the object that contains the metadata describing this transaction, including the metric definitions.

getMetricGroup

public ArmMetricGroup getMetricGroup()
Description copied from class: ArmTransaction
Get the metric group.

Specified by:
getMetricGroup in interface ArmTransactionWithMetrics
Overrides:
getMetricGroup in class ArmTransaction
Returns:
the object that was bound when ArmTransactionWithMetrics is created. The returned value may be null.