MonitorComposite (JAMon Core 2.81 API)

java.lang.Object
- com.jamonapi.Monitor
- - com.jamonapi.MonitorComposite

All Implemented Interfaces:

DetailData, Serializable
```
public class MonitorComposite
extends Monitor
implements DetailData
```
Treats groups of monitors the same way you treat one monitor. i.e. you can enable/disable/reset etc a group of monitors.

See Also:

Serialized Form

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(...).

Constructor Summary

Constructors
Constructor and Description

MonitorComposite(Monitor[] monitors)
Creates a new instance of MonitorComposite

Constructors
Constructor and Description
`MonitorComposite(Monitor[] monitors)` Creates a new instance of MonitorComposite

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Monitor`	`add(double value)` This method adds a value to the monitor (and aggegates statistics on it)
`MonitorComposite`	`copy()`
`void`	`disable()` Disable the monitor.
`void`	`enable()` enable the monitor.
`boolean`	`exists(MonKey key)` Note this works with Local, however when it is put into the map by combining multiple MonitorComposites that have the same key (for example on different instances) it does not currently work.
`MonitorComposite`	`filterByUnits(String units)`
`double`	`getActive()`
`double`	`getAvg()`
`double`	`getAvgActive()` This returns a weighted average
`Object[][]`	`getBasicData()` Get basic data (which excludes range data)
`String[]`	`getBasicHeader()` Return the header that applies to all monitors.
`Object[][]`	`getData()` Get all data including basic data as well as each element within the range
`Date`	`getDateCreated()`
`Object[][]`	`getDisplayData()` Get display data including 1 column for each range
`String[]`	`getDisplayHeader()` Return the header with basic data and one column for each range.
`Collection<String>`	`getDistinctUnits()`
`Date`	`getFirstAccess()`
`String[]`	`getHeader()` Return the header with basic data and columns for each field within the range.
`double`	`getHits()`
`String`	`getInstanceName()`
`JAMonDetailValue`	`getJAMonDetailRow()`
`Date`	`getLastAccess()`
`double`	`getLastValue()`
`double`	`getMax()`
`double`	`getMaxActive()`
`double`	`getMin()`
`Monitor`	`getMonitor(MonKey key)`
`Monitor[]`	`getMonitors()`
`static MonitorComposite`	`getMonitors(String[][] labels)` Pass in an array with col1=lables, and col2=units and then call methods
`MonKey`	`getMonKey()` Return the label associated with this monitor.
`int`	`getNumRows()`
`Range`	`getRange()` Return the Range object associated with this monitor.
`String`	`getReport()` A basic report in html format.
`String`	`getReport(int sortCol, String sortOrder)` A basic report in html format that is sorted.
`double`	`getStdDev()` This is not a true standard deviation but a average weighted std deviation.
`double`	`getTotal()`
`boolean`	`hasData()` Does this have data?
`boolean`	`hasListeners()`
`boolean`	`isEnabled()` It just takes one of the monitors to not be enabled for the composite to be false
`boolean`	`isLocalInstance()` means is in this jvm and not data distributed from another machine
`boolean`	`isPrimary()` It just takes one of the monitors to not be primary for the composite to be false
`void`	`reset()` reset all values in the monitor to their defaults
`void`	`setActive(double value)`
`void`	`setActivityTracking(boolean trackActivity)` FROM frequencydistimp
`MonitorComposite`	`setDateCreated(Date dateCreated)`
`void`	`setFirstAccess(Date date)`
`void`	`setHits(double value)`
`MonitorComposite`	`setInstanceName(String instanceName)`
`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)` Neeed to reset this to 0.0 to remove avg active numbers
`Monitor`	`start()` Start a monitor.
`Monitor`	`stop()` Stop a monitor.

Methods inherited from class com.jamonapi.Monitor
addListener, getAvgGlobalActive, getAvgPrimaryActive, getLabel, getListenerType, getUnits, getValue, hasListener, hasListeners, isActivityTracking, removeListener, setAccessStats, skip, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VALUE
```
public 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
```
public static final String LASTVALUE
```
    See Also:
    
    Constant Field Values
  - MAX
```
public static final String MAX
```
    See Also:
    
    Constant Field Values
  - MIN
```
public static final String MIN
```
    See Also:
    
    Constant Field Values
  - MAXACTIVE
```
public static final String MAXACTIVE
```
    See Also:
    
    Constant Field Values
  - TOTAL
```
public static final String TOTAL
```
    See Also:
    
    Constant Field Values
  - AVG
```
public static final String AVG
```
    See Also:
    
    Constant Field Values
  - HITS
```
public static final String HITS
```
    See Also:
    
    Constant Field Values
  - STDDEV
