org.wattdepot.server

Class WattDepotPersistence

java.lang.Object

org.wattdepot.server.WattDepotPersistence

Direct Known Subclasses:

WattDepotPersistenceImpl

public abstract class WattDepotPersistence
extends Object

WattDepot persistence abstract interface. Different persistence implementations should subclass this class and implement their persistence schemes.

Author:

Cam Moore

Constructor Summary

Constructors

Constructor and Description
WattDepotPersistence()

Method Summary

Methods

Modifier and Type	Method and Description
abstract CollectorProcessDefinition	defineCollectorProcessDefinition(String id, String name, String sensorId, Long pollingInterval, String depositoryId, Set<Property> properties, String orgId) Defines a new CollectorProcessDefinition.
abstract Depository	defineDepository(String id, String name, MeasurementType measurementType, String orgId) Defines a new WattDepository in WattDepot.
abstract MeasurementPruningDefinition	defineMeasurementPruningDefinition(String id, String name, String depositoryId, String sensorId, String orgId, Integer ignore, Integer collect, Integer gap) Defines a new MeasurementPruningDefinition.
abstract MeasurementType	defineMeasurementType(String id, String name, String units) Defines a new MeasurementType in WattDepot.
abstract Organization	defineOrganization(String id, String name, Set<String> users)
abstract Sensor	defineSensor(String id, String name, String uri, String modelId, Set<Property> properties, String orgId)
abstract SensorGroup	defineSensorGroup(String id, String name, Set<String> sensors, String orgId)
abstract SensorModel	defineSensorModel(String id, String name, String protocol, String type, String version) Defines a new SensorModel in WattDepot.
abstract UserInfo	defineUserInfo(String userId, String firstName, String lastName, String email, String orgId, Set<Property> properties, String password) Defines a new UserInfo with the given information.
abstract void	deleteCollectorProcessDefinition(String id, String orgId) Deletes the given CollectorProcessDefinition.
abstract void	deleteDepository(String id, String orgId) Deletes the given WattDepository.
abstract void	deleteMeasurement(String depotId, String orgId, String measId)
abstract void	deleteMeasurementPruningDefinition(String id, String orgId) Deletes the given MeasurementPruningDefinition.
abstract void	deleteMeasurementType(String id) Deletes the given measurement type.
abstract void	deleteOrganization(String id)
abstract void	deleteSensor(String id, String orgId) Deletes the given Sensor.
abstract void	deleteSensorGroup(String id, String orgId) Deletes the given SensorGroup.
abstract void	deleteSensorModel(String id) Deletes the given SensorModel.
abstract void	deleteUser(String id, String orgId)
abstract void	deleteUserPassword(String userId, String orgId)
abstract CollectorProcessDefinition	getCollectorProcessDefinition(String id, String orgId, boolean check)
abstract List<String>	getCollectorProcessDefinitionIds(String orgId, boolean check)
abstract List<CollectorProcessDefinition>	getCollectorProcessDefinitions(String orgId, boolean check)
abstract List<Depository>	getDepositories(String orgId, boolean check)
abstract Depository	getDepository(String id, String orgId, boolean check)
abstract List<String>	getDepositoryIds(String orgId, boolean check)
abstract InterpolatedValue	getEarliestMeasuredValue(String depotId, String orgId, String sensorId, boolean check)
abstract InterpolatedValue	getLatestMeasuredValue(String depotId, String orgId, String sensorId, boolean check)
abstract InterpolatedValue	getLatestMeasuredValue(String depotId, String orgId, String sensorId, Long window, boolean check)
abstract Measurement	getMeasurement(String depotId, String orgId, String measId, boolean check)
abstract MeasurementPruningDefinition	getMeasurementPruningDefinition(String id, String orgId, boolean check)
abstract List<String>	getMeasurementPruningDefinitionIds(String orgId, boolean check)
abstract List<MeasurementPruningDefinition>	getMeasurementPruningDefinitions(String orgId, boolean check)
abstract List<Measurement>	getMeasurements(String depotId, String orgId, String sensorId, boolean check)
abstract List<Measurement>	getMeasurements(String depotId, String orgId, String sensorId, Date start, Date end, boolean check)
abstract Long	getMeasurementsCount(String orgId, boolean check)
abstract Long	getMeasurementsCount(String depotId, String orgId, String sensorId, boolean check)
abstract Long	getMeasurementsCount(String depotId, String orgId, String sensorId, Date start, Date end, boolean check)
abstract MeasurementType	getMeasurementType(String id, boolean check)
abstract List<MeasurementType>	getMeasurementTypes()
abstract Organization	getOrganization(String id, boolean check)
abstract List<String>	getOrganizationIds()
abstract List<Organization>	getOrganizations()
abstract MeasurementRateSummary	getRateSummary(String depotId, String orgId, String sensorId, boolean check)
abstract Sensor	getSensor(String id, String orgId, boolean check)
abstract SensorGroup	getSensorGroup(String id, String orgId, boolean check)
abstract List<String>	getSensorGroupIds(String orgId, boolean check)
abstract List<SensorGroup>	getSensorGroups(String orgId, boolean check)
abstract List<String>	getSensorIds(String orgId, boolean check)
abstract SensorModel	getSensorModel(String id, boolean check)
abstract List<String>	getSensorModelIds()
abstract List<SensorModel>	getSensorModels()
abstract List<Sensor>	getSensors(String orgId, boolean check)
ServerProperties	getServerProperties()
int	getSessionClose()
int	getSessionOpen()
abstract SensorMeasurementSummary	getSummary(String depotId, String orgId, String sensorId, Date start, Date end, boolean check)
abstract UserInfo	getUser(String id, String orgId, boolean check)
abstract List<String>	getUserIds(String orgId, boolean check)
abstract UserPassword	getUserPassword(String id, String orgId, boolean check)
abstract List<UserInfo>	getUsers()
abstract List<UserInfo>	getUsers(String orgId, boolean check)
abstract Double	getValue(String depotId, String orgId, String sensorId, Date timestamp, boolean check)
abstract Double	getValue(String depotId, String orgId, String sensorId, Date start, Date end, boolean check)
abstract Double	getValue(String depotId, String orgId, String sensorId, Date start, Date end, Long gapSeconds, boolean check)
abstract Double	getValue(String depotId, String orgId, String sensorId, Date timestamp, Long gapSeconds, boolean check)
void	initializeMeasurementTypes() Ensures the base set of MeasurementTypes are defined in WattDepot.
void	initializeSensorModels() Ensures the base set of SensorModels are defined in WattDepot.
abstract List<String>	listSensors(String depotId, String orgId, boolean check)
abstract void	putMeasurement(String depotId, String orgId, Measurement meas)
abstract void	putMeasurementList(String depotId, String orgId, MeasurementList measurementList)
void	setServerProperties(ServerProperties properties)
abstract void	stop() Cleans up the persistence layer.
abstract CollectorProcessDefinition	updateCollectorProcessDefinition(CollectorProcessDefinition process) Updates the given CollectorProcessDefinition in the persistent store.
abstract MeasurementPruningDefinition	updateMeasurementPruningDefinition(MeasurementPruningDefinition gcd) Updates the given MeasurementPruningDefinition in the persistent store.
abstract MeasurementType	updateMeasurementType(MeasurementType type) Updates the given measurement type in the persistent store.
abstract Organization	updateOrganization(Organization org)
abstract Sensor	updateSensor(Sensor sensor) Updates the given sensor in the persistent store.
abstract SensorGroup	updateSensorGroup(SensorGroup group) Updates the given sensor group in the persistent store.
abstract SensorModel	updateSensorModel(SensorModel model) Updates the given sensor model in the persistent store.
abstract UserInfo	updateUserInfo(UserInfo user)
abstract UserPassword	updateUserPassword(UserPassword password)

Methods inherited from class java.lang.Object

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

Constructor Detail

WattDepotPersistence

public WattDepotPersistence()

Method Detail

defineCollectorProcessDefinition

public abstract CollectorProcessDefinition defineCollectorProcessDefinition(String id,
                                                          String name,
                                                          String sensorId,
                                                          Long pollingInterval,
                                                          String depositoryId,
                                                          Set<Property> properties,
                                                          String orgId)
                                                                     throws UniqueIdException,
                                                                            MisMatchedOwnerException,
                                                                            IdNotFoundException,
                                                                            BadSlugException

Defines a new CollectorProcessDefinition. This does not start any processes.

Parameters:

id - The unique id.

name - The unique name.

sensorId - The id of the Sensor to poll.

pollingInterval - The polling interval.

depositoryId - The id of the depository to use.

properties - The properties associated with this CollectorProcessDefinition.

orgId - the id of the owner of the CollectorProcessDefinition

Returns:

The defined CollectorProcessDefinition.

Throws:

UniqueIdException - if the id is already used for another CollectorProcessDefinintion.

MisMatchedOwnerException - if the given owner doesn't match the owners of the Sensor or Depository.

IdNotFoundException - if the sensorId or orgId are not defined.

BadSlugException - if the given id isn't valid.

defineDepository

public abstract Depository defineDepository(String id,
                          String name,
                          MeasurementType measurementType,
                          String orgId)
                                     throws UniqueIdException,
                                            IdNotFoundException,
                                            BadSlugException

Defines a new WattDepository in WattDepot.

Parameters:

id - The unique id.

name - The name.

measurementType - the Measurement Type.

orgId - the id of the owner of the WattDepository.

Returns:

the defined WattDepository.

Throws:

UniqueIdException - if the id is already used for another WattDepository.

IdNotFoundException - if the orgId is not defined.

BadSlugException - if the id isn't valid.

defineMeasurementPruningDefinition

public abstract MeasurementPruningDefinition defineMeasurementPruningDefinition(String id,
                                                              String name,
                                                              String depositoryId,
                                                              String sensorId,
                                                              String orgId,
                                                              Integer ignore,
                                                              Integer collect,
                                                              Integer gap)
                                                                         throws UniqueIdException,
                                                                                BadSlugException,
                                                                                IdNotFoundException

Defines a new MeasurementPruningDefinition.

Parameters:

id - The id of the garbage collection definition.

name - The name of the garbage collection definition.

depositoryId - The id of the depository.

sensorId - The id of the sensor.

orgId - The organization id.

ignore - The number of days to ignore starting from now.

collect - The number of days to garbage collect in.

gap - The minimum gap between measurements in seconds.

Returns:

the defined MeasurementPruningDefinition.

Throws:

UniqueIdException - if the id derived from name is already defined.

BadSlugException - if the id isn't valid.

IdNotFoundException - If the depository, sensor or organization are not defined.

defineMeasurementType

public abstract MeasurementType defineMeasurementType(String id,
                                    String name,
                                    String units)
                                               throws UniqueIdException,
                                                      BadSlugException

Defines a new MeasurementType in WattDepot.

Parameters:

id - The unique id.

name - the name of the MeasurementType.

units - the units for the MeasurementType. Must be a javax.measure.unit.Unit toString() value.

Returns:

the defined MeasurementType.

Throws:

UniqueIdException - if the id derived from name is already defined.

BadSlugException - if the id isn't valid.

defineOrganization

public abstract Organization defineOrganization(String id,
                              String name,
                              Set<String> users)
                                         throws UniqueIdException,
                                                BadSlugException,
                                                IdNotFoundException

Parameters:

id - The unique id.

name - The unique name.

users - The members of the group.

Returns:

The defined Organization.

Throws:

UniqueIdException - If the id is already used for another Organization.

BadSlugException - if the id isn't valid.

IdNotFoundException - if the user's are not defined.

defineSensor

public abstract Sensor defineSensor(String id,
                  String name,
                  String uri,
                  String modelId,
                  Set<Property> properties,
                  String orgId)
                             throws UniqueIdException,
                                    MisMatchedOwnerException,
                                    IdNotFoundException,
                                    BadSlugException

Parameters:

id - The unique id.

name - The name of the sensor.

uri - The URI for the sensor.

modelId - The id of the SensorModel.

properties - the properties associated with this Sensor.

orgId - the id of the owner of the Sensor.

Returns:

the defined Sensor.

Throws:

UniqueIdException - if the id is already used for another Sensor.

MisMatchedOwnerException - if the given owner doesn't match the owners of the SensorModel.

IdNotFoundException - if modelId, or orgId are not actual Ids.

BadSlugException - if the id isn't valid.

defineSensorGroup

public abstract SensorGroup defineSensorGroup(String id,
                            String name,
                            Set<String> sensors,
                            String orgId)
                                       throws UniqueIdException,
                                              MisMatchedOwnerException,
                                              IdNotFoundException,
                                              BadSlugException

Parameters:

id - The unique id.

name - The unique name.

sensors - A set of the Sensors that make up the SensorGroup

orgId - the owner of the SensorGroup.

Returns:

the defined SensorGroup.

Throws:

UniqueIdException - if the id is already used for another SensorGroup.

MisMatchedOwnerException - if the given owner doesn't match the owners of the Sensors.

IdNotFoundException - if sensorIds, or orgId are not actual Ids.

BadSlugException - id the id isn't valid.

defineSensorModel

public abstract SensorModel defineSensorModel(String id,
                            String name,
                            String protocol,
                            String type,
                            String version)
                                       throws UniqueIdException,
                                              BadSlugException

Defines a new SensorModel in WattDepot.

Parameters:

id - The unique id.

name - The unique name.

protocol - The protocol used by a meter.

type - The type of the meter.

version - The version the meter is using.

Returns:

the defined SensorModel.

Throws:

UniqueIdException - if the id is already used for another SensorModel.

BadSlugException - if the id isn't valid.

defineUserInfo

public abstract UserInfo defineUserInfo(String userId,
                      String firstName,
                      String lastName,
                      String email,
                      String orgId,
                      Set<Property> properties,
                      String password)
                                 throws UniqueIdException,
                                        IdNotFoundException

Defines a new UserInfo with the given information.

Parameters:

userId - The unique userId.

firstName - The user's name.

lastName - The user's last name.

email - The user's email address.

orgId - The id of the user's organization.

properties - The additional properties of the user.

password - the password for the user.

Returns:

The defined UserInfo.

Throws:

UniqueIdException - if the id is already used for another UserInfo.

IdNotFoundException - Organization is not defined.

