org.ow2.jasmine.probe.collectors
Class JCollector

java.lang.Object
  extended by org.ow2.jasmine.probe.collectors.JCollector
All Implemented Interfaces:
org.ow2.jasmine.probe.collector.JasmineCollector
Direct Known Subclasses:
ConstantCollector

public abstract class JCollector
extends java.lang.Object
implements org.ow2.jasmine.probe.collector.JasmineCollector

This object represents a Collector in use. It may be associated to more than one JProbe It is abstract, because implementation may be various. These implementations are in separate modules.

Author:
durieuxp

Field Summary
protected  org.ow2.jasmine.probe.JasmineIndicator indicator
          Indicator definition
protected  org.ow2.util.log.Log logger
          Logger.
protected  java.lang.String name
          Name used to identify this Collector
protected  int period
          period of polling in seconds
 
Constructor Summary
JCollector(java.lang.String name, org.ow2.jasmine.probe.JasmineIndicator def, int period)
          Constructor
 
Method Summary
protected  long addValues(java.util.Collection<java.lang.Number> values)
          Add a list of values of same type
protected  long diffValues(java.lang.Number v1, java.lang.Number v2)
          Make a diff between 2 values
protected  long divideValues(java.lang.Number v1, java.lang.Number v2)
          Make a div between 2 values
 org.ow2.jasmine.probe.JasmineIndicator getIndicator()
           
abstract  org.ow2.jasmine.probe.JasmineIndicatorValue getLastResult()
          return the last result for this indicator
 java.lang.String getName()
           
protected  long longValue(java.lang.Number nb)
          Try to cast a Number into a long value
protected  long multiplyValues(java.util.Collection<java.lang.Number> values)
          Multiply a list of values of same type
abstract  void startPolling()
          Restart polling
abstract  void stopPolling()
          Stop polling
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected org.ow2.util.log.Log logger
Logger.


indicator

protected org.ow2.jasmine.probe.JasmineIndicator indicator
Indicator definition


period

protected int period
period of polling in seconds


name

protected java.lang.String name
Name used to identify this Collector

Constructor Detail

JCollector

public JCollector(java.lang.String name,
                  org.ow2.jasmine.probe.JasmineIndicator def,
                  int period)
Constructor

Method Detail

getIndicator

public org.ow2.jasmine.probe.JasmineIndicator getIndicator()

getName

public java.lang.String getName()
Specified by:
getName in interface org.ow2.jasmine.probe.collector.JasmineCollector
Returns:
name of this Collector

getLastResult

public abstract org.ow2.jasmine.probe.JasmineIndicatorValue getLastResult()
                                                                   throws org.ow2.jasmine.probe.collector.JasmineCollectorException
return the last result for this indicator

Specified by:
getLastResult in interface org.ow2.jasmine.probe.collector.JasmineCollector
Returns:
JasmineIndicatorValue or null if no value available
Throws:
org.ow2.jasmine.probe.collector.JasmineCollectorException

stopPolling

public abstract void stopPolling()
Stop polling

Specified by:
stopPolling in interface org.ow2.jasmine.probe.collector.JasmineCollector

startPolling

public abstract void startPolling()
Restart polling

Specified by:
startPolling in interface org.ow2.jasmine.probe.collector.JasmineCollector

diffValues

protected long diffValues(java.lang.Number v1,
                          java.lang.Number v2)
                   throws org.ow2.jasmine.probe.collector.JasmineCollectorException
Make a diff between 2 values

Parameters:
v1 -
v2 -
Returns:
v1 - v2
Throws:
org.ow2.jasmine.probe.collector.JasmineCollectorException

divideValues

protected long divideValues(java.lang.Number v1,
                            java.lang.Number v2)
                     throws org.ow2.jasmine.probe.collector.JasmineCollectorException
Make a div between 2 values

Parameters:
v1 -
v2 -
Returns:
v1 / v2
Throws:
org.ow2.jasmine.probe.collector.JasmineCollectorException

addValues

protected long addValues(java.util.Collection<java.lang.Number> values)
                  throws org.ow2.jasmine.probe.collector.JasmineCollectorException
Add a list of values of same type

Parameters:
values -
Returns:
Object of same type representing the sum of all values
Throws:
org.ow2.jasmine.probe.collector.JasmineCollectorException

multiplyValues

protected long multiplyValues(java.util.Collection<java.lang.Number> values)
                       throws org.ow2.jasmine.probe.collector.JasmineCollectorException
Multiply a list of values of same type

Parameters:
values -
Returns:
Object of same type representing the product of all values
Throws:
org.ow2.jasmine.probe.collector.JasmineCollectorException

longValue

protected long longValue(java.lang.Number nb)
                  throws org.ow2.jasmine.probe.collector.JasmineCollectorException
Try to cast a Number into a long value

Parameters:
nb -
Returns:
Throws:
org.ow2.jasmine.probe.collector.JasmineCollectorException


Copyright © 2011 OW2 Consortium. All Rights Reserved.