```
public static final String STDDEV
```
    See Also:
    
    Constant Field Values
  - FIRSTACCESS
```
public static final String FIRSTACCESS
```
    See Also:
    
    Constant Field Values
  - LASTACCESS
```
public static final String LASTACCESS
```
    See Also:
    
    Constant Field Values
  - ACTIVE
```
public static final String ACTIVE
```
    See Also:
    
    Constant Field Values
  - AVGACTIVE
```
public static final String AVGACTIVE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MonitorComposite
```
public MonitorComposite(Monitor[] monitors)
```
    Creates a new instance of MonitorComposite
- Method Detail
  - getMonitors
```
public Monitor[] getMonitors()
```
  - getDistinctUnits
```
public Collection<String> getDistinctUnits()
```
    Returns:
    
    A collection of all the unit types that are currently in this object (i.e. ms., ns., Exception,...)
    
    Since:
    
    2.81
  - filterByUnits
```
public MonitorComposite filterByUnits(String units)
```
  - exists
```
public boolean exists(MonKey key)
```
    Note this works with Local, however when it is put into the map by combining multiple MonitorComposites that have the same key (for example on different instances) it does not currently work.
    
    Parameters:
    
    key -
    
    Returns:
  - getMonitor
```
public Monitor getMonitor(MonKey key)
```
  - getInstanceName
```
public String getInstanceName()
```
  - setInstanceName
```
public MonitorComposite setInstanceName(String instanceName)
```
  - isLocalInstance
```
public boolean isLocalInstance()
```
    means is in this jvm and not data distributed from another machine
  - getMonitors
```
public static MonitorComposite getMonitors(String[][] labels)
```
    Pass in an array with col1=lables, and col2=units and then call methods
  - getNumRows
```
public int getNumRows()
```
  - getBasicHeader
```
public String[] getBasicHeader()
```
    Return the header that applies to all monitors. It does not include range column headers. It will contain label, hits, total, avg, min, max and active among other columns
  - getHeader
```
public String[] getHeader()
```
    Return the header with basic data and columns for each field within the range. note getHeader only works if the range of all monitors in the composite are the same.
    
    Specified by:
    
    getHeader in interface DetailData
  - getDisplayHeader
```
public String[] getDisplayHeader()
```
    Return the header with basic data and one column for each range. Note this only will work with ranges of the same type
  - getData
```
public Object[][] getData()
```
    Get all data including basic data as well as each element within the range
    
    Specified by:
    
    getData in interface DetailData
  - getBasicData
```
public Object[][] getBasicData()
```
    Get basic data (which excludes range data)
  - getDisplayData
```
public Object[][] getDisplayData()
```
    Get display data including 1 column for each range
  - getReport
```
public String getReport()
```
    A basic report in html format. It has summary info for all monitors but no range info
  - getReport
```
public String getReport(int sortCol,
                        String sortOrder)
