com.tibco.rta.runtime.metric
Class SingleValueMetricFunction<N>

java.lang.Object
  com.tibco.rta.runtime.metric.AbstractMetricFunction<N>
      com.tibco.rta.runtime.metric.SingleValueMetricFunction<N>

All Implemented Interfaces:

MetricFunction<N>

public abstract class SingleValueMetricFunction<N>
extends AbstractMetricFunction<N>

Providers of metric computations should implement this interface. The metric computation engine will call into this interface's compute method in order to acquire its metric value.

Constructor Summary

SingleValueMetricFunction()

Method Summary

abstract N

compute(MetricNode metricNode, SingleValueMetric<N> metric, RtaNodeContext context) Implementation classes will provide the algorithm to compute the metric values via this method It will be given a MetricNode to for which the metric value needs to be computed

Methods inherited from class com.tibco.rta.runtime.metric.AbstractMetricFunction

init

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleValueMetricFunction

public SingleValueMetricFunction()

Method Detail

compute

public abstract N compute(MetricNode metricNode,
                          SingleValueMetric<N> metric,
                          RtaNodeContext context)
                   throws java.lang.Exception

Implementation classes will provide the algorithm to compute the metric values via this method It will be given a MetricNode to for which the metric value needs to be computed

Parameters:

metricNode - The metric node for which the metric value needs to be computed

Returns:

true if the metric computation should propagate or rollup to its parent, false otherwise

Throws:

java.lang.Exception - if any problem was encountered during metric computation depending on the implementation