com.jamonapi
Interface MonKey

All Superinterfaces:
MonKeyItem
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
static java.lang.String LABEL_HEADER
           
static java.lang.String UNITS_HEADER
           
 
Method Summary
 java.util.List getBasicHeader(java.util.List header)
          i.e.
 java.util.List getBasicRowData(java.util.List rowData)
          Get all data for a row excluding row ranges, and putting key data in one cell
 java.util.List getDisplayHeader(java.util.List header)
          i.e.
 java.util.List getHeader(java.util.List header)
          i.e.
 java.lang.String getLabel()
           
 java.lang.String getRangeKey()
          Uses this value to look up an associated Range
 java.util.List getRowData(java.util.List rowData)
          Get all data for a row including range data
 java.util.List getRowDisplayData(java.util.List rowData)
          Get data excluding ranges, but breaking out key columns
 java.lang.Object getValue(java.lang.String primaryKey)
          return any value associated with the key.
 
Methods inherited from interface com.jamonapi.MonKeyItem
getDetails, setDetails
 

Field Detail

LABEL_HEADER

static final java.lang.String LABEL_HEADER
See Also:
Constant Field Values

UNITS_HEADER

static final java.lang.String UNITS_HEADER
See Also:
Constant Field Values
Method Detail

getValue

java.lang.Object getValue(java.lang.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

java.lang.String getRangeKey()
Uses this value to look up an associated Range


getLabel

java.lang.String getLabel()

getBasicHeader

java.util.List getBasicHeader(java.util.List header)
i.e. Label


getHeader

java.util.List getHeader(java.util.List header)
i.e. Get all key columns as part of the header i.e. Label, Units. This will include range headers


getDisplayHeader

java.util.List getDisplayHeader(java.util.List header)
i.e. Get the display header. Often same as getHeader


getRowData

java.util.List getRowData(java.util.List rowData)
Get all data for a row including range data


getBasicRowData

java.util.List getBasicRowData(java.util.List rowData)
Get all data for a row excluding row ranges, and putting key data in one cell


getRowDisplayData

java.util.List getRowDisplayData(java.util.List rowData)
Get data excluding ranges, but breaking out key columns