org.wattdepot.client

Interface WattDepotInterface

All Known Implementing Classes:

WattDepotAdminClient, WattDepotClient

public interface WattDepotInterface

WattDepotInterface - The CRUD interface to the WattDepot server for regular users.

Author:

Cam Moore

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)
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)
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.
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.

Method Detail

deleteCollectorProcessDefinition

void deleteCollectorProcessDefinition(CollectorProcessDefinition process)
                                      throws IdNotFoundException

Deletes the given CollectorProcessDefinitionData.

Parameters:

process - the CollectorProcessDefinitionData to delete.

Throws:

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

deleteDepository

void deleteDepository(Depository depository)
                      throws IdNotFoundException

Deletes the given Depository.

Parameters:

depository - the Depository to delete.

Throws:

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

deleteMeasurement

void deleteMeasurement(Depository depository,
                     Measurement measurement)
                       throws IdNotFoundException

Deletes the given measurement from the given depository.

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

void deleteMeasurementPruningDefinition(MeasurementPruningDefinition gcd)
                                        throws IdNotFoundException

Deletes the given MeasurementPruningDefinition from the WattDepotServer.

Parameters:

gcd - The MeasurementPruningDefinition to delete.

Throws:

IdNotFoundException - if the MPD is not found.

deleteMeasurementType

void deleteMeasurementType(MeasurementType type)
                           throws IdNotFoundException

Deletes the given MeasurementType.

Parameters:

type - the measurement type to delete.

Throws:

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

deleteSensor

void deleteSensor(Sensor sensor)
                  throws IdNotFoundException

Deletes the given Sensor.

Parameters:

sensor - the Sensor to delete.

Throws:

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

deleteSensorGroup

void deleteSensorGroup(SensorGroup group)
                       throws IdNotFoundException

Deletes the given SensorGroup.

Parameters:

group - the SensorGroup to delete.

Throws:

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

deleteSensorModel

void deleteSensorModel(SensorModel model)
                       throws IdNotFoundException

Deletes the given SensorModel.

Parameters:

model - the SensorModel to delete.

Throws:

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

getAverageValues

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

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

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

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

CollectorProcessDefinition getCollectorProcessDefinition(String id)
                                                         throws IdNotFoundException

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

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

CollectorProcessDefinitionList getCollectorProcessDefinitions()

Returns:

The defined CollectorProcessDefinitions.

getDailyValues

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

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

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

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

DepositoryList getDepositories()

Returns:

The defined Depositories.

getDepository

Depository getDepository(String id)
                         throws IdNotFoundException

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

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

SensorList getDepositorySensors(String id)
                                throws IdNotFoundException

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

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

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

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

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

InterpolatedValue getEarliestValue(Depository depository,
                                 Sensor sensor)

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor making the Measurements.

Returns:

The earliest Value.

getEarliestValue

InterpolatedValue getEarliestValue(Depository depository,
                                 SensorGroup group)

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors are making the Measurements.

Returns:

The earliest Value.

getHistoricalValues

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

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

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

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

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

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

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

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

InterpolatedValue getLatestValue(Depository depository,
                               Sensor sensor)

Parameters:

depository - The Depository storing the Measurements.

sensor - The Sensor making the Measurements.

Returns:

The latest Measurement.

getLatestValue

InterpolatedValue getLatestValue(Depository depository,
                               SensorGroup group)

Parameters:

depository - The Depository storing the Measurements.

group - The SensorGroup whose sensors are making the Measurements.

Returns:

The latest Value.

getMaximumValues

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

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.

getMaximumValues

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

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.

getMeasurementPruningDefinition

MeasurementPruningDefinition getMeasurementPruningDefinition(String id)
                                                             throws IdNotFoundException

Parameters:

id - The MeasurementPruningDefinition id.

Returns:

The defined MeasurementPruningDefinition.

Throws:

IdNotFoundException - if id is not defined.

getMeasurementPruningDefinitions

MeasurementPruningDefinitionList getMeasurementPruningDefinitions()

Returns:

All the defined MeasurementPruningDefinitions.

getMeasurementType

MeasurementType getMeasurementType(String id)
                                   throws IdNotFoundException

Parameters:

id - the unique id for the MeasurementType.

Returns:

The MeasurementType.

Throws:

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

getMeasurementTypes

MeasurementTypeList getMeasurementTypes()

Returns:

The defined MeasurementTypes.

getMeasurements

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

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

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

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

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

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

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

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.

getSensor

Sensor getSensor(String id)
                 throws IdNotFoundException

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

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