deleteCollectorProcessDefinition

public abstract void deleteCollectorProcessDefinition(String id,
                                    String orgId)
                                               throws IdNotFoundException,
                                                      MisMatchedOwnerException

Deletes the given CollectorProcessDefinition.

Parameters:

id - The unique id of the CollectorProcessDefinition.

orgId - the group id of the user making the request.

Throws:

IdNotFoundException - If the id is not known or defined.

MisMatchedOwnerException - if the orgId doesn't match the owner of the sensor process.

deleteDepository

public abstract void deleteDepository(String id,
                    String orgId)
                               throws IdNotFoundException,
                                      MisMatchedOwnerException

Deletes the given WattDepository.

Parameters:

id - The unique id of the WattDepository.

orgId - the group id of the user making the request.

Throws:

IdNotFoundException - If the id is not known or defined.

MisMatchedOwnerException - if the orgId doesn't match the owner of the sensor process.

deleteMeasurement

public abstract void deleteMeasurement(String depotId,
                     String orgId,
                     String measId)
                                throws IdNotFoundException

Parameters:

depotId - the id of the Depository storing the measurement.

orgId - the id of the Organization.

measId - The id of the measurement to delete.

Throws:

IdNotFoundException - if there is a problem with the ids.

deleteMeasurementPruningDefinition

public abstract void deleteMeasurementPruningDefinition(String id,
                                      String orgId)
                                                 throws IdNotFoundException

Deletes the given MeasurementPruningDefinition.

Parameters:

id - The id of the MeasurementPruningDefinition to delete.

orgId - The Organization's id.

Throws:

IdNotFoundException - if the id is not defined.

deleteMeasurementType

public abstract void deleteMeasurementType(String id)
                                    throws IdNotFoundException

Deletes the given measurement type.

Parameters:

id - The unique id for the MeasurementType to delete.

Throws:

IdNotFoundException - if the id is not a known MeasurementType.

deleteOrganization

public abstract void deleteOrganization(String id)
                                 throws IdNotFoundException

Parameters:

id - The unique id of the Organization.

Throws:

IdNotFoundException - If the id is not known or defined.

deleteSensor

public abstract void deleteSensor(String id,
                String orgId)
                           throws IdNotFoundException,
                                  MisMatchedOwnerException

Deletes the given Sensor.

Parameters:

id - The unique id of the Sensor.

orgId - the group id of the user making the request.

Throws:

IdNotFoundException - If the id is not known or defined.

MisMatchedOwnerException - if the orgId doesn't match the owner of the sensor.

deleteSensorGroup

public abstract void deleteSensorGroup(String id,
                     String orgId)
                                throws IdNotFoundException,
                                       MisMatchedOwnerException

Deletes the given SensorGroup.

Parameters:

id - The unique id of the SensorGroup.

orgId - the group id of the user making the request.

Throws:

IdNotFoundException - If the id is not known or defined.

MisMatchedOwnerException - if the orgId doesn't match the owner of the sensor group.

deleteSensorModel

public abstract void deleteSensorModel(String id)
                                throws IdNotFoundException

Deletes the given SensorModel.

Parameters:

id - The unique id of the SensorModel.

Throws:

IdNotFoundException - If the id is not known or defined.

deleteUser

public abstract void deleteUser(String id,
              String orgId)
                         throws IdNotFoundException

Parameters:

id - The unique id of the User.

orgId - the id of the organization the user is a member.

Throws:

IdNotFoundException - If the id is not known or defined.

deleteUserPassword

public abstract void deleteUserPassword(String userId,
                      String orgId)
                                 throws IdNotFoundException

Parameters:

userId - The id of the UserPassword to delete.

orgId - the user's organization id.

Throws:

IdNotFoundException - If the id is not known or defined.

getCollectorProcessDefinition

public abstract CollectorProcessDefinition getCollectorProcessDefinition(String id,
                                                       String orgId,
                                                       boolean check)
                                                                  throws IdNotFoundException

Parameters:

id - The unique id for the CollectorProcessDefinition.

orgId - the group id of the user making the request.

check - true if want to check the ids.

Returns:

The CollectorProcessDefinition with the given id.

Throws:

IdNotFoundException - if either id is not defined.

getCollectorProcessDefinitionIds

public abstract List<String> getCollectorProcessDefinitionIds(String orgId,
                                            boolean check)
                                                       throws IdNotFoundException

Parameters:

orgId - the id of the owner Organization.

check - true if want to check the ids.

Returns:

A list of the defined CollectorProcessDefinition Ids.

Throws:

IdNotFoundException - if the orgId is not defined.

getCollectorProcessDefinitions

public abstract List<CollectorProcessDefinition> getCollectorProcessDefinitions(String orgId,
                                                              boolean check)
                                                                         throws IdNotFoundException

Parameters:

orgId - the group id of the user making the request.

