net.degreedays.api.data

Class DatedDataSpec

java.lang.Object

net.degreedays.api.data.DataSpec

net.degreedays.api.data.DatedDataSpec

All Implemented Interfaces:

java.io.Serializable

public final class DatedDataSpec
extends DataSpec
implements java.io.Serializable

Defines a specification for a set of dated data such as daily, weekly, or monthly degree days covering a specific period in time.

A DatedDataSpec specifies a set of degree days in terms of:

• its calculation process (heating or cooling, and the base temperature); and
• its breakdown (e.g. daily, weekly, or monthly, and the period covered).

Example DatedDataSpec code:

Here's how you could specify monthly heating degree days with a base temperature of 15.5°C covering the whole of 2019:

 DatedDataSpec datedDataSpec = DataSpec.dated(
     Calculation.heatingDegreeDays(Temperature.celsius(15.5)),
     DatedBreakdown.monthly(Period.dayRange(
         Day.of(2019, 1, 1).to(2019, 12, 31))));
 

You could then send that DatedDataSpec to the API as part of a LocationDataRequest, and get a response containing an DatedDataSet back:

 DegreeDaysApi api = new DegreeDaysApi(new AccountKey(yourStringAccountKey),
     new SecurityKey(yourStringSecurityKey));
 LocationDataRequest request = new LocationDataRequest(
     Location.stationId("KHYA"),
     new DataSpecs(datedDataSpec));
 LocationDataResponse response = api.dataApi().getLocationData(request);
 DatedDataSet datedData = response.dataSets().getDated(datedDataSpec);
 for (DatedDataValue v : datedData.getValues()) {
     System.out.println(v.dayRange() + ": " + v.value());
 }
 

To request multiple sets of dated data with different calculation processes (e.g. multiple different base temperatures) and/or different breakdowns, simply put multiple DatedDataSpec objects into the DataSpecs object that you pass into your LocationDataRequest.

See Also:

AverageDataSpec, TimeSeriesDataSpec

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.

Constructor Summary

Constructors

Constructor and Description
DatedDataSpec(Calculation calculation, DatedBreakdown datedBreakdown) Constructs a DatedDataSpec object with the specified Calculation and DatedBreakdown.

Method Summary

Modifier and Type	Method and Description
DatedBreakdown	breakdown() Returns the non-null DatedBreakdown object that defines the way in which the degree days should be broken down and the period in time that they should cover.
Calculation	calculation() Returns the non-null Calculation object that defines the way in which the degree days should be calculated in terms of their base temperature and whether they should be heating degree days or cooling degree days.
java.lang.String	toString() Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

Methods inherited from class net.degreedays.api.data.DataSpec

average, dated, equals, hashCode, timeSeries

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DatedDataSpec

public DatedDataSpec(Calculation calculation,
                     DatedBreakdown datedBreakdown)

Constructs a DatedDataSpec object with the specified Calculation and DatedBreakdown.

Parameters:

calculation - defines the way in which the degree days should be calculated in terms of their base temperature and whether they should be heating degree days or cooling degree days. Cannot be null.

datedBreakdown - defines the way in which the data should be broken down and the period that it should cover. Cannot be null.

Throws:

java.lang.NullPointerException - if calculation or datedBreakdown is null.

Method Detail

calculation

public Calculation calculation()

Returns the non-null Calculation object that defines the way in which the degree days should be calculated in terms of their base temperature and whether they should be heating degree days or cooling degree days.

breakdown

public DatedBreakdown breakdown()

Returns the non-null DatedBreakdown object that defines the way in which the degree days should be broken down and the period in time that they should cover.

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object