net.degreedays.api.data

Class DataSet

java.lang.Object

net.degreedays.api.data.DataSet

Direct Known Subclasses:

AverageDataSet, DatedDataSet, TimeSeriesDataSet

public abstract class DataSet
extends java.lang.Object

Contains a set of degree-day data generated to fulfil a DataSpec for a specific Location.

This abstract class is not designed to be extended by third-party code, which is why it does not have an accessible constructor.

All concrete subclasses of this abstract class are immutable. You can safely reuse them and call them from multiple threads at once.

Method Summary

Modifier and Type	Method and Description
abstract DayRange	fullRange() Returns a non-null DayRange object indicating the period of time that is covered by this DataSet.
abstract double	percentageEstimated() Returns a number between 0 and 100 (both inclusive), indicating the overall extent to which this DataSet is based on estimated data.

Methods inherited from class java.lang.Object

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

Method Detail

percentageEstimated

public abstract double percentageEstimated()

Returns a number between 0 and 100 (both inclusive), indicating the overall extent to which this DataSet is based on estimated data.

Generally speaking, data with a lower percentage-estimated figure is likely to be more reliable than data with a higher percentage-estimated figure.

fullRange

public abstract DayRange fullRange()

Returns a non-null DayRange object indicating the period of time that is covered by this DataSet.