org.arm4.arm40.metric
Class ArmTranReportWithMetrics

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

public class ArmTranReportWithMetrics
extends ArmTranReport
implements ArmTranReportWithMetrics

A subclass of ArmTranReport that is used if the application wishes to use metrics. All the ArmTranReport rules for using report() apply to this interface. It extends ArmTranReport by adding methods to manipulate metrics. The ArmMetric subclass objects are bound to an ArmTranReportWithMetrics object when it is created. This is done by specifying ArmMetricGroup in the newArmTranReportWithMetrics() method of ArmMetricFactory.

Objects implementing this interface are created using ArmMetricFactory.newArmTranReportWithMetrics(org.opengroup.arm40.transaction.ArmApplication, org.opengroup.arm40.metric.ArmTransactionWithMetricsDefinition, org.opengroup.arm40.metric.ArmMetricGroup).

Version:
$Revision$ $Date$
Author:
dcarter

Field Summary
 
Fields inherited from class org.arm4.arm40.tranreport.ArmTranReport
m_responseTime, m_status
 
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_traceRequested, m_transactionHandle, m_user
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmTranReportWithMetrics(ArmApplication app, ArmTransactionWithMetricsDefinition definition, ArmMetricGroup group, ArmFactory factory)
          Create ARM Transaction Report with Metrics.
 
Method Summary
 ArmApplication getApplication()
          gets the contaning application instance.
 ArmMetricGroup getMetricGroup()
          Get the metric group.
 ArmTransactionWithMetricsDefinition getTransactionWithMetricsDefinition()
           
 
Methods inherited from class org.arm4.arm40.tranreport.ArmTranReport
generateCorrelator, getResponseTime, getStatus, report, report, report, report
 
Methods inherited from class org.arm4.arm40.transaction.ArmTransaction
bindThread, blocked, getContextURIValue, getContextValue, getCorrelator, getDefinition, getParentCorrelator, 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.tranreport.ArmTranReport
generateCorrelator, getContextURIValue, getContextValue, getCorrelator, getDefinition, getParentCorrelator, getResponseTime, getStatus, getUser, report, report, report, report, setContextURIValue, setContextValue, setParentCorrelator, setUser
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Constructor Detail

ArmTranReportWithMetrics

public ArmTranReportWithMetrics(ArmApplication app,
                                ArmTransactionWithMetricsDefinition definition,
                                ArmMetricGroup group,
                                ArmFactory factory)
Create ARM Transaction Report with Metrics.

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

getApplication

public ArmApplication getApplication()
Description copied from interface: ArmTransaction
gets the contaning application instance. returns the value passed to the newArmTransaction() method of ArmTransactionFactory.

Specified by:
getApplication in interface ArmTranReport
Specified by:
getApplication in interface ArmTransaction
Overrides:
getApplication in class ArmTransaction
Returns:
the object that contains the application definitions.

getTransactionWithMetricsDefinition

public ArmTransactionWithMetricsDefinition getTransactionWithMetricsDefinition()
Specified by:
getTransactionWithMetricsDefinition in interface ArmTranReportWithMetrics
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 ArmTranReportWithMetrics
Overrides:
getMetricGroup in class ArmTransaction
Returns:
the object that was bound when ArmTranReportWithMetrics is created. The returned value may be null.