check - true if want to check the ids.

Returns:

The known/defined CollectorProcessDefinitiones owned by the given group id.

Throws:

IdNotFoundException - if the orgId is not defined.

getDepositories

public abstract List<Depository> getDepositories(String orgId,
                               boolean check)
                                          throws IdNotFoundException

Parameters:

orgId - the group id of the user making the request.

check - true if want to check the ids.

Returns:

The known/defined WattDepositories owned by the given group id.

Throws:

IdNotFoundException - if orgId is not defined.

getDepository

public abstract Depository getDepository(String id,
                       String orgId,
                       boolean check)
                                  throws IdNotFoundException

Parameters:

id - The unique id for the Depository to get.

orgId - the id of the owner's Organization.

check - true if want to check the ids.

Returns:

The WattDepository with the given id.

Throws:

IdNotFoundException - if either id is not defined.

getDepositoryIds

public abstract List<String> getDepositoryIds(String orgId,
                            boolean check)
                                       throws IdNotFoundException

Parameters:

orgId - the id of the owner UserGroup.

check - true if want to check the ids.

Returns:

A list of the defined WattDepository Ids.

Throws:

IdNotFoundException - if orgId is not defined.

getEarliestMeasuredValue

public abstract InterpolatedValue getEarliestMeasuredValue(String depotId,
                                         String orgId,
                                         String sensorId,
                                         boolean check)
                                                    throws NoMeasurementException,
                                                           IdNotFoundException

Parameters:

depotId - the id of the Depository.

orgId - the Organziation's id.

sensorId - The id of the Sensor making the measurements.

check - true if want to check the ids.

Returns:

The earliest measurement Value

Throws:

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

IdNotFoundException - if there is a problem with the ids.

getLatestMeasuredValue

public abstract InterpolatedValue getLatestMeasuredValue(String depotId,
                                       String orgId,
                                       String sensorId,
                                       boolean check)
                                                  throws NoMeasurementException,
                                                         IdNotFoundException

Parameters:

depotId - the id of the Depository.

orgId - the Organziation's id.

sensorId - The id of the Sensor making the measurements.

check - true if want to check the ids.

Returns:

The latest measurement Value

Throws:

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

IdNotFoundException - if there is a problem with the ids.

getLatestMeasuredValue

public abstract InterpolatedValue getLatestMeasuredValue(String depotId,
                                       String orgId,
                                       String sensorId,
                                       Long window,
                                       boolean check)
                                                  throws NoMeasurementException,
                                                         IdNotFoundException

Parameters:

depotId - the id of the Depository.

orgId - the Organziation's id.

sensorId - The id of the Sensor making the measurements.

window - The number of seconds to consider for latest.

check - true if want to check the ids.

Returns:

The latest measurement Value

Throws:

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

IdNotFoundException - if there is a problem with the ids.

getMeasurement

public abstract Measurement getMeasurement(String depotId,
                         String orgId,
                         String measId,
                         boolean check)
                                    throws IdNotFoundException

Parameters:

depotId - the id of the Depository storing the measurements.

orgId - the Organziation's id.

measId - The measurement id.

check - true if want to check the ids.

Returns:

The Measurement with the given id or null.

Throws:

IdNotFoundException - if there are problems with the ids.

getMeasurementPruningDefinition

public abstract MeasurementPruningDefinition getMeasurementPruningDefinition(String id,
                                                           String orgId,
                                                           boolean check)
                                                                      throws IdNotFoundException

Parameters:

id - The id of the MeasurementPruningDefinition.

orgId - The Organization's id.

check - true if want to check the ids.

Returns:

The defined MeasurementPruningDefinition.

Throws:

IdNotFoundException - if the id is not defined.

getMeasurementPruningDefinitionIds

public abstract List<String> getMeasurementPruningDefinitionIds(String orgId,
                                              boolean check)
                                                         throws IdNotFoundException

Parameters:

orgId - The Organization's id.

check - true if want to check the ids.

Returns:

A list of the defined MeasurementPruningDefinition ids.

Throws:

IdNotFoundException - if there is a problem with the ids.

getMeasurementPruningDefinitions

public abstract List<MeasurementPruningDefinition> getMeasurementPruningDefinitions(String orgId,
                                                                  boolean check)
                                                                             throws IdNotFoundException

Parameters:

orgId - The Organization's id.

check - true if want to check the ids.

Returns:

A list of the defined MeasurementPruningDefinitions.

Throws:

IdNotFoundException - If there is a problem with the ids.

getMeasurementType

public abstract MeasurementType getMeasurementType(String id,
                                 boolean check)
                                            throws IdNotFoundException

Parameters:

id - The unique id for the MeasurementType.

check - true if want to check the ids.

Returns:

The MeasurementType with the given id.

Throws:

IdNotFoundException - if the id is not defined.

getMeasurementTypes

