FrequencyDist (JAMon Core 2.81 API)

```
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.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVE`
`static String`	`AVG`
`static String`	`AVGACTIVE`
`static String`	`FIRSTACCESS`
`static String`	`HITS`
`static String`	`LASTACCESS`
`static String`	`LASTVALUE`
`static String`	`MAX`
`static String`	`MAXACTIVE`
`static String`	`MIN`
`static String`	`STDDEV`
`static String`	`TOTAL`
`static String`	`VALUE` Used in call to addListener(...).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Monitor`	`add(double value)` This method adds a value to the monitor (and aggegates statistics on it)
`void`	`addListener(String listenerTypeName, JAMonListener listener)` Introduced as a way to add listeners that allows for lazy initialization saving a fair amount of memory.
`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.
`Date`	`getFirstAccess()`
`double`	`getHits()`
`JAMonDetailValue`	`getJAMonDetailRow()`
`Date`	`getLastAccess()`
`double`	`getLastValue()`
`ListenerType`	`getListenerType(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()`
`Object`	`getValue(String key)` Returns any object that has a named key.
`boolean`	`hasListener(String listenerTypeName, String listenerName)` Pass in a listenertype like 'max', 'min', 'value' and the listener name and true will be returned if the listener exists
`boolean`	`hasListeners()`
`boolean`	`hasListeners(String listenerTypeName)` Returns true if this listenertype ('max', 'min', 'value', 'maxactive') has any listeners at all
`boolean`	`isActivityTracking()`
`boolean`	`isEnabled()` Is the monitor enabled.
`boolean`	`isPrimary()`
`void`	`removeListener(String listenerTypeName, String listenerName)`
`void`	`reset()` reset all values in the monitor to their defaults
`void`	`setActive(double value)`
`void`	`setActivityTracking(boolean trackActivity)`
`void`	`setFirstAccess(Date date)`
`void`	`setHits(double value)`
`void`	`setLastAccess(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`	`skip()` Works simililarly to stop except the stats are not recorded.
`Monitor`	`start()` Start a monitor.
`Monitor`	`stop()` Stop a monitor.

- Field Detail
  - VALUE
```
static final String VALUE
```
    Used in call to addListener(...). i.e. addListener(Monitor.MAX, ...). Also used to return values from getObject(key). For example mon.getValue("max");
    
    See Also:
    
    Constant Field Values
  - LASTVALUE
```
static final String LASTVALUE
```
    See Also:
    
    Constant Field Values
  - MAX
```
static final String MAX
```
    See Also:
    
    Constant Field Values
  - MIN
```
static final String MIN
```
    See Also:
    
    Constant Field Values
  - MAXACTIVE
```
static final String MAXACTIVE
```
    See Also:
    
    Constant Field Values
  - TOTAL
```
static final String TOTAL
```
    See Also:
    
    Constant Field Values
  - AVG
```
static final String AVG
```
    See Also:
    
    Constant Field Values
  - HITS
```
static final String HITS
```
    See Also:
    
    Constant Field Values
  - STDDEV
```
static final String STDDEV
```
    See Also:
    
    Constant Field Values
  - FIRSTACCESS
```
static final String FIRSTACCESS
```
    See Also:
    
    Constant Field Values
  - LASTACCESS
```
static final String LASTACCESS
```
    See Also:
    
    Constant Field Values
  - ACTIVE
```
static final String ACTIVE
```
    See Also:
    
    Constant Field Values
  - AVGACTIVE
```
static final String AVGACTIVE
```
    See Also:
    
    Constant Field Values
- 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(Date date)
```
  - getFirstAccess
```
Date getFirstAccess()
```
  - setLastAccess
```
void setLastAccess(Date date)
```
  - getLastAccess
```
Date getLastAccess()
```
  - getLastValue
```
double getLastValue()
```
  - setLastValue
```
void setLastValue(double value)
```
  - getValue
```
Object getValue(String key)
```
    Returns any object that has a named key. For this object 'total' and 'avg', and 'min' are valid. It is case insenstive. Implementations may return other values This allows values to be returned from a Monitor without having to cast.
  - 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.
  - skip
```
Monitor skip()
```
    Works simililarly to stop except the stats are not recorded. The only action is to decrement active.
    
    Returns:
    
    Monitor
  - 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(String listenerType)
```
  - hasListeners
```
boolean hasListeners(String listenerTypeName)
```
    Returns true if this listenertype ('max', 'min', 'value', 'maxactive') has any listeners at all
    
    Parameters:
    
    listenerTypeName -
    
    Returns:
    
    boolean
  - addListener
```
void addListener(String listenerTypeName,
                 JAMonListener listener)
```
    Introduced as a way to add listeners that allows for lazy initialization saving a fair amount of memory. Note a future enhancement would be to delete the Listeners object when all listeners are removed.
    
    Since:
    
    2.71
  - hasListener
```
boolean hasListener(String listenerTypeName,
                    String listenerName)
```
    Pass in a listenertype like 'max', 'min', 'value' and the listener name and true will be returned if the listener exists
    
    Since:
    
    2.71
  - removeListener
```
void removeListener(String listenerTypeName,
                    String listenerName)
```
  - hasListeners
```
boolean hasListeners()
```
  - setActivityTracking
```
void setActivityTracking(boolean trackActivity)
```
  - isActivityTracking
```
boolean isActivityTracking()
```
  - getJAMonDetailRow
```
JAMonDetailValue getJAMonDetailRow()
```

Interface FrequencyDist

Field Summary

Method Summary

Field Detail

VALUE

LASTVALUE

MAX

MIN

MAXACTIVE

TOTAL

AVG

HITS

STDDEV

FIRSTACCESS

LASTACCESS

ACTIVE

AVGACTIVE

Method Detail

getEndValue

getTotal

setTotal

getAvg

getMin

setMin

getMax

setMax

getHits

setHits

getStdDev

setFirstAccess

getFirstAccess

setLastAccess

getLastAccess

getLastValue

setLastValue

getValue

start

stop

skip

add

reset

enable

disable

isEnabled

getRange

getMonKey

getActive

setActive

getMaxActive

setMaxActive

setTotalActive

getAvgActive

isPrimary

setPrimary

getListenerType

hasListeners

addListener

hasListener

removeListener

hasListeners

setActivityTracking

isActivityTracking

getJAMonDetailRow