com.jamonapi

Class MonKeyImp

java.lang.Object

com.jamonapi.MonKeyImp

All Implemented Interfaces:

MonKey, MonKeyItem, Serializable

Direct Known Subclasses:

Log4jMonKey

public class MonKeyImp
extends Object
implements MonKey

A key implmentation for label, and units type monitors. Note this could also be implemented with the following use of MonKeyBase. This class predates that one and would not have to use a Map for basic functions and so MAY be more efficient (this wasn't tested). Using label, and units is the most common monitor that will be used in most cases.>

This could be implemented like the following.

    LinkedHashMap lm=new LinkedHashMap();
    lm.put("Label", "mypakcage.myclass");
    lm.put(""Units", "ms.");
    MonKey mk=new MonKeyBase(lm);
 

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.jamonapi.MonKey

LABEL_HEADER, UNITS_HEADER

Fields inherited from interface com.jamonapi.MonKeyItem

DEFAULT_INSTANCE_NAME, INSTANCE_HEADER

Constructor Summary

Constructors

Constructor and Description
MonKeyImp(MonKeyItem keyItem, String units)
MonKeyImp(String summaryLabel, Object details, String units) Object details can be an Object[], a Collection, or a Java Object.
MonKeyImp(String summaryLabel, String units)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object compareKey) This method is called automatically by a HashMap when this class is used as a HashMap key.
List	getBasicHeader(List header) i.e.
List	getBasicRowData(List rowData) Get all data for a row excluding row ranges, and put key data into one cell
Object	getDetails()
List	getDisplayHeader(List header) i.e.
List	getHeader(List header) i.e.
String	getInstanceName()
String	getLabel() Returns the label for the monitor
Object	getParam() Used to get any arbitrary Object into the key.
String	getRangeKey() Uses this value to look up an associated Range
List	getRowData(List rowData) Get all data for a row including range data
List	getRowDisplayData(List rowData) Get data excluding ranges, but break out key columns
int	getSize() Returns the size of the key in characters within the key.
String	getUnits() Returns the units for the monitor
Object	getValue(String key) Returns any object that has a named key.
int	hashCode() Used when key is put into a Map to look up the monitor
void	setDetails(Object details)
void	setInstanceName(String instanceName) Now that jamon can track data on multiple vm's we need a way to better identify the keys.
void	setParam(Object param) Used to set any arbitrary Object into the key.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MonKeyImp

public MonKeyImp(String summaryLabel,
                 String units)

MonKeyImp

public MonKeyImp(String summaryLabel,
                 Object details,
                 String units)

Object details can be an Object[], a Collection, or a Java Object.

MonKeyImp

public MonKeyImp(MonKeyItem keyItem,
                 String units)

Method Detail

getLabel

public String getLabel()

Returns the label for the monitor

Specified by:

getLabel in interface MonKey

getUnits

public String getUnits()

Returns the units for the monitor

getDetails

public Object getDetails()

Specified by:

getDetails in interface MonKeyItem

setDetails

public void setDetails(Object details)

Specified by:

setDetails in interface MonKeyItem

setInstanceName

public void setInstanceName(String instanceName)

Description copied from interface: MonKeyItem

Now that jamon can track data on multiple vm's we need a way to better identify the keys. A typical value for this might be: myapp_jetty9_production. It is not part of the key used for aggregation (in the map) but is used for informational purposes in the jamon report

Specified by:

setInstanceName in interface MonKeyItem

getInstanceName

public String getInstanceName()

Specified by:

getInstanceName in interface MonKeyItem

getValue

public Object getValue(String key)

Returns any object that has a named key. In this keys case 'label' and 'units' makes sense, but any values are acceptible.

Specified by:

getValue in interface MonKey

getParam

public Object getParam()

Used to get any arbitrary Object into the key. It will not be used as part of the key, however it can be retrieved later for example in the JAMonBufferListener.

Returns:

Object

setParam

public void setParam(Object param)

Used to set any arbitrary Object into the key. It will not be used as part of the key, however it can be retrieved later for example in the JAMonBufferListener.

equals

public boolean equals(Object compareKey)

This method is called automatically by a HashMap when this class is used as a HashMap key. A Coordinate is considered equal if its x and y variables have the same value.

Overrides:

equals in class Object

hashCode

public int hashCode()

Used when key is put into a Map to look up the monitor

Overrides:

hashCode in class Object

getBasicHeader

public List getBasicHeader(List header)

i.e. Label

getDisplayHeader

public List getDisplayHeader(List header)

i.e. Get the display header. Often same as getHeader

getHeader

public List getHeader(List header)

i.e. Get all key columns as part of the header i.e. Label, Units. This will include range headers

getBasicRowData

public List getBasicRowData(List rowData)

Get all data for a row excluding row ranges, and put key data into one cell

getRowData

public List getRowData(List rowData)

Get all data for a row including range data

getRowDisplayData

public List getRowDisplayData(List rowData)

Get data excluding ranges, but break out key columns

toString

public String toString()

Overrides:

toString in class Object

getRangeKey

public String getRangeKey()

Description copied from interface: MonKey

Uses this value to look up an associated Range

Specified by:

getRangeKey in interface MonKey

getSize

public int getSize()

Description copied from interface: MonKey

Returns the size of the key in characters within the key. Note it doesn't calculate the actual memory footprint as unicode characters take more memory than a single character in a string. This info is used to limit the memory footprint of jamon.

Specified by:

getSize in interface MonKey

Returns:

returns the size of the key