public abstract List<MeasurementType> getMeasurementTypes()

Returns:

A List of the defined MeasurementTypes.

getMeasurements

public abstract List<Measurement> getMeasurements(String depotId,
                                String orgId,
                                String sensorId,
                                boolean check)
                                           throws IdNotFoundException

Parameters:

depotId - the id of the Depository storing the measurements.

orgId - the Organziation's id.

sensorId - the id of the Sensor.

check - true if want to check the ids.

Returns:

A list of all the measurements made by the Sensor.

Throws:

IdNotFoundException - if there is a problem with the ids.

getMeasurements

public abstract List<Measurement> getMeasurements(String depotId,
                                String orgId,
                                String sensorId,
                                Date start,
                                Date end,
                                boolean check)
                                           throws IdNotFoundException

Parameters:

depotId - the id of the Depository storing the measurements.

orgId - the Organziation's id.

sensorId - The id of the Sensor.

start - The start of the interval.

end - The end of the interval.

check - true if want to check the ids.

Returns:

A list of the measurements in the interval.

Throws:

IdNotFoundException - if there is a problem with the ids.

getMeasurementsCount

public abstract Long getMeasurementsCount(String orgId,
                        boolean check)
                                   throws IdNotFoundException

Parameters:

orgId - the Organziation's id.

check - true if want to check the ids.

Returns:

A count of all the measurements for the given Organization.

Throws:

IdNotFoundException - if there is a problem with the id.

getMeasurementsCount

public abstract Long getMeasurementsCount(String depotId,
                        String orgId,
                        String sensorId,
                        boolean check)
                                   throws IdNotFoundException

Parameters:

depotId - the id of the Depository storing the measurements.

orgId - the Organziation's id.

sensorId - the id of the Sensor.

check - true if want to check the ids.

Returns:

A count of all the measurements made by the Sensor.

Throws:

IdNotFoundException - if there is a problem with the ids.

getMeasurementsCount

public abstract Long getMeasurementsCount(String depotId,
                        String orgId,
                        String sensorId,
                        Date start,
                        Date end,
                        boolean check)
                                   throws IdNotFoundException

Parameters:

depotId - the id of the Depository storing the measurements.

orgId - the Organziation's id.

sensorId - The id of the Sensor.

start - The start of the interval.

end - The end of the interval.

check - true if want to check the ids.

Returns:

A count of the measurements in the interval.

Throws:

IdNotFoundException - if there is a problem with the ids.

getOrganization

public abstract Organization getOrganization(String id,
                           boolean check)
                                      throws IdNotFoundException

Parameters:

id - the unique id for the Organization.

check - true if want to check the ids.

Returns:

The UserGroup with the given id.

Throws:

IdNotFoundException - if the id isn't a defined Organization's id.

getOrganizationIds

public abstract List<String> getOrganizationIds()

Returns:

A list of the defined organization Ids.

getOrganizations

public abstract List<Organization> getOrganizations()

Returns:

The known/defined Organizations.

getRateSummary

public abstract MeasurementRateSummary getRateSummary(String depotId,
                                    String orgId,
                                    String sensorId,
                                    boolean check)
                                               throws IdNotFoundException,
                                                      NoMeasurementException

Parameters:

depotId - The depository id.

orgId - The organization id.

sensorId - The Sensor id.

check - true if want to check the ids.

Returns:

The current MeasurementRateSummary.

Throws:

IdNotFoundException - if there is a problem with the ids.

NoMeasurementException - if there aren't any measurements.

getSensor

public abstract Sensor getSensor(String id,
               String orgId,
               boolean check)
                          throws MisMatchedOwnerException,
                                 IdNotFoundException

Parameters:

id - The unique id for the Sensor.

orgId - the group id of the user making the request.

check - true if want to check the ids.

Returns:

The Sensor with the given id.

Throws:

MisMatchedOwnerException - if the owners of the pieces don't match.

IdNotFoundException - if the ids are not defined.

getSensorGroup

public abstract SensorGroup getSensorGroup(String id,
                         String orgId,
                         boolean check)
                                    throws IdNotFoundException

Parameters:

id - The unique id for the SensorGroup.

orgId - the group id of the user making the request.

check - true if want to check the ids.

Returns:

The SensorGroup with the given id.

Throws:

IdNotFoundException - if the ids are not defined.

getSensorGroupIds

public abstract List<String> getSensorGroupIds(String orgId,
                             boolean check)
                                        throws IdNotFoundException

Parameters:

orgId - the id of the owner UserGroup.

check - true if want to check the ids.

Returns:

A list of the defined SensorGroup Ids.

Throws:

IdNotFoundException - if orgId is not defined.

getSensorGroups

public abstract List<SensorGroup> getSensorGroups(String orgId,
                                boolean check)
                                           throws IdNotFoundException

Parameters:

orgId - the id of the Organization owning the SensorGroups.

