org.wattdepot.client.http.api

Class WattDepotClient

java.lang.Object

org.wattdepot.client.http.api.WattDepotClient

All Implemented Interfaces:

WattDepotInterface

Direct Known Subclasses:

WattDepotAdminClient

public class WattDepotClient
extends Object
implements WattDepotInterface

WattDepotClient - high-level Java implementation that communicates with a WattDepot server. It implements the WattDepotInterface that hides the HTTP Labels.

Author:

Cam Moore

Constructor Summary

Constructors

Constructor and Description
WattDepotClient(String serverUri, String username, String orgId, String password) Creates a new WattDepotClient.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteCollectorProcessDefinition(CollectorProcessDefinition process) Deletes the given CollectorProcessDefinitionData.
void	deleteDepository(Depository depository) Deletes the given Depository.
void	deleteMeasurement(Depository depository, Measurement measurement) Deletes the given measurement from the given depository.
void	deleteMeasurementPruningDefinition(MeasurementPruningDefinition gcd) Deletes the given MeasurementPruningDefinition from the WattDepotServer.
void	deleteMeasurementType(MeasurementType type) Deletes the given MeasurementType.
void	deleteSensor(Sensor sensor) Deletes the given Sensor.
void	deleteSensorGroup(SensorGroup group) Deletes the given SensorGroup.
void	deleteSensorModel(SensorModel model) Deletes the given SensorModel.
InterpolatedValueList	getAverageValues(Depository depository, Sensor sensor, Date start, Date end, Integer interval, Boolean usePointValues)
InterpolatedValueList	getAverageValues(Depository depository, SensorGroup group, Date start, Date end, Integer interval, Boolean usePointValues)
CollectorProcessDefinition	getCollectorProcessDefinition(String id) Retrieves the CollectorProcessDefinitionData with the given id from the WattDepot Server.
CollectorProcessDefinitionList	getCollectorProcessDefinitions()
InterpolatedValueList	getDailyValues(Depository depository, Sensor sensor, Date start, Date end, Boolean usePointValues)
InterpolatedValueList	getDailyValues(Depository depository, SensorGroup group, Date start, Date end, Boolean usePointValues)
DepositoryList	getDepositories()
Depository	getDepository(String id) Retrieves the Depository with the given id from the WattDepot Server.
SensorList	getDepositorySensors(String id)
DescriptiveStats	getDescriptiveStats(Depository depository, Sensor sensor, Date timestamp, Boolean daily, Integer samples, Boolean pointValues)
DescriptiveStats	getDescriptiveStats(Depository depository, SensorGroup group, Date timestamp, Boolean daily, Integer samples, Boolean pointValues)
InterpolatedValue	getEarliestValue(Depository depository, Sensor sensor)
InterpolatedValue	getEarliestValue(Depository depository, SensorGroup group)
InterpolatedValueList	getHistoricalValues(Depository depository, Sensor sensor, Date timestamp, Boolean daily, Integer samples, Boolean pointValues)
InterpolatedValueList	getHistoricalValues(Depository depository, SensorGroup group, Date timestamp, Boolean daily, Integer samples, Boolean pointValues)
InterpolatedValueList	getHourlyValues(Depository depository, Sensor sensor, Date start, Date end, Boolean usePointValues)
InterpolatedValueList	getHourlyValues(Depository depository, SensorGroup group, Date start, Date end, Boolean usePointValues)
InterpolatedValue	getLatestValue(Depository depository, Sensor sensor)
InterpolatedValue	getLatestValue(Depository depository, SensorGroup group)
InterpolatedValueList	getMaximumValues(Depository depository, Sensor sensor, Date start, Date end, Integer interval, Boolean usePointValues)
InterpolatedValueList	getMaximumValues(Depository depository, SensorGroup group, Date start, Date end, Integer interval, Boolean usePointValues)
MeasurementPruningDefinition	getMeasurementPruningDefinition(String id)
MeasurementPruningDefinitionList	getMeasurementPruningDefinitions()
MeasurementList	getMeasurements(Depository depository, Sensor sensor, Date start, Date end)
MeasurementList	getMeasurements(Depository depository, SensorGroup group, Date start, Date end)
MeasurementType	getMeasurementType(String id)
MeasurementTypeList	getMeasurementTypes()
InterpolatedValueList	getMinimumValues(Depository depository, Sensor sensor, Date start, Date end, Integer interval, Boolean usePointValues)
InterpolatedValueList	getMinimumValues(Depository depository, SensorGroup group, Date start, Date end, Integer interval, Boolean usePointValues)
String	getOrganizationId()
Sensor	getSensor(String id) Retrieves the Sensor with the given id from the WattDepot Server.
SensorGroup	getSensorGroup(String id) Retrieves the SensorGroup with the given id from the WattDepot Server.
SensorGroupList	getSensorGroups()
SensorModel	getSensorModel(String id) Retrieves the SensorModel with the given id from the WattDepot Server.
SensorModelList	getSensorModels()
SensorList	getSensors()
SensorStatus	getSensorStatus(Depository depository, Sensor sensor)
SensorStatusList	getSensorStatuses(Depository depository, SensorGroup group)
Double	getValue(Depository depository, Sensor sensor, Date timestamp)
Double	getValue(Depository depository, Sensor sensor, Date start, Date end)
Double	getValue(Depository depository, Sensor sensor, Date start, Date end, Long gapSeconds)
Double	getValue(Depository depository, Sensor sensor, Date timestamp, Long gapSeconds)
Double	getValue(Depository depository, SensorGroup group, Date timestamp)
Double	getValue(Depository depository, SensorGroup group, Date start, Date end)
Double	getValue(Depository depository, SensorGroup group, Date start, Date end, Long gapSeconds)
Double	getValue(Depository depository, SensorGroup group, Date timestamp, Long gapSeconds)
InterpolatedValueList	getValues(Depository depository, Sensor sensor, Date start, Date end, Integer interval, Boolean usePointValues)
InterpolatedValueList	getValues(Depository depository, SensorGroup group, Date start, Date end, Integer interval, Boolean usePointValues)
String	getWattDepotUri()
boolean	isDefinedCollectorProcessDefinition(String id) Checks to see if the given id is a defined CollectorProcessDefinition id.
boolean	isDefinedDepository(String id) Checks to see if the given id is a defined Depository id.
boolean	isDefinedMeasurementPruningDefinition(String id) Checks to see if the given id is a defined MeasurementPruningDefinition id.
boolean	isDefinedMeasurementType(String id) Checks to see if the given id is a defined MeasurementType id.
boolean	isDefinedSensor(String id) Checks to see if the given id is a defined Sensor id.
boolean	isDefinedSensorGroup(String id) Checks to see if the given id is a defined SensorGroup id.
boolean	isDefinedSensorModel(String id) Checks to see if the given id is a defined SensorModel id.
boolean	isHealthy() Determines the health of the WattDepot server the client is communicating with.
org.restlet.resource.ClientResource	makeClient(String requestString) Creates a ClientResource for the given request.
void	putCollectorProcessDefinition(CollectorProcessDefinition process) Stores the given CollectorProcessDefinitionData in the WattDepot Server.
void	putDepository(Depository depository) Stores the given Depository in the WattDepot Server.
void	putMeasurement(Depository depository, Measurement measurement)
void	putMeasurementPruningDefinition(MeasurementPruningDefinition gcd) Stores the given MeasurementPruningDefinition in the WattDepot Server.
void	putMeasurements(Depository depository, MeasurementList measurementList)
void	putMeasurementType(MeasurementType type) Stores the given MeasurementType in the WattDepot Server.
void	putSensor(Sensor sensor) Stores the given Sensor in the WattDepot Server.
void	putSensorGroup(SensorGroup group) Stores the given SensorGroup in the WattDepot Server.
void	putSensorModel(SensorModel model) Stores the given SensorModel in the WattDepot Server.
void	updateCollectorProcessDefinition(CollectorProcessDefinition process) Updates the given CollectorProcessDefinitionData in the WattDepot Server.
void	updateDepository(Depository depository) Updates the given Depository in the WattDepot Server.
void	updateMeasurementPruningDefinition(MeasurementPruningDefinition gcd) Updates the given MeasurementPruningDefinition in the WattDepot Server.
void	updateMeasurementType(MeasurementType type) Updates the given MeasurementType in the WattDepot Server.
void	updateSensor(Sensor sensor) Updates the given Sensor in the WattDepot Server.
void	updateSensorGroup(SensorGroup group) Updates the given SensorGroup in the WattDepot Server.
void	updateSensorModel(SensorModel model) Updates the given SensorModel in the WattDepot Server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WattDepotClient

public WattDepotClient(String serverUri,
               String username,
               String orgId,
               String password)
                throws BadCredentialException

Creates a new WattDepotClient.

Parameters:

serverUri - The URI of the WattDepot server (e.g. "http://server.wattdepot.org/")

username - The name of the user. The user must be defined in the WattDepot server.

orgId - the organization the user is in.

password - The password for the user.

Throws:

BadCredentialException - If the user or password don't match the credentials on the WattDepot server.

Method Detail

deleteCollectorProcessDefinition

public void deleteCollectorProcessDefinition(CollectorProcessDefinition process)
                                      throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given CollectorProcessDefinitionData.

Specified by:

deleteCollectorProcessDefinition in interface WattDepotInterface

Parameters:

process - the CollectorProcessDefinitionData to delete.

Throws:

IdNotFoundException - if the CollectorProcessDefinitionData is not found in the server.

deleteDepository

public void deleteDepository(Depository depository)
                      throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given Depository.

Specified by:

deleteDepository in interface WattDepotInterface

Parameters:

depository - the Depository to delete.

Throws:

IdNotFoundException - if the Depository is not found in the server.

deleteMeasurement

public void deleteMeasurement(Depository depository,
                     Measurement measurement)
                       throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given measurement from the given depository.

Specified by:

deleteMeasurement in interface WattDepotInterface

Parameters:

depository - the Depository that stores the measurement.

measurement - the Measurement to delete.

Throws:

IdNotFoundException - if the Measurement is not found in the Depository.

deleteMeasurementPruningDefinition

public void deleteMeasurementPruningDefinition(MeasurementPruningDefinition gcd)
                                        throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given MeasurementPruningDefinition from the WattDepotServer.

Specified by:

deleteMeasurementPruningDefinition in interface WattDepotInterface

Parameters:

gcd - The MeasurementPruningDefinition to delete.

Throws:

IdNotFoundException - if the MPD is not found.

deleteMeasurementType

public void deleteMeasurementType(MeasurementType type)
                           throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given MeasurementType.

Specified by:

deleteMeasurementType in interface WattDepotInterface

Parameters:

type - the measurement type to delete.

Throws:

IdNotFoundException - if the MeasurementType is not found in the Depository.

deleteSensor

public void deleteSensor(Sensor sensor)
                  throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given Sensor.

Specified by:

deleteSensor in interface WattDepotInterface

Parameters:

sensor - the Sensor to delete.

Throws:

IdNotFoundException - if the Sensor is not found in the server.

deleteSensorGroup

public void deleteSensorGroup(SensorGroup group)
                       throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given SensorGroup.

Specified by:

deleteSensorGroup in interface WattDepotInterface

Parameters:

group - the SensorGroup to delete.

Throws:

IdNotFoundException - if the SensorGroup is not found in the server.

deleteSensorModel

public void deleteSensorModel(SensorModel model)
                       throws IdNotFoundException

Description copied from interface: WattDepotInterface

Deletes the given SensorModel.

Specified by:

deleteSensorModel in interface WattDepotInterface

Parameters:

model - the SensorModel to delete.

Throws:

IdNotFoundException - if the SensorModel is not found in the server.

getAverageValues

public InterpolatedValueList getAverageValues(Depository depository,
                                     Sensor sensor,
                                     Date start,
                                     Date end,
                                     Integer interval,
                                     Boolean usePointValues)
                                       throws NoMeasurementException

Specified by:

getAverageValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The average InterpolatedValue of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getAverageValues

public InterpolatedValueList getAverageValues(Depository depository,
                                     SensorGroup group,
                                     Date start,
                                     Date end,
                                     Integer interval,
                                     Boolean usePointValues)
                                       throws NoMeasurementException

Specified by:

getAverageValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The sensor group making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The average InterpolatedValue of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getCollectorProcessDefinition

public CollectorProcessDefinition getCollectorProcessDefinition(String id)
                                                         throws IdNotFoundException

Description copied from interface: WattDepotInterface

Retrieves the CollectorProcessDefinitionData with the given id from the WattDepot Server.

Specified by:

getCollectorProcessDefinition in interface WattDepotInterface

Parameters:

id - The CollectorProcessDefinitionData's id.

Returns:

the CollectorProcessDefinitionData with the given id or null.

Throws:

IdNotFoundException - if the given id is not a CollectorProcessDefinitionData's id.

getCollectorProcessDefinitions

public CollectorProcessDefinitionList getCollectorProcessDefinitions()

Specified by:

