org.wattdepot.server.depository.impl.hibernate

Class WattDepotPersistenceImpl

java.lang.Object

org.wattdepot.server.WattDepotPersistence

org.wattdepot.server.depository.impl.hibernate.WattDepotPersistenceImpl

public class WattDepotPersistenceImpl
extends WattDepotPersistence

WattDepotImpl - Hibernate implementation of the WattDepot abstract class.

Author:

Cam Moore

Constructor Summary

Constructors

Constructor and Description
WattDepotPersistenceImpl(ServerProperties properties) Creates a new WattDepotImpl instance with the given ServerProperties.

Method Summary

Methods

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

Methods inherited from class org.wattdepot.server.WattDepotPersistence

getServerProperties, initializeMeasurementTypes, initializeSensorModels, setServerProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

WattDepotPersistenceImpl

public WattDepotPersistenceImpl(ServerProperties properties)

Creates a new WattDepotImpl instance with the given ServerProperties.

Parameters:

properties - The ServerProperties.

Method Detail

defineCollectorProcessDefinition

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

Description copied from class: WattDepotPersistence

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

Specified by:

defineCollectorProcessDefinition in class WattDepotPersistence

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 Depository defineDepository(String id,
                          String name,
                          MeasurementType measurementType,
                          String orgId)
                            throws UniqueIdException,
                                   IdNotFoundException,
                                   BadSlugException

Description copied from class: WattDepotPersistence

Defines a new WattDepository in WattDepot.

Specified by:

defineDepository in class WattDepotPersistence

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 MeasurementPruningDefinition defineMeasurementPruningDefinition(String id,
                                                              String name,
                                                              String depositoryId,
                                                              String sensorId,
                                                              String orgId,
                                                              Integer ignore,
                                                              Integer collect,
                                                              Integer gap)
                                                                throws UniqueIdException,
                                                                       BadSlugException,
                                                                       IdNotFoundException

Description copied from class: WattDepotPersistence

Defines a new MeasurementPruningDefinition.

Specified by:

defineMeasurementPruningDefinition in class WattDepotPersistence

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 MeasurementType defineMeasurementType(String id,
                                    String name,
                                    String units)
                                      throws UniqueIdException,
                                             BadSlugException

Description copied from class: WattDepotPersistence

Defines a new MeasurementType in WattDepot.

Specified by:

defineMeasurementType in class WattDepotPersistence

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 Organization defineOrganization(String id,
                              String name,
                              Set<String> users)
                                throws UniqueIdException,
                                       BadSlugException,
                                       IdNotFoundException

Specified by:

defineOrganization in class WattDepotPersistence

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 Sensor defineSensor(String id,
                  String name,
                  String uri,
                  String modelId,
                  Set<Property> properties,
                  String orgId)
                    throws UniqueIdException,
                           MisMatchedOwnerException,
                           IdNotFoundException,
                           BadSlugException

Specified by:

defineSensor in class WattDepotPersistence

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 SensorGroup defineSensorGroup(String id,
                            String name,
                            Set<String> sensorIds,
                            String orgId)
                              throws UniqueIdException,
                                     MisMatchedOwnerException,
                                     IdNotFoundException,
                                     BadSlugException

Specified by:

defineSensorGroup in class WattDepotPersistence

Parameters:

id - The unique id.

name - The unique name.

sensorIds - 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 SensorModel defineSensorModel(String id,
                            String name,
                            String protocol,
                            String type,
                            String version)
                              throws UniqueIdException,
                                     BadSlugException

Description copied from class: WattDepotPersistence

Defines a new SensorModel in WattDepot.

Specified by:

defineSensorModel in class WattDepotPersistence

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 UserInfo defineUserInfo(String id,
                      String firstName,
                      String lastName,
                      String email,
                      String orgId,
                      Set<Property> properties,
                      String password)
                        throws UniqueIdException,
                               IdNotFoundException

Description copied from class: WattDepotPersistence

Defines a new UserInfo with the given information.

Specified by:

defineUserInfo in class WattDepotPersistence

Parameters:

id - 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 void deleteCollectorProcessDefinition(String id,
                                    String orgId)
                                      throws IdNotFoundException,
                                             MisMatchedOwnerException

Description copied from class: WattDepotPersistence

Deletes the given CollectorProcessDefinition.

Specified by:

deleteCollectorProcessDefinition in class WattDepotPersistence

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 void deleteDepository(String id,
                    String orgId)
                      throws IdNotFoundException,
                             MisMatchedOwnerException

Description copied from class: WattDepotPersistence

Deletes the given WattDepository.

Specified by:

deleteDepository in class WattDepotPersistence

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.

deleteMeasurementPruningDefinition

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

Description copied from class: WattDepotPersistence

Deletes the given MeasurementPruningDefinition.

Specified by:

deleteMeasurementPruningDefinition in class WattDepotPersistence

Parameters:

id - The id of the MeasurementPruningDefinition to delete.

orgId - The Organization's id.

Throws:

IdNotFoundException - if the id is not defined.

deleteMeasurement

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

Specified by:

deleteMeasurement in class WattDepotPersistence

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.

deleteMeasurementType

public void deleteMeasurementType(String id)
                           throws IdNotFoundException

Description copied from class: WattDepotPersistence

Deletes the given measurement type.

Specified by:

deleteMeasurementType in class WattDepotPersistence

Parameters:

id - The unique id for the MeasurementType to delete.

Throws:

IdNotFoundException - if the id is not a known MeasurementType.

deleteOrganization

public void deleteOrganization(String id)
                        throws IdNotFoundException

Specified by:

deleteOrganization in class WattDepotPersistence

Parameters:

id - The unique id of the Organization.

Throws:

IdNotFoundException - If the id is not known or defined.

deleteSensor

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

Description copied from class: WattDepotPersistence

Deletes the given Sensor.

Specified by:

deleteSensor in class WattDepotPersistence

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 void deleteSensorGroup(String id,
                     String orgId)
                       throws IdNotFoundException,
                              MisMatchedOwnerException

Description copied from class: WattDepotPersistence

Deletes the given SensorGroup.

Specified by:

deleteSensorGroup in class WattDepotPersistence

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 void deleteSensorModel(String id)
                       throws IdNotFoundException

Description copied from class: WattDepotPersistence

Deletes the given SensorModel.

Specified by:

deleteSensorModel in class WattDepotPersistence

Parameters:

id - The unique id of the SensorModel.

Throws:

IdNotFoundException - If the id is not known or defined.

deleteUser

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

Specified by:

deleteUser in class WattDepotPersistence

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 void deleteUserPassword(String userId,
                      String orgId)
                        throws IdNotFoundException

Specified by:

deleteUserPassword in class WattDepotPersistence

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 CollectorProcessDefinition getCollectorProcessDefinition(String id,
                                                       String orgId,
                                                       boolean check)
                                                         throws IdNotFoundException

Specified by:

getCollectorProcessDefinition in class WattDepotPersistence

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 List<String> getCollectorProcessDefinitionIds(String orgId,
                                            boolean check)
                                              throws IdNotFoundException

Specified by:

getCollectorProcessDefinitionIds in class WattDepotPersistence

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 List<CollectorProcessDefinition> getCollectorProcessDefinitions(String orgId,
                                                              boolean check)
                                                                throws IdNotFoundException

Specified by:

getCollectorProcessDefinitions in class WattDepotPersistence

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 List<Depository> getDepositories(String orgId,
                               boolean check)
                                 throws IdNotFoundException

Specified by:

getDepositories in class WattDepotPersistence

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 Depository getDepository(String id,
                       String orgId,
                       boolean check)
                         throws IdNotFoundException

Specified by:

getDepository in class WattDepotPersistence

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 List<String> getDepositoryIds(String orgId,
                            boolean check)
                              throws IdNotFoundException

Specified by:

getDepositoryIds in class WattDepotPersistence

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 InterpolatedValue getEarliestMeasuredValue(String depotId,
                                         String orgId,
                                         String sensorId,
                                         boolean check)
                                           throws NoMeasurementException,
                                                  IdNotFoundException

Specified by:

getEarliestMeasuredValue in class WattDepotPersistence

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.

getMeasurementPruningDefinition

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

Specified by:

getMeasurementPruningDefinition in class WattDepotPersistence

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 List<String> getMeasurementPruningDefinitionIds(String orgId,
                                              boolean check)
                                                throws IdNotFoundException

Specified by:

getMeasurementPruningDefinitionIds in class WattDepotPersistence

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 List<MeasurementPruningDefinition> getMeasurementPruningDefinitions(String orgId,
                                                                  boolean check)
                                                                    throws IdNotFoundException

Specified by:

getMeasurementPruningDefinitions in class WattDepotPersistence

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.

getLatestMeasuredValue

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

Specified by:

getLatestMeasuredValue in class WattDepotPersistence

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 InterpolatedValue getLatestMeasuredValue(String depotId,
                                       String orgId,
                                       String sensorId,
                                       Long window,
                                       boolean check)
                                         throws NoMeasurementException,
                                                IdNotFoundException

Specified by:

getLatestMeasuredValue in class WattDepotPersistence

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 Measurement getMeasurement(String depotId,
                         String orgId,
                         String measId,
                         boolean check)
                           throws IdNotFoundException

Specified by:

getMeasurement in class WattDepotPersistence

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.

getMeasurements

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

Specified by:

getMeasurements in class WattDepotPersistence

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 List<Measurement> getMeasurements(String depotId,
                                String orgId,
                                String sensorId,
                                Date start,
                                Date end,
                                boolean check)
                                  throws IdNotFoundException

Specified by:

getMeasurements in class WattDepotPersistence

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 Long getMeasurementsCount(String orgId,
                        boolean check)
                          throws IdNotFoundException

Specified by:

getMeasurementsCount in class WattDepotPersistence

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 Long getMeasurementsCount(String depotId,
                        String orgId,
                        String sensorId,
                        boolean check)
                          throws IdNotFoundException

Specified by:

getMeasurementsCount in class WattDepotPersistence

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 Long getMeasurementsCount(String depotId,
                        String orgId,
                        String sensorId,
                        Date start,
                        Date end,
                        boolean check)
                          throws IdNotFoundException

Specified by:

getMeasurementsCount in class WattDepotPersistence

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.

getMeasurementType

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

Specified by:

getMeasurementType in class WattDepotPersistence

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 List<MeasurementType> getMeasurementTypes()

Specified by:

getMeasurementTypes in class WattDepotPersistence

Returns:

A List of the defined MeasurementTypes.

getOrganization

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

Specified by:

getOrganization in class WattDepotPersistence

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 List<String> getOrganizationIds()

Specified by:

getOrganizationIds in class WattDepotPersistence

Returns:

A list of the defined organization Ids.

getOrganizations

public List<Organization> getOrganizations()

Specified by:

getOrganizations in class WattDepotPersistence

Returns:

The known/defined Organizations.

getRateSummary

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

Specified by:

getRateSummary in class WattDepotPersistence

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 Sensor getSensor(String id,
               String orgId,
               boolean check)
                 throws IdNotFoundException

Specified by:

getSensor in class WattDepotPersistence

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:

IdNotFoundException - if the ids are not defined.

getSensorGroup

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

Specified by:

getSensorGroup in class WattDepotPersistence

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 List<String> getSensorGroupIds(String orgId,
                             boolean check)
                               throws IdNotFoundException

Specified by:

getSensorGroupIds in class WattDepotPersistence

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 List<SensorGroup> getSensorGroups(String orgId,
                                boolean check)
                                  throws IdNotFoundException

Specified by:

getSensorGroups in class WattDepotPersistence

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 List<String> getSensorIds(String orgId,
                        boolean check)
                          throws IdNotFoundException

Specified by:

getSensorIds in class WattDepotPersistence

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 SensorModel getSensorModel(String id,
                         boolean check)
                           throws IdNotFoundException

Specified by:

getSensorModel in class WattDepotPersistence

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 List<String> getSensorModelIds()

Specified by:

getSensorModelIds in class WattDepotPersistence

Returns:

A list of the defined SensorModel Ids.

getSensorModels

public List<SensorModel> getSensorModels()

Specified by:

getSensorModels in class WattDepotPersistence

Returns:

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

getSensors

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

Specified by:

getSensors in class WattDepotPersistence

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.

getSessionClose

public int getSessionClose()

Overrides:

getSessionClose in class WattDepotPersistence

Returns:

the sessionClose

getSessionOpen

public int getSessionOpen()

Overrides:

getSessionOpen in class WattDepotPersistence

Returns:

the sessionOpen

getSummary

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

Specified by:

getSummary in class WattDepotPersistence

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 UserInfo getUser(String id,
               String orgId,
               boolean check)
                 throws IdNotFoundException

Specified by:

getUser in class WattDepotPersistence

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 List<String> getUserIds(String orgId,
                      boolean check)
                        throws IdNotFoundException

Specified by:

getUserIds in class WattDepotPersistence

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 UserPassword getUserPassword(String id,
                           String orgId,
                           boolean check)
                             throws IdNotFoundException

Specified by:

getUserPassword in class WattDepotPersistence

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 List<UserInfo> getUsers()

Specified by:

getUsers in class WattDepotPersistence

Returns:

All the known/defined UserInfos.

getUsers

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

Specified by:

getUsers in class WattDepotPersistence

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 Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date timestamp,
              boolean check)
                throws NoMeasurementException,
                       IdNotFoundException

Specified by:

getValue in class WattDepotPersistence

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 Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date start,
              Date end,
              boolean check)
                throws NoMeasurementException,
                       IdNotFoundException