check - true if want to check the ids.

Returns:

The known/defined SensorGroups owned by the given Organization id.

Throws:

IdNotFoundException - if the orgId is not defined.

getSensorIds

public abstract List<String> getSensorIds(String orgId,
                        boolean check)
                                   throws IdNotFoundException

Parameters:

orgId - the id of the owner UserGroup.

check - true if want to check the ids.

Returns:

A list of the defined Sensor Ids.

Throws:

IdNotFoundException - if orgId is not defined.

getSensorModel

public abstract SensorModel getSensorModel(String id,
                         boolean check)
                                    throws IdNotFoundException

Parameters:

id - The unique id for the SensorModel.

check - true if want to check the ids.

Returns:

The SensorModel with the given id.

Throws:

IdNotFoundException - if id isn't a defined SensorModel id.

getSensorModelIds

public abstract List<String> getSensorModelIds()

Returns:

A list of the defined SensorModel Ids.

getSensorModels

public abstract List<SensorModel> getSensorModels()

Returns:

The known/defined SensorModels owned by the given group id.

getSensors

public abstract List<Sensor> getSensors(String orgId,
                      boolean check)
                                 throws IdNotFoundException

Parameters:

orgId - the group id of the user making the request.

check - true if want to check the ids.

Returns:

The known/defined Sensors owned by the given group id.

Throws:

IdNotFoundException - if orgId is not defined.

getServerProperties

public ServerProperties getServerProperties()

Returns:

the properties

setServerProperties

public void setServerProperties(ServerProperties properties)

Parameters:

properties - the properties to set

getSessionClose

public int getSessionClose()

Returns:

the sessionClose

getSessionOpen

public int getSessionOpen()

Returns:

the sessionOpen

getSummary

public abstract SensorMeasurementSummary getSummary(String depotId,
                                  String orgId,
                                  String sensorId,
                                  Date start,
                                  Date end,
                                  boolean check)
                                             throws IdNotFoundException

Parameters:

depotId - The depository id.

orgId - The organization id.

sensorId - The Sensor id.

start - The start of the period.

end - The end of the period.

check - true if want to check the ids.

Returns:

The SensorMeasurementSummary for the given sensor, depository and period.

Throws:

IdNotFoundException - if there is a problem with the ids.

getUser

public abstract UserInfo getUser(String id,
               String orgId,
               boolean check)
                          throws IdNotFoundException

Parameters:

id - the unique id for the UserInfo.

orgId - the id of the organization the user is in.

check - true if want to check the ids.

Returns:

The UserInfo with the given id.

Throws:

IdNotFoundException - if the combination of id and orgId isn't a defined UserInfo.

getUserIds

public abstract List<String> getUserIds(String orgId,
                      boolean check)
                                 throws IdNotFoundException

Parameters:

orgId - the id of the organization the user is in.

check - true if want to check the ids.

Returns:

A list of the defined user Ids.

Throws:

IdNotFoundException - if orgId is not defined.

getUserPassword

public abstract UserPassword getUserPassword(String id,
                           String orgId,
                           boolean check)
                                      throws IdNotFoundException

Parameters:

id - The user's id.

orgId - the id of the organization the user is in.

check - true if want to check the ids.

Returns:

the UserPassword instance associated with the user.

Throws:

IdNotFoundException - if id and orgId aren't a defined UserPassword.

getUsers

public abstract List<UserInfo> getUsers()

Returns:

All the known/defined UserInfos.

getUsers

public abstract List<UserInfo> getUsers(String orgId,
                      boolean check)
                                 throws IdNotFoundException

Parameters:

orgId - the id of the organization the user is in.

check - true if want to check the ids.

Returns:

The known/defined UserInfos in the given organization.

Throws:

IdNotFoundException - if orgId is not defined.

getValue

public abstract Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date timestamp,
              boolean check)
                         throws NoMeasurementException,
                                IdNotFoundException

Parameters:

depotId - the id of the depository.

orgId - the Organziation's id.

sensorId - The id of the Sensor making the measurements.

timestamp - The time of the value.

check - true if want to check the ids.

Returns:

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

Throws:

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

IdNotFoundException - if there is a problem with the ids.

getValue

public abstract Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date start,
              Date end,
              boolean check)
                         throws NoMeasurementException,
                                IdNotFoundException

Parameters:

depotId - the id of the depository.

orgId - the Organziation's id.

sensorId - The id of the Sensor making the measurements.

start - The start of the period.

end - The end of the period.

check - true if want to check the ids.

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.

IdNotFoundException - if there is a problem with the ids.

getValue

public abstract Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date start,
              Date end,
              Long gapSeconds,
              boolean check)
                         throws NoMeasurementException,
                                MeasurementGapException,
                                IdNotFoundException

Parameters:

depotId - the id of the depository.

orgId - the Organziation's id.

sensorId - The id of 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.