SensorGroup getSensorGroup(String id)
                           throws IdNotFoundException

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

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

SensorGroupList getSensorGroups()

Returns:

The defined SensorGroups.

getSensorModel

SensorModel getSensorModel(String id)
                           throws IdNotFoundException

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

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

SensorModelList getSensorModels()

Returns:

The defined SensorModels.

getSensorStatus

SensorStatus getSensorStatus(Depository depository,
                           Sensor sensor)

Parameters:

depository - The depository to check.

sensor - The Sensor.

Returns:

The current sensor status.

getSensorStatuses

SensorStatusList getSensorStatuses(Depository depository,
                                 SensorGroup group)

Parameters:

depository - The depository to check.

group - The SensorGroup.

Returns:

A list of SensorStatuses.

getSensors

SensorList getSensors()

Returns:

The defined Sensors.

getValue

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

isDefinedCollectorProcessDefinition

boolean isDefinedCollectorProcessDefinition(String id)

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

Parameters:

id - the id to check.

Returns:

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

isDefinedDepository

boolean isDefinedDepository(String id)

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

Parameters:

id - the id to check.

Returns:

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

isDefinedMeasurementPruningDefinition

boolean isDefinedMeasurementPruningDefinition(String id)

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

Parameters:

id - the id to check.

Returns:

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

isDefinedMeasurementType

boolean isDefinedMeasurementType(String id)

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

Parameters:

id - the id to check.

Returns:

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

isDefinedSensor

boolean isDefinedSensor(String id)

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

Parameters:

id - the id to check.

Returns:

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

isDefinedSensorGroup

boolean isDefinedSensorGroup(String id)

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

Parameters:

id - the id to check.

Returns:

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

isDefinedSensorModel

boolean isDefinedSensorModel(String id)

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

Parameters:

id - the id to check.

Returns:

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

isHealthy

boolean isHealthy()

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

Returns:

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

putCollectorProcessDefinition

void putCollectorProcessDefinition(CollectorProcessDefinition process)

Stores the given CollectorProcessDefinitionData in the WattDepot Server.

Parameters:

process - the CollectorProcessDefinitionData.

putDepository

void putDepository(Depository depository)

Stores the given Depository in the WattDepot Server.

Parameters:

depository - the Depository.

putMeasurement

void putMeasurement(Depository depository,
                  Measurement measurement)
                    throws MeasurementTypeException

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

void putMeasurementPruningDefinition(MeasurementPruningDefinition gcd)

Stores the given MeasurementPruningDefinition in the WattDepot Server.

Parameters:

gcd - the MeasurementPruningDefinition.

putMeasurementType

void putMeasurementType(MeasurementType type)

Stores the given MeasurementType in the WattDepot Server.

Parameters:

type - the MeasurementType.

putMeasurements

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

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

void putSensor(Sensor sensor)

Stores the given Sensor in the WattDepot Server.

Parameters:

sensor - the Sensor.

putSensorGroup

void putSensorGroup(SensorGroup group)

Stores the given SensorGroup in the WattDepot Server.

Parameters:

group - the SensorGroup.

putSensorModel

void putSensorModel(SensorModel model)

Stores the given SensorModel in the WattDepot Server.

Parameters:

model - the SensorModel.

updateCollectorProcessDefinition

void updateCollectorProcessDefinition(CollectorProcessDefinition process)

Updates the given CollectorProcessDefinitionData in the WattDepot Server.

Parameters:

process - The CollectorProcessDefinitionData to update.

updateDepository

void updateDepository(Depository depository)

Updates the given Depository in the WattDepot Server.

Parameters:

depository - The Depository to update.

updateMeasurementPruningDefinition

void updateMeasurementPruningDefinition(MeasurementPruningDefinition gcd)

Updates the given MeasurementPruningDefinition in the WattDepot Server.

Parameters:

gcd - The MeasurementPruningDefinition to update.

updateMeasurementType

void updateMeasurementType(MeasurementType type)

Updates the given MeasurementType in the WattDepot Server.

Parameters:

type - the MeasurementType to update.

updateSensor

void updateSensor(Sensor sensor)

Updates the given Sensor in the WattDepot Server.

Parameters:

sensor - The Sensor to update.

updateSensorGroup

void updateSensorGroup(SensorGroup group)

Updates the given SensorGroup in the WattDepot Server.

Parameters:

group - The SensorGroup to update.

updateSensorModel

void updateSensorModel(SensorModel model)

Updates the given SensorModel in the WattDepot Server.

Parameters:

model - the SensorModel to update.