Specified by:

getValue in class WattDepotPersistence

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 Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date start,
              Date end,
              Long gapSeconds,
              boolean check)
                throws NoMeasurementException,
                       MeasurementGapException,
                       IdNotFoundException

Specified by:

getValue in class WattDepotPersistence

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 Double getValue(String depotId,
              String orgId,
              String sensorId,
              Date timestamp,
              Long gapSeconds,
              boolean check)
                throws NoMeasurementException,
                       MeasurementGapException,
                       IdNotFoundException

Specified by:

getValue in class WattDepotPersistence

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.

listSensors

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

Specified by:

listSensors in class WattDepotPersistence

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 void putMeasurement(String depotId,
                  String orgId,
                  Measurement meas)
                    throws MeasurementTypeException,
                           IdNotFoundException

Specified by:

putMeasurement in class WattDepotPersistence

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 void putMeasurementList(String depotId,
                      String orgId,
                      MeasurementList measurementList)
                        throws MeasurementTypeException,
                               IdNotFoundException

Specified by:

putMeasurementList in class WattDepotPersistence

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 void stop()

Description copied from class: WattDepotPersistence

Cleans up the persistence layer.

Specified by:

stop in class WattDepotPersistence

updateCollectorProcessDefinition

public CollectorProcessDefinition updateCollectorProcessDefinition(CollectorProcessDefinition process)
                                                            throws IdNotFoundException

Description copied from class: WattDepotPersistence

Updates the given CollectorProcessDefinition in the persistent store.

Specified by:

updateCollectorProcessDefinition in class WattDepotPersistence

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 MeasurementPruningDefinition updateMeasurementPruningDefinition(MeasurementPruningDefinition gcd)
                                                                throws IdNotFoundException

Description copied from class: WattDepotPersistence

Updates the given MeasurementPruningDefinition in the persistent store.

Specified by:

updateMeasurementPruningDefinition in class WattDepotPersistence

Parameters:

gcd - The updated MeasurementPruningDefinition.

Returns:

The updated MeasurementPruningDefinition from persistence.

Throws:

IdNotFoundException - If there is a problem with the ids.

updateMeasurementType

public MeasurementType updateMeasurementType(MeasurementType type)

Description copied from class: WattDepotPersistence

Updates the given measurement type in the persistent store.

Specified by:

updateMeasurementType in class WattDepotPersistence

Parameters:

type - The updated MeasurementType.

Returns:

The updated MeasurementType from persistence.

updateOrganization

public Organization updateOrganization(Organization org)
                                throws IdNotFoundException

Specified by:

updateOrganization in class WattDepotPersistence

Parameters:

org - The updated Organization.

Returns:

The updated organization from persistence.

Throws:

IdNotFoundException - if the given Organization is not defined.

updateSensor

public Sensor updateSensor(Sensor sensor)
                    throws IdNotFoundException

Description copied from class: WattDepotPersistence

Updates the given sensor in the persistent store.

Specified by:

updateSensor in class WattDepotPersistence

Parameters:

sensor - The updated Sensor.

Returns:

The updated sensor from persistence.

Throws:

IdNotFoundException - if there are problems with the ids.

updateSensorGroup

public SensorGroup updateSensorGroup(SensorGroup group)
                              throws IdNotFoundException

Description copied from class: WattDepotPersistence

Updates the given sensor group in the persistent store.

Specified by:

updateSensorGroup in class WattDepotPersistence

Parameters:

group - The updated SensorGroup.

Returns:

The updated sensor group from persistence.

Throws:

IdNotFoundException - if there is a problem with the ids.

updateSensorModel

public SensorModel updateSensorModel(SensorModel model)
                              throws IdNotFoundException

Description copied from class: WattDepotPersistence

Updates the given sensor model in the persistent store.

Specified by:

updateSensorModel in class WattDepotPersistence

Parameters:

model - The updated SensorModel.

Returns:

The updated model from persistence.

Throws:

IdNotFoundException - if the SensorModel isn't in persistence.

updateUserInfo

public UserInfo updateUserInfo(UserInfo user)
                        throws IdNotFoundException

Specified by:

updateUserInfo in class WattDepotPersistence

Parameters:

user - The updated UserInfo.

Returns:

The updated user from persistence.

Throws:

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

updateUserPassword

public UserPassword updateUserPassword(UserPassword password)
                                throws IdNotFoundException

Specified by:

updateUserPassword in class WattDepotPersistence

Parameters:

password - The UserPassword to update.

Returns:

The updated password from persistence.

Throws:

IdNotFoundException - if the password is not in persistence.