check - true if want to check the ids.

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.

IdNotFoundException - if there is a problem with the ids.

getValue

public abstract Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date timestamp,
              Long gapSeconds,
              boolean check)
                         throws NoMeasurementException,
                                MeasurementGapException,
                                IdNotFoundException

Parameters:

depotId - the id of the depository.

orgId - the Organziation's id.

sensorId - The id of 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.

check - true if want to check the ids.

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.

IdNotFoundException - if there is a problem with the ids.

initializeMeasurementTypes

public void initializeMeasurementTypes()

Ensures the base set of MeasurementTypes are defined in WattDepot.

initializeSensorModels

public void initializeSensorModels()

Ensures the base set of SensorModels are defined in WattDepot.

listSensors

public abstract List<String> listSensors(String depotId,
                       String orgId,
                       boolean check)
                                  throws IdNotFoundException

Parameters:

depotId - the id of the depository.

orgId - the id of the organization.

check - if true checks the ids.

Returns:

A list of the Sensor ids contributing Measurements to the given depository.

Throws:

IdNotFoundException - if there is a problem with the ids.

putMeasurement

public abstract void putMeasurement(String depotId,
                  String orgId,
                  Measurement meas)
                             throws MeasurementTypeException,
                                    IdNotFoundException

Parameters:

depotId - the id of the Depository.

orgId - the Organization's id.

meas - The measurement to store.

Throws:

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

IdNotFoundException - if there is a problem with the ids.

putMeasurementList

public abstract void putMeasurementList(String depotId,
                      String orgId,
                      MeasurementList measurementList)
                                 throws MeasurementTypeException,
                                        IdNotFoundException

Parameters:

depotId - the id of the Depository.

orgId - the Organization's id.

measurementList - The list of measurements to store.

Throws:

MeasurementTypeException - if the type of one of the measurements doesn't match the Depository measurement type.

IdNotFoundException - if there is a problem with the ids.

stop

public abstract void stop()

Cleans up the persistence layer.

updateCollectorProcessDefinition

public abstract CollectorProcessDefinition updateCollectorProcessDefinition(CollectorProcessDefinition process)
                                                                     throws IdNotFoundException

Updates the given CollectorProcessDefinition in the persistent store.

Parameters:

process - The updated CollectorProcessDefinition.

Returns:

The updated process from persistence.

Throws:

IdNotFoundException - if there is a problem with the ids in the CollectorProcessDefinition.

updateMeasurementPruningDefinition

public abstract MeasurementPruningDefinition updateMeasurementPruningDefinition(MeasurementPruningDefinition gcd)
                                                                         throws IdNotFoundException

Updates the given MeasurementPruningDefinition in the persistent store.

Parameters:

gcd - The updated MeasurementPruningDefinition.

Returns:

The updated MeasurementPruningDefinition from persistence.

Throws:

IdNotFoundException - If there is a problem with the ids.

updateMeasurementType

public abstract MeasurementType updateMeasurementType(MeasurementType type)

Updates the given measurement type in the persistent store.

Parameters:

type - The updated MeasurementType.

Returns:

The updated MeasurementType from persistence.

updateOrganization

public abstract Organization updateOrganization(Organization org)
                                         throws IdNotFoundException

Parameters:

org - The updated Organization.

Returns:

The updated organization from persistence.

Throws:

IdNotFoundException - if the given Organization is not defined.

updateSensor

public abstract Sensor updateSensor(Sensor sensor)
                             throws IdNotFoundException

Updates the given sensor in the persistent store.

Parameters:

sensor - The updated Sensor.

Returns:

The updated sensor from persistence.

Throws:

IdNotFoundException - if there are problems with the ids.

updateSensorGroup

public abstract SensorGroup updateSensorGroup(SensorGroup group)
                                       throws IdNotFoundException

Updates the given sensor group in the persistent store.

Parameters:

group - The updated SensorGroup.

Returns:

The updated sensor group from persistence.

Throws:

IdNotFoundException - if there is a problem with the ids.

updateSensorModel

public abstract SensorModel updateSensorModel(SensorModel model)
                                       throws IdNotFoundException

Updates the given sensor model in the persistent store.

Parameters:

model - The updated SensorModel.

Returns:

The updated model from persistence.

Throws:

IdNotFoundException - if the SensorModel isn't in persistence.

updateUserInfo

public abstract UserInfo updateUserInfo(UserInfo user)
                                 throws IdNotFoundException

Parameters:

user - The updated UserInfo.

Returns:

The updated user from persistence.

Throws:

IdNotFoundException - if the user isn't in the persistence.

updateUserPassword

public abstract UserPassword updateUserPassword(UserPassword password)
                                         throws IdNotFoundException

Parameters:

password - The UserPassword to update.

Returns:

The updated password from persistence.

Throws:

IdNotFoundException - if the password is not in persistence.