```
    A basic report in html format that is sorted. It has summary info for all monitors but no range info
  - hasData
```
public boolean hasData()
```
    Does this have data?
  - reset
```
public void reset()
```
    reset all values in the monitor to their defaults
    
    Overrides:
    
    reset in class Monitor
  - disable
```
public void disable()
```
    Disable the monitor. If a monitor is disabled all other calls to the monitor are noops.
    
    Overrides:
    
    disable in class Monitor
  - enable
```
public void enable()
```
    enable the monitor. If the monitor is enabled all other calls to the monitor have an action
    
    Overrides:
    
    enable in class Monitor
  - getActive
```
public double getActive()
```
    Overrides:
    
    getActive in class Monitor
  - getAvg
```
public double getAvg()
```
    Overrides:
    
    getAvg in class Monitor
  - getAvgActive
```
public double getAvgActive()
```
    This returns a weighted average
    
    Overrides:
    
    getAvgActive in class Monitor
  - getFirstAccess
```
public Date getFirstAccess()
```
    Overrides:
    
    getFirstAccess in class Monitor
  - getDateCreated
```
public Date getDateCreated()
```
  - setDateCreated
```
public MonitorComposite setDateCreated(Date dateCreated)
```
    Since:
    
    2.79
  - getHits
```
public double getHits()
```
    Overrides:
    
    getHits in class Monitor
  - getMonKey
```
public MonKey getMonKey()
```
    Return the label associated with this monitor.
    
    Overrides:
    
    getMonKey in class Monitor
  - getLastAccess
```
public Date getLastAccess()
```
    Overrides:
    
    getLastAccess in class Monitor
  - getLastValue
```
public double getLastValue()
```
    Overrides:
    
    getLastValue in class Monitor
  - getMax
```
public double getMax()
```
    Overrides:
    
    getMax in class Monitor
  - getMaxActive
```
public double getMaxActive()
```
    Overrides:
    
    getMaxActive in class Monitor
  - getMin
```
public double getMin()
```
    Overrides:
    
    getMin in class Monitor
  - getRange
```
public Range getRange()
```
    Return the Range object associated with this monitor. The range object is a compromise between saving all data or none
    
    Overrides:
    
    getRange in class Monitor
  - getStdDev
```
public double getStdDev()
```
    This is not a true standard deviation but a average weighted std deviation. However individual monitors do have a true standard deviation
    
    Overrides:
    
    getStdDev in class Monitor
  - getTotal
```
public double getTotal()
```
    Overrides:
    
    getTotal in class Monitor
  - isEnabled
```
public boolean isEnabled()
```
    It just takes one of the monitors to not be enabled for the composite to be false
    
    Overrides:
    
    isEnabled in class Monitor
  - isPrimary
```
public boolean isPrimary()
```
    It just takes one of the monitors to not be primary for the composite to be false
    
    Overrides:
    
    isPrimary in class Monitor
  - setActive
```
public void setActive(double value)
```
    Overrides:
    
    setActive in class Monitor
  - setFirstAccess
```
public void setFirstAccess(Date date)
```
    Overrides:
    
    setFirstAccess in class Monitor
  - setHits
```
public void setHits(double value)
```
    Overrides:
    
    setHits in class Monitor
  - setLastAccess
```
public void setLastAccess(Date date)
```
    Overrides:
    
    setLastAccess in class Monitor
  - setLastValue
```
public void setLastValue(double value)
```
    Overrides:
    
    setLastValue in class Monitor
  - setMax
```
public void setMax(double value)
```
    Overrides:
    
    setMax in class Monitor
  - setMaxActive
```
public void setMaxActive(double value)
```
    Overrides:
    
    setMaxActive in class Monitor
  - setMin
```
public void setMin(double value)
```
    Overrides:
    
    setMin in class Monitor
  - setPrimary
```
public void setPrimary(boolean isPrimary)
```
    Indicate that this a primary Monitor. See www.jamonapi.com for an explanation of primary monitors
    
    Overrides:
    
    setPrimary in class Monitor
  - setTotal
```
public void setTotal(double value)
```
    Overrides:
    
    setTotal in class Monitor
  - setTotalActive
```
public void setTotalActive(double value)
```
    Description copied from class: Monitor
    
    Neeed to reset this to 0.0 to remove avg active numbers
    
    Overrides:
    
    setTotalActive in class Monitor
  - start
```
public 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.
    
    Overrides:
    
    start in class Monitor
  - stop
```
public Monitor stop()
```
    Stop a monitor. The decrements the active counter by one. Calling stop is required if start is called.
    
    Overrides:
    
    stop in class Monitor
  - add
```
public Monitor add(double value)
```
    This method adds a value to the monitor (and aggegates statistics on it)
    
    Overrides:
    
    add in class Monitor
  - hasListeners
```
public boolean hasListeners()
```
    Overrides:
    
    hasListeners in class Monitor
  - getJAMonDetailRow
```
public JAMonDetailValue getJAMonDetailRow()
```
    Overrides:
    
    getJAMonDetailRow in class Monitor
  - setActivityTracking
```
public void setActivityTracking(boolean trackActivity)
```
    Description copied from class: Monitor
    
    FROM frequencydistimp
    
    Overrides:
    
    setActivityTracking in class Monitor
  - copy
```
public MonitorComposite copy()
```
    Returns:
    
    a deep copy of this object
    
    Since:
    
    2.79

Class MonitorComposite

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.jamonapi.Monitor

Methods inherited from class java.lang.Object

Field Detail

VALUE

LASTVALUE

MAX

MIN

MAXACTIVE

TOTAL

AVG

HITS

STDDEV

FIRSTACCESS

LASTACCESS

ACTIVE

AVGACTIVE

Constructor Detail

MonitorComposite

Method Detail

getMonitors

getDistinctUnits

filterByUnits

exists

getMonitor

getInstanceName

setInstanceName

isLocalInstance

getMonitors

getNumRows

getBasicHeader

getHeader

getDisplayHeader

getData

getBasicData

getDisplayData

getReport

getReport

hasData

reset

disable

enable

getActive

getAvg

getAvgActive

getFirstAccess

getDateCreated

setDateCreated

getHits

getMonKey

getLastAccess

getLastValue

getMax

getMaxActive

getMin

getRange

getStdDev

getTotal

isEnabled

isPrimary

setActive

setFirstAccess

setHits

setLastAccess

setLastValue

setMax

setMaxActive

setMin

setPrimary

setTotal

setTotalActive

start

stop

add

hasListeners

getJAMonDetailRow

setActivityTracking