MonKeyBase (JAMon Core 2.81 API)

java.lang.Object
- com.jamonapi.MonKeyBase

All Implemented Interfaces:

MonKey, MonKeyItem, Serializable
```
public class MonKeyBase
extends Object
implements MonKey
```
Class that can be used as a composite key for MonitorFactor.add(compositeKey, 100) method calls Note the passed in LinkedHashMap is used as a key to another Map that looks up the associated monitor. Sun java docs says this regarding keys in Maps: "Note: great care must be exercised if mutable objects are used as map keys. The behavior of a map is not specified if the value of an object is changed in a manner that affects equals comparisons while the object is a key in the map." So once a value is placed in the LinkedHashMap is passed to the MonKeyBase constructor it should not be changed.

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
`MonKeyBase(LinkedHashMap keyMap)` Calls the other constructor.
`MonKeyBase(String rangeKeyStr, LinkedHashMap keyMap)` The LinkHashMap will contain key value pairs.

Method Summary

All Methods Instance Methods Concrete Methods
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)` Puts the word 'Label' into the list.
`List`	`getBasicRowData(List rowData)` Returns the values assoicated with the key as a comma delimited entry in the list.
`Object`	`getDetails()`
`List`	`getDisplayHeader(List header)` Returns each key in the map as a header element in the list
`List`	`getHeader(List header)` Returns each key in the map as a header element in the list
`String`	`getInstanceName()`
`String`	`getLabel()`
`Map`	`getMonKeyMap()` Return the map underlying this Object
`String`	`getRangeKey()` Returns either the passed in range key, or it builds the key from the maps keys concatenated
`List`	`getRowData(List rowData)` Add each value from the map at an element to the list.
`List`	`getRowDisplayData(List rowData)` Add each value from the map at an element to the list.
`int`	`getSize()` Returns the size of the key in characters within the key.
`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.
`String`	`toString()` Returns a string representation of this object: JAMon Key, firstname=steve, lastname=souza, age=44

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

- Constructor Detail
  - MonKeyBase
```
public MonKeyBase(LinkedHashMap keyMap)
```
    Calls the other constructor. The keyMap will be used to create the range name
  - MonKeyBase
```
public MonKeyBase(String rangeKeyStr,
                  LinkedHashMap keyMap)
```
    The LinkHashMap will contain key value pairs. For example: fn=steve, ln=souza, age=44. LinkHashMap is used as the insertion order needs to be retained for displaying header, and data. The rangeKeyString is used to look up an associated range should one exist
- Method Detail
  - 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
  - getLabel
```
public String getLabel()
```
    Specified by:
    
    getLabel in interface MonKey
  - 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
  - getMonKeyMap
```
public Map getMonKeyMap()
```
    Return the map underlying this Object
  - 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
  - getBasicHeader
```
public List getBasicHeader(List header)
```
    Puts the word 'Label' into the list. Used in the basic JAMon report
  - getDisplayHeader
```
public List getDisplayHeader(List header)
```
    Returns each key in the map as a header element in the list
  - getHeader
```
public List getHeader(List header)
```
    Returns each key in the map as a header element in the list
  - getBasicRowData
```
public List getBasicRowData(List rowData)
```
    Returns the values assoicated with the key as a comma delimited entry in the list. For example if the map contains firstname, lastname, age then something like steve, souza, 44 would be returned
  - getRowData
```
public List getRowData(List rowData)
```
    Add each value from the map at an element to the list.
  - getRowDisplayData
```
public List getRowDisplayData(List rowData)
```
    Add each value from the map at an element to the list.
  - toString
```
public String toString()
```
    Returns a string representation of this object: JAMon Key, firstname=steve, lastname=souza, age=44
    
    Overrides:
    
    toString in class Object
  - getRangeKey
```
public String getRangeKey()
```
    Returns either the passed in range key, or it builds the key from the maps keys concatenated
    
    Specified by:
    
    getRangeKey in interface MonKey
  - getDetails
```
public Object getDetails()
```
    Specified by:
    
    getDetails in interface MonKeyItem
  - setDetails
```
public void setDetails(Object details)
```
    Specified by:
    
    setDetails in interface MonKeyItem
  - 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

Class MonKeyBase

Field Summary

Fields inherited from interface com.jamonapi.MonKey

Fields inherited from interface com.jamonapi.MonKeyItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonKeyBase

MonKeyBase

Method Detail

getValue

getLabel

equals

hashCode

getMonKeyMap

setInstanceName

getInstanceName

getBasicHeader

getDisplayHeader

getHeader

getBasicRowData

getRowData

getRowDisplayData

toString

getRangeKey

getDetails

setDetails

getSize