|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.degreedays.api.data.DataSpec
net.degreedays.api.data.AverageDataSpec
public final class AverageDataSpec
Defines a specification for a set of average data such as 5-year-average degree days.
An AverageDataSpec
specifies a set of average degree days in
terms of:
To request multiple sets of average data with different calculation processes
(e.g. multiple different base temperatures) and/or different breakdowns,
simply put multiple AverageDataSpec
objects into the
DataSpecs
object that you pass into your LocationDataRequest
.
DatedDataSpec
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
Constructor Summary | |
---|---|
AverageDataSpec(Calculation calculation,
AverageBreakdown averageBreakdown)
Constructs an AverageDataSpec object with the specified
Calculation and AverageBreakdown . |
Method Summary | |
---|---|
AverageBreakdown |
breakdown()
Returns the non-null AverageBreakdown 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 |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AverageDataSpec(Calculation calculation, AverageBreakdown averageBreakdown)
AverageDataSpec
object with the specified
Calculation
and AverageBreakdown
.
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.averageBreakdown
- defines the way in which the data should be
broken down and the period that it should cover. Cannot be null.
java.lang.NullPointerException
- if calculation
or
averageBreakdown
is null.Method Detail |
---|
public Calculation calculation()
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.
public AverageBreakdown breakdown()
AverageBreakdown
that defines the way
in which the degree days should be broken down and the period in time
that they should cover.
public java.lang.String toString()
The exact details of the representation are unspecified and subject to change.
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |