com.jamonapi

Interface MonKey

All Superinterfaces:

MonKeyItem, Serializable

All Known Implementing Classes:

Log4jMonKey, MonKeyBase, MonKeyImp

public interface MonKey
extends MonKeyItem

Key that allows for a monitor to be passed any number of keys used in the equivalent of a group by clause. Put in hashmap to identify a Monitor. Implementations will need to implement equals, and hashcode. MonKeys are the way Monitors are identified in the storing Map

Field Summary

Fields

Modifier and Type	Field and Description
static String	LABEL_HEADER
static String	UNITS_HEADER

Fields inherited from interface com.jamonapi.MonKeyItem

DEFAULT_INSTANCE_NAME, INSTANCE_HEADER, serialVersionUID

Method Summary

Modifier and Type	Method and Description
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
List	getDisplayHeader(List header) i.e.
List	getHeader(List header) i.e.
String	getLabel()
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.
Object	getValue(String primaryKey) return any value associated with the key.

Methods inherited from interface com.jamonapi.MonKeyItem

getDetails, getInstanceName, setDetails, setInstanceName

Field Detail

LABEL_HEADER

static final String LABEL_HEADER

See Also:

Constant Field Values

UNITS_HEADER

static final String UNITS_HEADER

See Also:

Constant Field Values

Method Detail

getValue

Object getValue(String primaryKey)

return any value associated with the key. new MonKey(label, units). would return the value associated with label or units if: getValue("label"), or getValue("units");

getRangeKey

String getRangeKey()

Uses this value to look up an associated Range

getLabel

String getLabel()

getSize

int getSize()

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.

Returns:

returns the size of the key

getBasicHeader

List getBasicHeader(List header)

i.e. Label

getHeader

List getHeader(List header)

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

getDisplayHeader

List getDisplayHeader(List header)

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

getRowData

List getRowData(List rowData)

Get all data for a row including range data

getBasicRowData

List getBasicRowData(List rowData)

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

getRowDisplayData

List getRowDisplayData(List rowData)

Get data excluding ranges, but break out key columns