|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The GaugeControl interface specifies the point-to-point control interface for a gauge. Each gauge must implement this interface. Each infrastructure implementation will likely include two implementations of this interface - an handle that can be used by consumers to control the gauge and a gauge that is the actual gauge implementation.
Method Summary | |
boolean |
configure(StringPairVector configParams)
The method called when configuring a gauge. |
GaugeID |
getGaugeID()
Each gauge implementation must have an ID |
boolean |
queryAllValues(GaugeValueVector values)
Returns all the gauge values that the gauge reports. |
boolean |
queryState(StringPairVector setupParams,
StringPairVector configParams,
StringPairVector mappings)
The method called to query the state of the gauge |
java.lang.String |
queryValue(java.lang.String valueName)
Called when a gauge is queried for a value. |
Method Detail |
public GaugeID getGaugeID()
public boolean configure(StringPairVector configParams)
configParams
- The configuration parameters for the gauge as (name, value) pairs.public boolean queryState(StringPairVector setupParams, StringPairVector configParams, StringPairVector mappings)
setupParams
- Will be filled with the parameters with which the gauge was setup, as (name, value) pairs.configParams
- Will be filled with the current configuration of the gauge, as (name, value) pairsmappings
- Will be filled with the mappings for the gauge, as (name, propertyName) pairs.public java.lang.String queryValue(java.lang.String valueName)
valueName
- The name of the value to be queried.public boolean queryAllValues(GaugeValueVector values)
values
- This is filled with all the values as a (valueName, propertyName, value) tuple
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |