org.wattdepot.extension.openeis.server

Class OpenEISServer

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.UniformResource

org.restlet.resource.ServerResource

org.wattdepot.server.http.api.WattDepotServerResource

org.wattdepot.extension.openeis.server.OpenEISServer

Direct Known Subclasses:

EnergySignatureServer, HeatMapServer, LoadAnalysisServerResource, LoadDurationCurveServer, LongitudinalBenchmarkingServer, TimeSeriesLoadProfileServer

public class OpenEISServer
extends WattDepotServerResource

OpenEISServer - Base class that provides functionality for getting Hourly average values for point data and Hourly difference values.

Author:

Cam Moore

Field Summary

Fields inherited from class org.wattdepot.server.http.api.WattDepotServerResource

depot, orgId

Constructor Summary

Constructors

Constructor and Description
OpenEISServer()

Method Summary

Methods

Modifier and Type	Method and Description
InterpolatedValueList	getDifferenceValues(String depositoryId, String sensorId, Date start, TimeInterval howLong, int numIntervals, boolean keepNulls) Returns an InterpolatedValueList of the values starting at start with an interval of howLong.
InterpolatedValueList	getHourlyDifferenceData(String depositoryId, String sensorId, Date start, Date end, boolean keepNulls) Returns the hourly difference data as an InterpolatedValueList.
InterpolatedValueList	getHourlyDifferenceData(String depositoryId, String sensorId, TimeInterval howLong, boolean keepNulls) Returns the hourly difference data for the given depositoryId, sensorId, and for the time interval.
InterpolatedValueList	getHourlyPointData(String depositoryId, String sensorId, Date start, Date end, boolean keepNulls) Returns the hourly average data as an InterpolatedValueList.
InterpolatedValueList	getHourlyPointData(String depositoryId, String sensorId, TimeInterval howLong, boolean keepNulls) Returns the hourly point data for the given depositoryId, sensorId, and for the time interval.
InterpolatedValueList	getHourlyPointDataYear(String depositoryId, String sensorId, boolean keepNulls) Returns the average point data for the last year.

Methods inherited from class org.wattdepot.server.http.api.WattDepotServerResource

doInit

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, options, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toObject, toRepresentation, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenEISServer

public OpenEISServer()

Method Detail

getHourlyPointData

public InterpolatedValueList getHourlyPointData(String depositoryId,
                                       String sensorId,
                                       TimeInterval howLong,
                                       boolean keepNulls)

Returns the hourly point data for the given depositoryId, sensorId, and for the time interval.

Parameters:

depositoryId - The Depository.

sensorId - The Sensor collecting the data.

howLong - The length of time.

keepNulls - if true returns InterpolatedValues with a value of null for missing data.

Returns:

An InterpolatedValueList of the hourly data.

getHourlyPointDataYear

public InterpolatedValueList getHourlyPointDataYear(String depositoryId,
                                           String sensorId,
                                           boolean keepNulls)

Returns the average point data for the last year.

Parameters:

depositoryId - The Depository.

sensorId - The Sensor

keepNulls - if true returns InterpolatedValues with a value of null for missing data.

Returns:

An InterpolatedValueList of the hourly data.

getHourlyDifferenceData

public InterpolatedValueList getHourlyDifferenceData(String depositoryId,
                                            String sensorId,
                                            TimeInterval howLong,
                                            boolean keepNulls)

Returns the hourly difference data for the given depositoryId, sensorId, and for the time interval.

Parameters:

depositoryId - The Depository.

sensorId - The Sensor collecting the data.

howLong - The length of time.

keepNulls - if true returns InterpolatedValues with a value of null for missing data.

Returns:

An InterpolatedValueList of the hourly data.

getDifferenceValues

public InterpolatedValueList getDifferenceValues(String depositoryId,
                                        String sensorId,
                                        Date start,
                                        TimeInterval howLong,
                                        int numIntervals,
                                        boolean keepNulls)

Returns an InterpolatedValueList of the values starting at start with an interval of howLong.

Parameters:

depositoryId - The Depository.

sensorId - The Sensor.

start - The start date.

howLong - The period to calculate the difference.

numIntervals - How many values to calculate.

keepNulls - if true returns InterpolatedValues with a value of null for missing data.

Returns:

an InterpolatedValueList of the values.

getHourlyDifferenceData

public InterpolatedValueList getHourlyDifferenceData(String depositoryId,
                                            String sensorId,
                                            Date start,
                                            Date end,
                                            boolean keepNulls)

Returns the hourly difference data as an InterpolatedValueList.

Parameters:

depositoryId - The Depository.

sensorId - The Sensor.

start - The start of the period.

end - The end of the period.

keepNulls - if true inserts InterpolatedValues with a value of null in the return list.

Returns:

An InterpolatedValueList of the hourly differences.

getHourlyPointData

public InterpolatedValueList getHourlyPointData(String depositoryId,
                                       String sensorId,
                                       Date start,
                                       Date end,
                                       boolean keepNulls)

Returns the hourly average data as an InterpolatedValueList.

Parameters:

depositoryId - The Depository.

sensorId - The Sensor.

start - The start of the period.

end - The end of the period.

keepNulls - if true insert InterpolatedValues with a null value.

Returns:

An InterpolatedValueList of the hourly averages.