Package | Description |
---|---|
net.degreedays.api.data |
For specifying and receiving degree-day data and temperature data from the API.
|
net.degreedays.api.data.impl |
Implementations of abstract types from
net.degreedays.api.data . |
net.degreedays.api.regression |
For using the API to run regressions against your energy-usage data.
|
net.degreedays.time |
Classes for working with dates, times, and date-ranges in the context of degree days and energy data.
|
Modifier and Type | Method and Description |
---|---|
abstract DayRange |
DatedDataValue.dayRange()
Returns a non-null
DayRange object indicating the period
in time that this DatedDataValue covers. |
DayRange |
TimeSeriesDataSet.fullRange()
Returns a non-null
DayRange object indicating the period of
time that is covered by this TimeSeriesDataSet 's
values. |
DayRange |
DatedDataSet.fullRange()
Returns a non-null
DayRange object indicating the period of
time that is covered by this DatedDataSet 's
values. |
abstract DayRange |
DataSet.fullRange()
Returns a non-null
DayRange object indicating the period of
time that is covered by this DataSet . |
DayRange |
AverageDataSet.fullRange()
Returns a non-null
DayRange object indicating the period of
data from which this AverageDataSet 's figures were
calculated. |
DayRange |
DataSpecs.getFullRangeOrNull(DayRange availableDataRange)
Returns the full range of days that this set of
DataSpec
objects would cover given temperature data covering
availableDataRange , or null if
availableDataRange is not of use to any of the
DataSpec objects. |
abstract DayRange |
Breakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
Modifier and Type | Method and Description |
---|---|
static DayRangePeriod |
Period.dayRange(DayRange dayRange)
Returns a non-null
DayRangePeriod object that specifies the
period covered by dayRange . |
DayRange |
DataSpecs.getFullRangeOrNull(DayRange availableDataRange)
Returns the full range of days that this set of
DataSpec
objects would cover given temperature data covering
availableDataRange , or null if
availableDataRange is not of use to any of the
DataSpec objects. |
abstract DayRange |
Breakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
TimeSeriesDataValue[] |
TimeSeriesDataSet.getValuesWithin(DayRange dayRange)
Returns a non-null, possibly-empty, chronologically-ordered array of the
TimeSeriesDataValue objects from this
TimeSeriesDataSet that fall within the specified
DayRange . |
static DatedDataValue |
DatedDataValue.of(double value,
double percentageEstimated,
DayRange dayRange)
Returns a non-null
DatedDataValue object with the specified
value and percentage estimated, and covering the specified
DayRange . |
abstract MaybeEmptyDayRanges |
DatedBreakdown.toDayRanges(DayRange availableDataRange)
Returns the breakdown in terms of the day ranges that would constitute it
given source data covering
availableDataRange . |
Modifier and Type | Method and Description |
---|---|
DayRange |
DayRangePeriod.dayRange()
Returns the non-null
DayRange object that specifies the
day(s) that this period covers. |
DayRange |
YearlyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
WeeklyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
MonthlyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
FullYearsAverageBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
DailyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
CustomBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
DayRangePeriod.getMinimumDayRange()
Returns the non-null minimum day range that was specified using
DayRangePeriod.withMinimumDayRange(net.degreedays.time.DayRange) , or throws an
IllegalStateException if no such range was specified (check
DayRangePeriod.hasMinimumDayRange() before calling this). |
Modifier and Type | Method and Description |
---|---|
DayRange |
YearlyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
WeeklyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
MonthlyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
FullYearsAverageBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
DailyBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
DayRange |
CustomBreakdown.getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source
data covering
availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
MaybeEmptyDayRanges |
YearlyBreakdown.toDayRanges(DayRange availableDataRange)
Returns the breakdown in terms of the day ranges that would constitute it
given source data covering
availableDataRange . |
MaybeEmptyDayRanges |
WeeklyBreakdown.toDayRanges(DayRange availableDataRange)
Returns the breakdown in terms of the day ranges that would constitute it
given source data covering
availableDataRange . |
MaybeEmptyDayRanges |
MonthlyBreakdown.toDayRanges(DayRange availableDataRange)
Returns the breakdown in terms of the day ranges that would constitute it
given source data covering
availableDataRange . |
MaybeEmptyDayRanges |
DailyBreakdown.toDayRanges(DayRange availableDataRange)
Returns the breakdown in terms of the day ranges that would constitute it
given source data covering
availableDataRange . |
MaybeEmptyDayRanges |
CustomBreakdown.toDayRanges(DayRange availableDataRange)
Returns the breakdown in terms of the day ranges that would constitute it
given source data covering
availableDataRange . |
DayRangePeriod |
DayRangePeriod.withMinimumDayRange(DayRange minimumDayRange)
Returns a new
DayRangePeriod with the same
DayRangePeriod.dayRange() as this , but also specifying
minimumDayRange as the minimum range required. |
Constructor and Description |
---|
DayRangePeriod(DayRange dayRange)
Constructs a
DayRangePeriod object that specifies the period
covered by dayRange . |
Modifier and Type | Method and Description |
---|---|
DayRange |
InputPeriod.dayRange()
Returns the non-null period of time covered by this
InputPeriod . |
DayRange |
InputData.fullRange()
Returns a non-null
DayRange indicating the total period of
time covered by this InputData object (including any gaps
between its input periods). |
DayRange |
Regression.sampleSpan()
Returns a non-null
DayRange representing the full period
covered by the sample (including any gaps) that was used for this
Regression . |
Modifier and Type | Method and Description |
---|---|
Regression.Builder |
Regression.Builder.setSampleSpan(DayRange sampleSpan) |
Constructor and Description |
---|
InputPeriod(DayRange dayRange,
double usage)
Constructs an
InputPeriod covering the specified
DayRange and with the specified energy usage . |
Modifier and Type | Method and Description |
---|---|
DayRange |
Day.asRange()
Returns a non-null
DayRange covering this Day
only. |
DayRange |
Day.fullCalendarMonth()
Returns a non-null
DayRange representing the calendar month
in which this Day falls. |
DayRange |
Day.fullCalendarYear()
Returns a non-null
DayRange representing the calendar year
in which this Day falls. |
DayRange |
Day.fullMonth(StartOfMonth startOfMonth)
Returns a non-null
DayRange representing the month (starting
on the specified StartOfMonth ) in which this
Day falls. |
abstract DayRange |
DayRanges.fullRange()
Returns the non-null
DayRange extending from the first day
of the first DayRange to the last day of the last
DayRange in this chronologically-ordered set. |
DayRange |
MaybeEmptyDayRanges.fullRangeOrNull()
Returns the
DayRange extending from the first day of the
first DayRange to the last day of the last
DayRange in this chronologically-ordered set, or
null if MaybeEmptyDayRanges.isEmpty() returns true . |
DayRange |
Day.fullWeek(DayOfWeek firstDayOfWeek)
Returns a non-null
DayRange representing the week (starting
on the specified firstDayOfWeek ) in which this
Day falls. |
DayRange |
Day.fullYear(StartOfYear startOfYear)
Returns a non-null
DayRange representing the year (starting
on the specified StartOfYear ) in which this Day
falls. |
DayRange |
MaybeEmptyDayRanges.get(int index)
Returns the
DayRange at the specified position in this
chronologically-ordered set. |
DayRange |
DayRange.greedyUnion(Day dayToIncludeInUnion)
Returns the non-null
DayRange that includes all the days
within this DayRange , the specified Day
(dayToIncludeInUnion ), and any days between. |
DayRange |
DayRange.greedyUnion(DayRange rangeToIncludeInUnion)
Returns the non-null
DayRange that includes all the days
within this DayRange , the specified DayRange
(rangeToIncludeInUnion ), and any days between. |
DayRange |
DayRange.intersectionOrNull(DayRange intersectWith)
Returns a
DayRange covering the days that are contained
within both this DayRange and the specified
DayRange , or null if there is no such
intersection. |
DayRange |
Day.to(Day firstOrLastDayInRange)
Returns the non-null
DayRange covering (inclusively) the
days between this Day and firstOrLastDayInRange
(which can be before, after, or equal to this Day ). |
DayRange |
Day.to(int toYear,
int toMonthOfYearWithJanAs1,
int toDayOfMonth)
Returns the non-null
DayRange covering (inclusively) the
days between this Day and the Day represented
by the specified parameters (which can be before, after, or equal to this
Day ). |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<DayRange> |
MaybeEmptyDayRanges.iterator() |
Modifier and Type | Method and Description |
---|---|
boolean |
DayRange.contains(DayRange testRange)
Returns
true if the specified DayRange is fully
contained within this DayRange ; false
otherwise. |
DayRange |
DayRange.greedyUnion(DayRange rangeToIncludeInUnion)
Returns the non-null
DayRange that includes all the days
within this DayRange , the specified DayRange
(rangeToIncludeInUnion ), and any days between. |
int |
MaybeEmptyDayRanges.indexOf(DayRange dayRange)
Returns the index of the specified
DayRange in this
chronologically-ordered set, or -1 if it is not present. |
DayRange |
DayRange.intersectionOrNull(DayRange intersectWith)
Returns a
DayRange covering the days that are contained
within both this DayRange and the specified
DayRange , or null if there is no such
intersection. |
static DayRanges |
DayRanges.of(DayRange[] dayRangeObjects)
Returns a non-null
DayRanges object containing the specified
DayRange objects. |
static DayRanges |
DayRanges.of(DayRange firstDayRangeObject,
DayRange... additionalDayRangeObjects)
Returns a non-null
DayRanges object containing the specified
DayRange objects. |
static DayRanges |
DayRanges.of(DayRange firstDayRangeObject,
DayRange... additionalDayRangeObjects)
Returns a non-null
DayRanges object containing the specified
DayRange objects. |
MaybeEmptyDayRanges |
MaybeEmptyDayRanges.subRangesWithin(DayRange dayRange)
Returns a
MaybeEmptyDayRanges (which will be a
DayRanges if it isn't empty) containing any DayRange
objects from this set that are fully contained within the specified
DayRange . |
Modifier and Type | Method and Description |
---|---|
static DayRanges |
DayRanges.of(java.util.Collection<DayRange> dayRangeObjects)
Returns a non-null
DayRanges object containing the specified
DayRange objects. |
static DayRanges |
DayRanges.of(java.lang.Iterable<DayRange> dayRangeObjects)
Returns a non-null
DayRanges object containing the specified
DayRange objects. |
See www.degreedays.net/api/ for more about the Degree Days.net API.
You can sign up for a Degree Days.net API account and read the integration guide that is useful and applicable whether you are using Java or not.