getCollectorProcessDefinitions in interface WattDepotInterface

Returns:

The defined CollectorProcessDefinitions.

getDailyValues

public InterpolatedValueList getDailyValues(Depository depository,
                                   Sensor sensor,
                                   Date start,
                                   Date end,
                                   Boolean usePointValues)

Specified by:

getDailyValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The InterpolatedValueList of daily values between the start time and the end time.

getDailyValues

public InterpolatedValueList getDailyValues(Depository depository,
                                   SensorGroup group,
                                   Date start,
                                   Date end,
                                   Boolean usePointValues)

Specified by:

getDailyValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The sensor group making the measurements.

start - The start of the period.

end - The end of the period.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The InterpolatedValueList of daily values between the start time and the end time.

getDepositories

public DepositoryList getDepositories()

Specified by:

getDepositories in interface WattDepotInterface

Returns:

The defined Depositories.

getDepository

public Depository getDepository(String id)
                         throws IdNotFoundException

Description copied from interface: WattDepotInterface

Retrieves the Depository with the given id from the WattDepot Server.

Specified by:

getDepository in interface WattDepotInterface

Parameters:

id - The Depository's id.

Returns:

the Depository with the given id or null.

Throws:

IdNotFoundException - if the given id is not a Depository's id.

getDepositorySensors

public SensorList getDepositorySensors(String id)
                                throws IdNotFoundException

Specified by:

getDepositorySensors in interface WattDepotInterface

Parameters:

id - The depository id.

Returns:

a SensorList of the sensors contributing measurements to the depository.

Throws:

IdNotFoundException - if the id is not defined.

getDescriptiveStats

public DescriptiveStats getDescriptiveStats(Depository depository,
                                   Sensor sensor,
                                   Date timestamp,
                                   Boolean daily,
                                   Integer samples,
                                   Boolean pointValues)

Specified by:

getDescriptiveStats in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor making the Measurements.

timestamp - The time to base the historical values calculation on.

daily - if true, use daily grouping of values, if false use hourly grouping.

samples - How many samples to use to calculate the values. Corresponds to weeks.

pointValues - if true use point value, use difference values otherwise.

Returns:

The DescriptiveStats for the given sensor and depository using samples.

getDescriptiveStats

public DescriptiveStats getDescriptiveStats(Depository depository,
                                   SensorGroup group,
                                   Date timestamp,
                                   Boolean daily,
                                   Integer samples,
                                   Boolean pointValues)

Specified by:

getDescriptiveStats in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors are making the Measurements.

timestamp - The time to base the historical values calculation on.

daily - if true, use daily grouping of values, if false use hourly grouping.

samples - How many samples to use to calculate the values. Corresponds to weeks.

pointValues - if true use point value, use difference values otherwise.

Returns:

The DescriptiveStats for the given sensor and depository using samples.

getEarliestValue

public InterpolatedValue getEarliestValue(Depository depository,
                                 Sensor sensor)

Specified by:

getEarliestValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor making the Measurements.

Returns:

The earliest Value.

getEarliestValue

public InterpolatedValue getEarliestValue(Depository depository,
                                 SensorGroup group)

Specified by:

getEarliestValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors are making the Measurements.

Returns:

The earliest Value.

getHistoricalValues

public InterpolatedValueList getHistoricalValues(Depository depository,
                                        Sensor sensor,
                                        Date timestamp,
                                        Boolean daily,
                                        Integer samples,
                                        Boolean pointValues)

Specified by:

getHistoricalValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor making the Measurements.

timestamp - The time to base the historical values calculation on.

daily - if true, use daily grouping of values, if false use hourly grouping.

samples - How many samples to use to calculate the values. Corresponds to weeks.

pointValues - if true use point value, use difference values otherwise.

Returns:

The values for the given sensor and depository using samples in an InterpolatedValueList.

getHistoricalValues

public InterpolatedValueList getHistoricalValues(Depository depository,
                                        SensorGroup group,
                                        Date timestamp,
                                        Boolean daily,
                                        Integer samples,
                                        Boolean pointValues)

Specified by:

getHistoricalValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors are making the Measurements.

timestamp - The time to base the historical values calculation on.

daily - if true, use daily grouping of values, if false use hourly grouping.

samples - How many samples to use to calculate the values. Corresponds to weeks.

pointValues - if true use point value, use difference values otherwise.

Returns:

The values for the given sensor and depository using samples in an InterpolatedValueList.

getHourlyValues

public InterpolatedValueList getHourlyValues(Depository depository,
                                    Sensor sensor,
                                    Date start,
                                    Date end,
                                    Boolean usePointValues)

Specified by:

getHourlyValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The InterpolatedValueList of hourly values between the start time and the end time.

getHourlyValues

public InterpolatedValueList getHourlyValues(Depository depository,
                                    SensorGroup group,
                                    Date start,
                                    Date end,
                                    Boolean usePointValues)

Specified by:

getHourlyValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The sensor group making the measurements.

start - The start of the period.

end - The end of the period.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The InterpolatedValueList of hourly values between the start time and the end time.

getLatestValue

public InterpolatedValue getLatestValue(Depository depository,
                               Sensor sensor)

Specified by:

getLatestValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor making the Measurements.

Returns:

The latest Measurement.

getLatestValue

public InterpolatedValue getLatestValue(Depository depository,
                               SensorGroup group)

Specified by:

getLatestValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors are making the Measurements.

Returns:

The latest Value.

getMaximumValues

public InterpolatedValueList getMaximumValues(Depository depository,
                                     SensorGroup group,
                                     Date start,
                                     Date end,
                                     Integer interval,
                                     Boolean usePointValues)
                                       throws NoMeasurementException

Specified by:

getMaximumValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The sensor group making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The maximum InterpolatedValue of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getMaximumValues

public InterpolatedValueList getMaximumValues(Depository depository,
                                     Sensor sensor,
                                     Date start,
                                     Date end,
                                     Integer interval,
                                     Boolean usePointValues)
                                       throws NoMeasurementException

Specified by:

getMaximumValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The maximum InterpolatedValue of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getMeasurementPruningDefinition

public MeasurementPruningDefinition getMeasurementPruningDefinition(String id)
                                                             throws IdNotFoundException

Specified by:

getMeasurementPruningDefinition in interface WattDepotInterface

Parameters:

id - The MeasurementPruningDefinition id.

Returns:

The defined MeasurementPruningDefinition.

Throws:

IdNotFoundException - if id is not defined.

getMeasurementPruningDefinitions

public MeasurementPruningDefinitionList getMeasurementPruningDefinitions()

Specified by:

getMeasurementPruningDefinitions in interface WattDepotInterface

Returns:

All the defined MeasurementPruningDefinitions.

getMeasurementType

public MeasurementType getMeasurementType(String id)
                                   throws IdNotFoundException

Specified by:

getMeasurementType in interface WattDepotInterface

Parameters:

id - the unique id for the MeasurementType.

Returns:

The MeasurementType.

Throws:

IdNotFoundException - if the given id is not a MeasurementType's id.

getMeasurementTypes

public MeasurementTypeList getMeasurementTypes()

Specified by:

getMeasurementTypes in interface WattDepotInterface

Returns:

The defined MeasurementTypes.

getMeasurements

public MeasurementList getMeasurements(Depository depository,
                              Sensor sensor,
                              Date start,
                              Date end)

Specified by:

getMeasurements in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor that made the measurements.

start - The start time.

end - The end time.

Returns:

The Measurements stored in the depository made by the sensor between start and end.

getMeasurements

public MeasurementList getMeasurements(Depository depository,
                              SensorGroup group,
                              Date start,
                              Date end)

Specified by:

getMeasurements in interface WattDepotInterface

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors made the measurements.

start - The start time.

end - The end time.

Returns:

The Measurements stored in the depository made by the sensor between start and end.

getMinimumValues

public InterpolatedValueList getMinimumValues(Depository depository,
                                     Sensor sensor,
                                     Date start,
                                     Date end,
                                     Integer interval,
                                     Boolean usePointValues)
                                       throws NoMeasurementException

Specified by:

getMinimumValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The minimum InterpolatedValue of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getMinimumValues

public InterpolatedValueList getMinimumValues(Depository depository,
                                     SensorGroup group,
                                     Date start,
                                     Date end,
                                     Integer interval,
                                     Boolean usePointValues)
                                       throws NoMeasurementException

Specified by:

getMinimumValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The sensor group making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The minimum InterpolatedValue of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getOrganizationId

public String getOrganizationId()

Returns:

the organization id.

getSensor

public Sensor getSensor(String id)
                 throws IdNotFoundException

Description copied from interface: WattDepotInterface

Retrieves the Sensor with the given id from the WattDepot Server.

Specified by:

getSensor in interface WattDepotInterface

Parameters:

id - The Sensor's id.

Returns:

the Sensor with the given id or null.

Throws:

IdNotFoundException - if the given id is not a Sensor's id.

getSensorGroup

public SensorGroup getSensorGroup(String id)
                           throws IdNotFoundException

Description copied from interface: WattDepotInterface

Retrieves the SensorGroup with the given id from the WattDepot Server.

Specified by:

getSensorGroup in interface WattDepotInterface

Parameters:

id - The SensorGroup's id.

Returns:

the SensorGroup with the given id or null.

Throws:

IdNotFoundException - if the given id is not a SensorGroup's id.

getSensorGroups

public SensorGroupList getSensorGroups()

Specified by:

getSensorGroups in interface WattDepotInterface

Returns:

The defined SensorGroups.

getSensorModel

public SensorModel getSensorModel(String id)
                           throws IdNotFoundException

Description copied from interface: WattDepotInterface

Retrieves the SensorModel with the given id from the WattDepot Server.

Specified by:

getSensorModel in interface WattDepotInterface

Parameters:

id - The SensorModel's id.

Returns:

the SensorModel with the given id or null.

Throws:

IdNotFoundException - if the given id is not a SensorModel's id.

getSensorModels

public SensorModelList getSensorModels()

Specified by:

getSensorModels in interface WattDepotInterface

Returns:

The defined SensorModels.

getSensorStatus

public SensorStatus getSensorStatus(Depository depository,
                           Sensor sensor)

Specified by:

getSensorStatus in interface WattDepotInterface

Parameters:

depository - The depository to check.

sensor - The Sensor.

Returns:

The current sensor status.

getSensorStatuses

public SensorStatusList getSensorStatuses(Depository depository,
                                 SensorGroup group)

Specified by:

getSensorStatuses in interface WattDepotInterface

Parameters:

depository - The depository to check.

group - The SensorGroup.

Returns:

A list of SensorStatuses.

getSensors

public SensorList getSensors()

Specified by:

getSensors in interface WattDepotInterface

Returns:

The defined Sensors.

getValue

public Double getValue(Depository depository,
              Sensor sensor,
              Date timestamp)
                throws NoMeasurementException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

timestamp - The time for the measured value.

Returns:

The Value 'measured' at the given time, most likely an interpolated value.

Throws:

NoMeasurementException - if there aren't any measurements around the timestamp.

getValue

public Double getValue(Depository depository,
              Sensor sensor,
              Date start,
              Date end)
                throws NoMeasurementException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

Returns:

The value measured the difference between the end value and the start value.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getValue

public Double getValue(Depository depository,
              Sensor sensor,
              Date start,
              Date end,
              Long gapSeconds)
                throws NoMeasurementException,
                       MeasurementGapException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The Sensor making the measurements.

start - The start of the interval.

end - The end of the interval

gapSeconds - The maximum number of seconds that measurements need to be within the start and end.

Returns:

The value measured the difference between the end value and the start value.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

MeasurementGapException - if the measurements around start or end are too far apart.

getValue

public Double getValue(Depository depository,
              Sensor sensor,
              Date timestamp,
              Long gapSeconds)
                throws NoMeasurementException,
                       MeasurementGapException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The Sensor making the measurements.

timestamp - The time of the value.

gapSeconds - The maximum number of seconds that measurements need to be within the start and end.

Returns:

The Value 'measured' at the given time, most likely an interpolated value.

Throws:

NoMeasurementException - If there aren't any measurements around the time.

MeasurementGapException - if the measurements around timestamp are too far apart.

getValue

public Double getValue(Depository depository,
              SensorGroup group,
              Date timestamp)
                throws NoMeasurementException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The SensorGroup whose sensors are making the measurements.

timestamp - The time for the measured value.

Returns:

The Value 'measured' at the given time, most likely an interpolated value.

Throws:

NoMeasurementException - if there aren't any measurements around the timestamp.

getValue

public Double getValue(Depository depository,
              SensorGroup group,
              Date start,
              Date end)
                throws NoMeasurementException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The SensorGroup whose Sensors are making the measurements.

start - The start of the period.

end - The end of the period.

Returns:

The value measured the difference between the end value and the start value.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getValue

public Double getValue(Depository depository,
              SensorGroup group,
              Date start,
              Date end,
              Long gapSeconds)
                throws NoMeasurementException,
                       MeasurementGapException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The SensorGroup whose Sensors are making the measurements.

