Package org.wattdepot.common.domainmodel

WattDepot models the domain of measurement collection, storage, and analysis through the following conceptual entities.

See: Description

Interface Summary

Interface	Description
IDomainModel	IDomainModel defines common methods for all domain model classes.

Class Summary

Class	Description
CollectorProcessDefinition	CollectorProcessDefinition - Represents a process that queries a Sensor and produces measurements.
CollectorProcessDefinitionList	CollectorProcessDefinitionList - Encapsulates an ArrayList of CollectorProcessDefinitions so Restlet can convert it to a JSON object.
Depository	Depository - Stores measurements from Sensors of the matching measurement type.
DepositoryList	DepositoryList - Attempt at getting a list across the wire.
DescriptiveStats	DescriptiveStats - A simple calculated historical min, average, and max for a depository, sensor, timestamp and number of samples.
InterpolatedValue	InterpolatedValue - represents an interpolated value derived from measurements.
InterpolatedValueList	MeasuredValueList - a list of measured values.
InterpolatedValueValueComparator	InterpolatedValueValueComparator - Comparator of InterpolatedValues that compares the value.
IntervalValue	IntervalValue - represents an interval value derived by subtracting two InterpolatedValues.
Labels	Labels Strings used to create the HTTP URLs and requests.
Measurement	Measurement - represents a measurement from a sensor.
MeasurementList	MeasurementList - Attempt at getting a list across the wire.
MeasurementPruningDefinition	MeasurementPruningDefinition - Represents the information about a process that down samples the measurements for a particular Depository and Sensor.
MeasurementPruningDefinitionList	MeasurementPruningDefinitionList - Encapsulates an ArrayList of MeasurementPruningDefinitions so Restlet can convert it to a JSON object.
MeasurementRateSummary	MeasurementRateSummary a summary of the Measurements created by a given Sensor in a Depository.
MeasurementType	MeasurementType - Defines the type of a Measurement.
MeasurementTypeList	MeasurementTypeList - Attempt at getting a list across the wire.
Organization	Organization - A group of users used to create a namespace for WattDepot entities.
OrganizationList	OrganizationList - a list of organizations.
Property	Property - Key value pair.
Sensor	Sensor - Represents the device making measurements.
SensorGroup	SensorGroup represents a group of Sensors.
SensorGroupList	SensorGroupList - Attempt at getting a list across the wire.
SensorList	SensorList - List of Sensors.
SensorMeasurementSummary	SensorMeasurementSummary a summary of the Measurements created by a given Sensor in a depository.
SensorModel	SensorModel - Information about a Sensor.
SensorModelList	SensorModelList - List of SensorModels.
SensorStatus	SensorStatus represents the status of a given Sensor.
SensorStatusList	SensorStatusList - List of SensorStatuses.
UserInfo	User - represents a user of WattDepot.
UserInfoList	UserInfoList - A list of UserInfo instances.
UserPassword	UserPassword - UserId and encrypted password pair.
XYInterpolatedValue	Two value InterpolatedValue.
XYInterpolatedValueList	XYInterpolatedValueList - A list of XYInterpolatedValues.

Enum Summary

Enum	Description
SensorStatusEnum	Enumeration of valid Sensor Statuses.

Package org.wattdepot.common.domainmodel Description

WattDepot models the domain of measurement collection, storage, and analysis through the following conceptual entities.

Sensors

Sensors represent the device that measures the physical universe. Sensors have:

• URIs - A Internet address where collector processes can access their measurements.
• Locations - The location on the earth of the sensor (e.g. Latitude, Longitude, Altitude, Description).
• Models A description of the type of sensor, the protocol and version it is using.
• Properties - A potentially empty list of properties that describe the individual sensor.

Another use for sensors is to create a 'forecast' sensor. This sensor can make forecast measurements about the future.

Sensor Groups

Sensor groups are, simply, groups of sensors. WattDepot uses these groups for aggregation. We can group all the energy sensors in a building into a single group.

Collectors

Collectors are processes that contact a Sensor and produce measurements. Collector is a representation of how often to poll a Sensor and the Depository in which to store the measurements. Collectors should use the Collector Process Definition to control their activities.

Depositories

Depositories are responsible for storing the measurements made by the Sensors. They have an associated measurement type.

Measurements

Measurements are made by Sensors and consist of the sensor that made the measurement, the time the measurement was made, the value of the measurement and the measurement type.

Measured Values

Measured values are often interpolated from sensor measurements. There are two primary Measured Values, point values and difference values. Point values are calculated at a single point in time. If the time corresponds to a measurement then WattDepot returns the measurement's value. If the time is between two measurements WattDepot calculates the linear interpolated value and returns it. For Difference values, WattDepot gets the value for the start and end points then subtracts the start value from the end value and returns the result.