com.jamonapi
Interface FrequencyDist


public interface FrequencyDist

FrequencyDist's are what Ranges are made of. They are buckets of aggregate stats within the monitor. For example a FrequencyDist for ms. may be 0-10 ms., 20-40 ms. etc. They have end points, and all FrequencyDists within a range equate to the entire range of possible values for a monitor.


Method Summary
 Monitor add(double value)
          This method adds a value to the monitor (and aggegates statistics on it)
 void disable()
          Disable the monitor.
 void enable()
          enable the monitor.
 double getActive()
           
 double getAvg()
           
 double getAvgActive()
           
 double getEndValue()
          Get the end value of the FrequencyDist.
 java.util.Date getFirstAccess()
           
 double getHits()
           
 JAMonDetailValue getJAMonDetailRow()
           
 java.util.Date getLastAccess()
           
 double getLastValue()
           
 ListenerType getListenerType(java.lang.String listenerType)
           
 double getMax()
           
 double getMaxActive()
           
 double getMin()
           
 MonKey getMonKey()
          Return the label associated with this monitor.
 Range getRange()
          Return the Range object associated with this monitor.
 double getStdDev()
           
 double getTotal()
           
 boolean hasListeners()
           
 boolean isActivityTracking()
           
 boolean isEnabled()
          Is the monitor enabled.
 boolean isPrimary()
           
 void reset()
          reset all values in the monitor to their defaults
 void setActive(double value)
           
 void setActivityTracking(boolean trackActivity)
           
 void setFirstAccess(java.util.Date date)
           
 void setHits(double value)
           
 void setLastAccess(java.util.Date date)
           
 void setLastValue(double value)
           
 void setMax(double value)
           
 void setMaxActive(double value)
           
 void setMin(double value)
           
 void setPrimary(boolean isPrimary)
          Indicate that this a primary Monitor.
 void setTotal(double value)
           
 void setTotalActive(double value)
           
 Monitor start()
          Start a monitor.
 Monitor stop()
          Stop a monitor.
 

Method Detail

getEndValue

double getEndValue()
Get the end value of the FrequencyDist.


getTotal

double getTotal()

setTotal

void setTotal(double value)

getAvg

double getAvg()

getMin

double getMin()

setMin

void setMin(double value)

getMax

double getMax()

setMax

void setMax(double value)

getHits

double getHits()

setHits

void setHits(double value)

getStdDev

double getStdDev()

setFirstAccess

void setFirstAccess(java.util.Date date)

getFirstAccess

java.util.Date getFirstAccess()

setLastAccess

void setLastAccess(java.util.Date date)

getLastAccess

java.util.Date getLastAccess()

getLastValue

double getLastValue()

setLastValue

void setLastValue(double value)

start

Monitor start()
Start a monitor. This increments the active counter by one. Calling start is not required. If it is called stop should be called too.


stop

Monitor stop()
Stop a monitor. The decrements the active counter by one. Calling stop is required if start is called.


add

Monitor add(double value)
This method adds a value to the monitor (and aggegates statistics on it)


reset

void reset()
reset all values in the monitor to their defaults


enable

void enable()
enable the monitor. If the monitor is enabled all other calls to the monitor have an action


disable

void disable()
Disable the monitor. If a monitor is disabled all other calls to the monitor are noops.


isEnabled

boolean isEnabled()
Is the monitor enabled.


getRange

Range getRange()
Return the Range object associated with this monitor. The range object is a compromise between saving all data or none


getMonKey

MonKey getMonKey()
Return the label associated with this monitor.


getActive

double getActive()

setActive

void setActive(double value)

getMaxActive

double getMaxActive()

setMaxActive

void setMaxActive(double value)

setTotalActive

void setTotalActive(double value)

getAvgActive

double getAvgActive()

isPrimary

boolean isPrimary()

setPrimary

void setPrimary(boolean isPrimary)
Indicate that this a primary Monitor. See www.jamonapi.com for an explanation of primary monitors


getListenerType

ListenerType getListenerType(java.lang.String listenerType)

hasListeners

boolean hasListeners()

setActivityTracking

void setActivityTracking(boolean trackActivity)

isActivityTracking

boolean isActivityTracking()

getJAMonDetailRow

JAMonDetailValue getJAMonDetailRow()