start - The start of the interval.

end - The end of the interval

gapSeconds - The maximum number of seconds that measurements need to be within the start and end.

Returns:

The value measured the difference between the end value and the start value.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

MeasurementGapException - if the measurements around start or end are too far apart.

getValue

public Double getValue(Depository depository,
              SensorGroup group,
              Date timestamp,
              Long gapSeconds)
                throws NoMeasurementException,
                       MeasurementGapException

Specified by:

getValue in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The SensorGroup whose Sensors are making the measurements.

timestamp - The time of the value.

gapSeconds - The maximum number of seconds that measurements need to be within the start and end.

Returns:

The Value 'measured' at the given time, most likely an interpolated value.

Throws:

NoMeasurementException - If there aren't any measurements around the time.

MeasurementGapException - if the measurements around timestamp are too far apart.

getValues

public InterpolatedValueList getValues(Depository depository,
                              Sensor sensor,
                              Date start,
                              Date end,
                              Integer interval,
                              Boolean usePointValues)
                                throws NoMeasurementException

Specified by:

getValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

sensor - The sensor making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The InterpolatedValueList of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getValues

public InterpolatedValueList getValues(Depository depository,
                              SensorGroup group,
                              Date start,
                              Date end,
                              Integer interval,
                              Boolean usePointValues)
                                throws NoMeasurementException

Specified by:

getValues in interface WattDepotInterface

Parameters:

depository - The Depository storing the measurements.

group - The sensor group making the measurements.

start - The start of the period.

end - The end of the period.

interval - The sample interval in minutes.

usePointValues - Use point values or difference values, if true point values are used, otherwise difference values.

Returns:

The InterpolatedValueList of measured values between the start time and the end time.

Throws:

NoMeasurementException - if there are no measurements around the start or end time.

getWattDepotUri

public String getWattDepotUri()

Returns:

the wattDepotUri

isDefinedCollectorProcessDefinition

