edu.cmu.cs.able.gaugeInfrastructure.RMI
Class RMIGaugeConsumer

java.lang.Object
  |
  +--edu.cmu.cs.able.gaugeInfrastructure.RMI.RMIGaugeConsumer
All Implemented Interfaces:
GaugeConsumer, java.io.Serializable

public class RMIGaugeConsumer
extends java.lang.Object
implements GaugeConsumer, java.io.Serializable

See Also:
Serialized Form

Field Summary
protected  RMIGaugeReportingBus gaugeBus
          The reporting bus that gauges report through.
 java.lang.String gaugeConsumerHost
           
 java.lang.String gaugeConsumerUID
           
 
Constructor Summary
RMIGaugeConsumer()
          Constructor of RMIGaugeConsumer
 
Method Summary
 void addGauge(GaugeID theGaugeID)
           
 void addGauge(GaugeID theGaugeID, StringPairVector configParams)
           
 void configureGauge(GaugeID theGaugeID, StringPairVector configParams)
          Configures a gauge.
 void createGauge(GaugeID theGaugeID, StringPairVector setupParams)
          Creates a gauge.
 void deleteGauge(GaugeID theGaugeID)
          Deletes a gauge.
 void onReportConfigured(GaugeControl gauge, StringPairVector configParams)
          Called when a configured event is reported
 void onReportCreated(GaugeControl gauge)
          Called when a created event is reported
 void onReportCreated(GaugeID theGaugeID)
          Called when a created event is reported
 void onReportDeleted(GaugeControl gauge)
          Called when a deleted event is reported
 void onReportMultipleValues(GaugeControl gauge, GaugeValueVector values)
          Called when multiple values are reported
 void onReportValue(GaugeControl gauge, java.lang.String valueName, java.lang.String propertyName, java.lang.String value)
          Called when a value is reported
 void subscribeInterest(GaugeID theGaugeID, GaugeEventType gaugeEvent)
          Subscribe interest of the gauge consumer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

gaugeBus

protected RMIGaugeReportingBus gaugeBus
The reporting bus that gauges report through.

gaugeConsumerUID

public java.lang.String gaugeConsumerUID

gaugeConsumerHost

public java.lang.String gaugeConsumerHost
Constructor Detail

RMIGaugeConsumer

public RMIGaugeConsumer()
Constructor of RMIGaugeConsumer
Method Detail

configureGauge

public void configureGauge(GaugeID theGaugeID,
                           StringPairVector configParams)
Configures a gauge.
Parameters:
theGaugeID - The GaugeID of the gauge being configured
configParams - The configuration parameters

createGauge

public void createGauge(GaugeID theGaugeID,
                        StringPairVector setupParams)
Creates a gauge.
Parameters:
theGaugeID - The GaugeID of the gauge being created
setupParams - The setup parameters

deleteGauge

public void deleteGauge(GaugeID theGaugeID)
Deletes a gauge.
Parameters:
theGaugeID - The GaugeID of the gauge being deleted

addGauge

public void addGauge(GaugeID theGaugeID,
                     StringPairVector configParams)

addGauge

public void addGauge(GaugeID theGaugeID)

subscribeInterest

public void subscribeInterest(GaugeID theGaugeID,
                              GaugeEventType gaugeEvent)
Subscribe interest of the gauge consumer.
Parameters:
theGaugeID - The GaugeID of the gauge to be observed
gaugeEvent - The gauge events to be observed

onReportValue

public void onReportValue(GaugeControl gauge,
                          java.lang.String valueName,
                          java.lang.String propertyName,
                          java.lang.String value)
Called when a value is reported
Specified by:
onReportValue in interface GaugeConsumer
Parameters:
gauge - The gauge reporting the value
valueName - The name of the value
propertyName - The property name of the value
value - The content of the value

onReportMultipleValues

public void onReportMultipleValues(GaugeControl gauge,
                                   GaugeValueVector values)
Called when multiple values are reported
Specified by:
onReportMultipleValues in interface GaugeConsumer
Parameters:
gauge - The gauge reporting the values
values - The values

onReportConfigured

public void onReportConfigured(GaugeControl gauge,
                               StringPairVector configParams)
Called when a configured event is reported
Specified by:
onReportConfigured in interface GaugeConsumer
Parameters:
gauge - The gauge reporting the event
configParams - The configuration parameters

onReportDeleted

public void onReportDeleted(GaugeControl gauge)
Called when a deleted event is reported
Specified by:
onReportDeleted in interface GaugeConsumer
Parameters:
gauge - The gauge reporting the event

onReportCreated

public void onReportCreated(GaugeControl gauge)
Called when a created event is reported
Specified by:
onReportCreated in interface GaugeConsumer
Parameters:
gauge - The gauge reporting the event

onReportCreated

public void onReportCreated(GaugeID theGaugeID)
Called when a created event is reported
Parameters:
theGaugeID - The GaugeID of the gauge reporting the event