public boolean isDefinedCollectorProcessDefinition(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined CollectorProcessDefinition id.

Specified by:

isDefinedCollectorProcessDefinition in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined CollectorProcessDefinition's id.

isDefinedDepository

public boolean isDefinedDepository(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined Depository id.

Specified by:

isDefinedDepository in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined Depository's id.

isDefinedMeasurementPruningDefinition

public boolean isDefinedMeasurementPruningDefinition(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined MeasurementPruningDefinition id.

Specified by:

isDefinedMeasurementPruningDefinition in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined MeasurementPruningDefinition's id.

isDefinedMeasurementType

public boolean isDefinedMeasurementType(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined MeasurementType id.

Specified by:

isDefinedMeasurementType in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined MeasurementType's id.

isDefinedSensor

public boolean isDefinedSensor(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined Sensor id.

Specified by:

isDefinedSensor in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined Sensor's id.

isDefinedSensorGroup

public boolean isDefinedSensorGroup(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined SensorGroup id.

Specified by:

isDefinedSensorGroup in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined SensorGroup's id.

isDefinedSensorModel

public boolean isDefinedSensorModel(String id)

Description copied from interface: WattDepotInterface

Checks to see if the given id is a defined SensorModel id.

Specified by:

isDefinedSensorModel in interface WattDepotInterface

Parameters:

id - the id to check.

Returns:

true if the id is a defined SensorModel's id.

isHealthy

public boolean isHealthy()

Description copied from interface: WattDepotInterface

Determines the health of the WattDepot server the client is communicating with.

Specified by:

isHealthy in interface WattDepotInterface

Returns:

true if the server is healthy, false if cannot connect.

makeClient

public org.restlet.resource.ClientResource makeClient(String requestString)

Creates a ClientResource for the given request. Calling code MUST release the ClientResource when finished.

Parameters:

requestString - A String, the request portion of the WattDepot HTTP API, such as "

Returns:

The client resource.

putCollectorProcessDefinition

public void putCollectorProcessDefinition(CollectorProcessDefinition process)

Description copied from interface: WattDepotInterface

Stores the given CollectorProcessDefinitionData in the WattDepot Server.

Specified by:

putCollectorProcessDefinition in interface WattDepotInterface

Parameters:

process - the CollectorProcessDefinitionData.

putDepository

public void putDepository(Depository depository)

Description copied from interface: WattDepotInterface

Stores the given Depository in the WattDepot Server.

Specified by:

putDepository in interface WattDepotInterface

Parameters:

depository - the Depository.

putMeasurement

public void putMeasurement(Depository depository,
                  Measurement measurement)
                    throws MeasurementTypeException

Specified by:

putMeasurement in interface WattDepotInterface

Parameters:

depository - The Depository to store the Measurement.

measurement - The Measurement to store.

Throws:

MeasurementTypeException - if the type of the measurement doesn't match the type of the depository.

putMeasurementPruningDefinition

public void putMeasurementPruningDefinition(MeasurementPruningDefinition gcd)

Description copied from interface: WattDepotInterface

Stores the given MeasurementPruningDefinition in the WattDepot Server.

Specified by:

putMeasurementPruningDefinition in interface WattDepotInterface

Parameters:

gcd - the MeasurementPruningDefinition.

putMeasurementType

public void putMeasurementType(MeasurementType type)

Description copied from interface: WattDepotInterface

Stores the given MeasurementType in the WattDepot Server.

Specified by:

putMeasurementType in interface WattDepotInterface

Parameters:

type - the MeasurementType.

putMeasurements

public void putMeasurements(Depository depository,
                   MeasurementList measurementList)
                     throws MeasurementTypeException,
                            MeasurementListSizeExceededException

Specified by:

putMeasurements in interface WattDepotInterface

Parameters:

depository - The Depository to store the Measurement.

measurementList - The MeasurementList to be stored.

Throws:

MeasurementTypeException - if the type of a measurement doesn't match the type of the depository.

MeasurementListSizeExceededException - if list size requirement is exceeded.

putSensor

public void putSensor(Sensor sensor)

Description copied from interface: WattDepotInterface

Stores the given Sensor in the WattDepot Server.

Specified by:

putSensor in interface WattDepotInterface

Parameters:

sensor - the Sensor.

putSensorGroup

public void putSensorGroup(SensorGroup group)

Description copied from interface: WattDepotInterface

Stores the given SensorGroup in the WattDepot Server.

Specified by:

putSensorGroup in interface WattDepotInterface

Parameters:

group - the SensorGroup.

putSensorModel

public void putSensorModel(SensorModel model)

Description copied from interface: WattDepotInterface

Stores the given SensorModel in the WattDepot Server.

Specified by:

putSensorModel in interface WattDepotInterface

Parameters:

model - the SensorModel.

updateCollectorProcessDefinition

public void updateCollectorProcessDefinition(CollectorProcessDefinition process)

Description copied from interface: WattDepotInterface

Updates the given CollectorProcessDefinitionData in the WattDepot Server.

Specified by:

updateCollectorProcessDefinition in interface WattDepotInterface

Parameters:

process - The CollectorProcessDefinitionData to update.

updateDepository

public void updateDepository(Depository depository)

Description copied from interface: WattDepotInterface

Updates the given Depository in the WattDepot Server.

Specified by:

updateDepository in interface WattDepotInterface

Parameters:

depository - The Depository to update.

updateMeasurementPruningDefinition

public void updateMeasurementPruningDefinition(MeasurementPruningDefinition gcd)

Description copied from interface: WattDepotInterface

Updates the given MeasurementPruningDefinition in the WattDepot Server.

Specified by:

updateMeasurementPruningDefinition in interface WattDepotInterface

Parameters:

gcd - The MeasurementPruningDefinition to update.

updateMeasurementType

public void updateMeasurementType(MeasurementType type)

Description copied from interface: WattDepotInterface

Updates the given MeasurementType in the WattDepot Server.

Specified by:

updateMeasurementType in interface WattDepotInterface

Parameters:

type - the MeasurementType to update.

updateSensor

public void updateSensor(Sensor sensor)

Description copied from interface: WattDepotInterface

Updates the given Sensor in the WattDepot Server.

Specified by:

updateSensor in interface WattDepotInterface

Parameters:

sensor - The Sensor to update.

updateSensorGroup

public void updateSensorGroup(SensorGroup group)

Description copied from interface: WattDepotInterface

Updates the given SensorGroup in the WattDepot Server.

Specified by:

updateSensorGroup in interface WattDepotInterface

Parameters:

group - The SensorGroup to update.

updateSensorModel

public void updateSensorModel(SensorModel model)

Description copied from interface: WattDepotInterface

Updates the given SensorModel in the WattDepot Server.

Specified by:

updateSensorModel in interface WattDepotInterface

Parameters:

model - the SensorModel to update.