AccountKey object using the specified string
account key or throws an IllegalArgumentException if the
string is clearly invalid.DataSpec to be associated with
it.InputData sent to the API, to help the API test and rank the
regressions that include data for that extra predictor.DatedDataValue object.Regression.true if this Day object is
chronologically after comparisonDay; false
otherwise.true if this DayTime is chronologically
after comparisonDayTime; false otherwise.true if the instant in time represented by this
OffsetDayTime is after the instant in time represented by
comparisonOffsetDayTime; false otherwise.true if this Time is chronologically
after comparisonTime (assuming both are times within the
same day); false otherwise.true if the latest day range can be partially filled
(i.e. incomplete); false otherwise (the default case).DayRange covering this Day
only.AverageDataSpec object with the
specified Calculation and AverageBreakdown.AverageDataSpec for a specific Location.AverageDataSet objects
e.g. for testing purposes.AverageDataSpec object with the specified
Calculation and AverageBreakdown.BaseloadRegressionComponent object
representing the baseload component (b*days) of this
Regression.E = b*days) which can be built upon as
per the example code.BaseloadRegressionComponent objects e.g. for testing
purposes.true if this Day object is
chronologically before comparisonDay; false
otherwise.true if this DayTime is chronologically
before comparisonDayTime; false otherwise.true if the instant in time represented by this
OffsetDayTime is before the instant in time represented by
comparisonOffsetDayTime; false otherwise.true if this Time is chronologically
before comparisonTime (assuming both are times within the
same day); false otherwise.AverageBreakdown that defines the way
in which the degree days should be broken down and the period in time
that they should cover.DatedBreakdown object that defines the
way in which the degree days should be broken down and the period in time
that they should cover.DatedBreakdown object that defines the
period of time that the time-series data should cover (read more on how this
works).DataSets object created according to the
specification held by this builder.DataSpecs object with the configuration
currently held by this Builder.RegressionTestPlan with the configuration
currently held by this Builder.ResponseParser, and that's not an interface that you are
likely to need to deal with unless you are replacing parts of the
framework.RegressionTestPlan.Builder with the
specified TemperatureUnit (to be used for degree days)
and default values for everything else.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.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.TimeSeriesCalculation object that
defines how the time-series data should be calculated.Temperature object with the specified
Celsius temperature rounded to the nearest 0.1 C.SortedSet of
Temperature objects, with Celsius values running from
firstValue to lastValue (inclusive), and the
specified step between each consecutive temperature.b, h, or c (depending on the
component in question) in a regression with an equation like
E = b*days + h*HDD + c*CDDRegressionComponent.coefficient().RegressionComponent.coefficient().Temperature objects for low-to-high ordering.Day objects for chronological ordering.DayTime objects for chronological ordering.OffsetDayTime objects for chronological
ordering, considering first the instants in time that they represent, and
only considering their local clock times if those instants are identical.StartOfMonth with the specified comparison
StartOfMonth for chronological order.StartOfYear with the specified comparison
StartOfYear for chronological order.Time objects for chronological ordering
(assuming both are times within the same day).true if the specified Day is
contained within this DayRange; false
otherwise.true if the specified DayRange is fully
contained within this DayRange; false
otherwise.CoolingDegreeDaysCalculation object with
the specified base temperature.Calculation that specifies that cooling degree days should
be calculated and that holds the base temperature that they should be
calculated to.CoolingDegreeDaysCalculation object with the
specified base temperature.DataSpec objects held by this
DataSpecs - always greater than zero.DayRange objects in this set.Regression.CustomBreakdown object that specifies
degree days broken down to match the DayRanges passed in.DatedBreakdown used to specify that degree days should
be broken down into the custom date ranges specified e.g. to match
the dates of your energy-usage records.CustomBreakdown object that specifies degree
days broken down to match the DayRanges passed in.DataSpecs.CustomKeyBuilder.Regression.DailyBreakdown object that specifies
daily degree days covering the specified period in time.DatedBreakdown used to specify that degree days should
be broken down on a daily basis and cover a specific Period in time.DailyBreakdown object that specifies daily
degree days covering the specified period in time.DataApi object that uses the specified
RequestProcessor internally.DataApi object, providing easy, type-safe
access to the API's data-related operations.DataSets object containing the sets of
data generated to fulfil the DataSpecs from the
LocationDataRequest that led to this response.DataSets objects
e.g. for testing purposes.LocationDataRequest.DataSpecs object containing the specified
DataSpec objects.DataSpecs object containing the specified
DataSpec objects.DataSpecs object containing the specified
DataSpec objects.DataSpecs object containing the specified
DataSpec objects.DataSpecs object containing the specified
DataSpec object.DataSpecs object that specifies how the
set(s) of data should be calculated and broken down.DataSpecs object that specifies the
data that is desired from the specified location.DataSpecs
object with custom keys.DatedDataSpec object with the specified
Calculation and DatedBreakdown.DatedDataSpec for a specific Location.DatedDataSet objects
e.g. for testing purposes.DatedDataSpec object with the specified
Calculation and DatedBreakdown.Day object indicating the YYYY-MM-DD date
that this TimeSeriesDataValue falls on in the local
time-zone of the weather station.Day object representing a date with the
specified year, month, and day.Day object representing the YYYY-MM-DD
component of this DayTime.Day object representing the YYYY-MM-DD
component of this OffsetDayTime.Day at the specified zero-based index
within this DayRange.DayRange (always
1 or more).DayNormalization to be used in the regression
process.TimeSeriesDataValue falls on in
the local time-zone of the weather station.Day.DayTime.OffsetDayTime.StartOfYear.monthOfYear() (inclusive) indicating which day in
monthOfYear() is the first day of the "year" defined by this
StartOfYear.DayOfWeek object indicating the day of
the week that this TimeSeriesDataValue falls on in the local
time-zone of the weather station.DayOfWeek object indicating the
day of the week of this Day.DayOfWeek object indicating the
day of the week of this DayTime.DayOfWeek object indicating the
day of the week of this OffsetDayTime.TimeSeriesDataValue
falls on in the local time-zone of the weather station.Day.DayTime.OffsetDayTime.DayRange object indicating the period
in time that this DatedDataValue covers.DayRange object that specifies the
day(s) that this period covers.DayRangePeriod object that specifies the
period covered by dayRange.InputPeriod.DayRange object that starts on the specified
first day and ends on the specified last day.Period that is defined explicitly in terms of the range of
days that it covers.DayRangePeriod object that specifies the period
covered by dayRange.DayRanges that specifies the dates that
each degree-day figure should cover.DayRange
objects.Day is after
comparisonDay, which will be negative if this
Day comes first chronologically.Day is before
comparisonDay, which will be negative if
comparisonDay comes first chronologically.DayTime object indicating the
YYYY-MM-DDThh:mm date-time of this TimeSeriesDataValue in
the local time-zone of the weather station.DayTime object with the specified
Day and Time.DayTime object with the specified year, month,
day, hour, and minute.DayTime object representing the
YYYY-MM-DDThh:mm component of this OffsetDayTime.DegreeDaysApi object that internally uses a
default RequestProcessor configured with the specified access
keys.DegreeDaysApi object that internally uses the
specified RequestProcessor.DegreeDaysRegressionComponent objects e.g. for testing
purposes.Distance object with the specified value
and unit of measurement.Source.station() from the target
location that was specified in the original request for data.Distance object that represents the shortest
distance along the surface of the Earth from this to the
specified longLat.LongLat object that represents a position the
specified distance East of this.AccountKey object can only be equal to an
AccountKey object with an identical canonical string account
key.true if o is an
AverageDataSet containing equal values and calculated from
data covering an equal period in time.Breakdown objects are equal if they have the same class
and the same configuration.Calculation objects are equal if they have the same
class and the same configuration.DataSets object is equal to another DataSets
object with an equal DataSet for each DataSpec that
it was created with.DataSpec objects are equal if they have the same class
and the same configuration.DataSpecs objects are equal if they contain the same set
of unique DataSpec objects - neither keys nor the order of keys make any difference.true if o is a DataValue
object of the same type as this with an equal
DataValue.value() and DataValue.percentageEstimated().true if o is a
DatedDataSet containing equal values covering equal dates,
and with an equal DatedDataSet.percentageEstimated().true if o is a
DatedDataValue object with an equal
value(),
percentageEstimated(), and
DatedDataValue.dayRange(); false otherwise.Location objects are equal if it can be ascertained that
they both represent the exact same weather station(s) or geographic
location, and that two requests for data, one with each
Location and identical in every other respect, would return
identical data.LocationDataRequest objects are equal if it can be
ascertained that they are specifying the same set(s) of data from the
same location.true if o is a
LocationDataResponse with equal values for everything
apart from the metadata() (which is not
considered in the equality test).LocationInfoRequest objects are equal if it can be
ascertained that they are specifying the same set(s) of data from the
same location.true if o is a
LocationInfoResponse with equal values for everything
apart from the metadata() (which is not
considered in the equality test).Period objects are equal if it can be ascertained that
they will always represent the same period in time as each other when
compared at the same time and in the same context.o is a Source object with
equal fields to this.true if o is a Station
object with equal fields to this.Temperature objects can only be equal if they have the
same units and temperature value (value comparisons being made
after any rounding).TimeSeriesCalculation objects are equal if they have the
same class and the same configuration.true if o is a
TimeSeriesDataSet containing equal values and with an equal
TimeSeriesDataSet.percentageEstimated().true if o is a
TimeSeriesDataValue object with an equal
value(),
percentageEstimated(), and
TimeSeriesDataValue.offsetDayTime(); false otherwise.true if o is a
FailureResponse with an equal FailureResponse.failure()
(the metadata() is not considered in the equality
test).true if o is an
HttpRequest object with an equal URL and equal parameters,
irrespective of the order of the parameter names returned by
HttpRequest.getParamNames().true if o is a
RequestSecurityInfo object with equal properties.true if o is a RateLimit
object with equal properties.true if o is an
ExtraPredictorSpec with the same ExtraPredictorSpec.predictorType()
and ExtraPredictorSpec.expectedCorrelation() as this.true if o is an InputData
object containing equal InputPeriod objects (same dates, same
usage values, and same extra-predictor keys and figures).true if o is an
InputPeriod with the same InputPeriod.dayRange and
InputPeriod.usage as this, and with the same extra-predictor
keys and values (the order of the keys
is not important for this).true if o is a Regression
object with identical values for everything apart from the
Regression.tags() (which are not considered in the equality test).RegressionComponent instances are equal if they have the
same class and the same configuration.true if o is a
RegressionRequest object with the same configuration as
this.true if o is a
RegressionResponse with equal values apart from the
metadata() (which is not considered in the equality
test).true if o is a
RegressionSpec with the same configuration as
this.true if o is an
RegressionTestPlan with the same configuration as
this.SecurityKey object can only be equal to a
SecurityKey object based around the same canonical security
key.true if o is a Distance
object with an equal unit and an equal value.true if o is a LongLat
object with the same LongLat.longitude() and LongLat.latitude() values
as this.true if o is a Day
representing the same date as this Day; false
otherwise.true if o is a DayRange
covering exactly the same days as this DayRange;
false otherwise.true if o is a DayTime
representing the same date-time as this DayTime;
false otherwise.true if o is a
MaybeEmptyDayRanges (or DayRanges) object
representing the same set of DayRange objects as
this; false otherwise.true if o is an
OffsetDayTime representing the same date-time and UTC offset
as this OffsetDayTime; false otherwise.true if o is a StartOfMonth
object representing the same day in the month as this;
false otherwise.true if o is a StartOfYear
object representing the same day of the year as this;
false otherwise.ExpectedCorrelation that defines how
the extra predictor is expected to correlate with energy usage.InputData (and each InputPeriod
within it) has extra-predictor figures for.InputPeriod has extra-predictor figures for.Regression has extra components for.RegressionTestPlan has ExtraPredictorSpec
objects for.PredictorType and
ExpectedCorrelation, to help the API test and rank regressions that
include data for that extra predictor.ExtraPredictorSpec with the specified
PredictorType and ExpectedCorrelation.ExtraRegressionComponent
objects e.g. for testing purposes.Temperature object with the specified
Fahrenheit temperature rounded to the nearest 0.1 F.SortedSet of
Temperature objects, with Fahrenheit values running from
firstValue to lastValue (inclusive), and the
specified step between each consecutive temperature.Failure object containing details of
the failure on the API's servers that led to this exception on the
client.Failure object that contains details
of the failure in the API's server-side processing of the request.Failure objects
e.g. for testing purposes.Failure in the API's
processing of all or part of a request.FailureResponse objects
e.g. for testing purposes.Distance object with the specified
value and DistanceUnit.FEET as the unit of
measurement.Day in this
DayRange.Day of the period covered by this
DatedDataValue.Day object represented by the
YEAR, MONTH, and DAY_OF_MONTH
fields of calendar.DayTime object represented by the
YEAR, MONTH, DAY_OF_MONTH,
HOUR_OF_DAY, and MINUTE fields of
calendar.Time object represented by the
HOUR_OF_DAY and MINUTE fields of
calendar.Day object represented by
date, as interpreted in the context of the UTC time-zone.DayOfWeek represented by
isoIndex, which can be 1 for Monday,
2 for Tuesday, 3 for Wednesday, 4
for Thursday, 5 for Friday, 6 for Saturday, or
7 for Sunday.TemperatureUnit with the specified
string (returned by its TemperatureUnit.toString() method).TimeSeriesInterval with the specified
string (returned by its TimeSeriesInterval.toString() method).DayNormalization with the specified
string (returned by its DayNormalization.toString() method).ExpectedCorrelation with the specified
string (returned by its ExpectedCorrelation.toString() method).PredictorType with the specified
string (returned by its PredictorType.toString() method).RegressionTag with the specified
string (returned by its RegressionTag.toString() method).YYYY-MM-DD format (the format
used by XML schema's date type), or YYYYMMDD format.DayOfWeek with the specified
string (returned by its DayOfWeek.toString() method).YYYY-MM-DDThh:mm format
(the format used by XML schema's dateTime type),
YYYYMMDDThhmm format, or YYYYMMDDhhmm
all-numeric format.2020-04-10T12:35Z (
Z indicating the UTC time-zone i.e. no offset), or
2019-01-31T18:22-08:00 (8 hours behind UTC).StartOfMonth in
---DD format, the format used by XML Schema's
gDay type (based on ISO 8601).StartOfYear in
--MM-DD format, the format used by XML Schema's
gMonthDay type (based on ISO 8601).hh:mm format (the format used
by XML schema's time type) or hhmm format.DayRange representing the calendar month
in which this Day falls.DayRange objects
representing the full calendar months that are fully contained within
this DayRange.DayRange representing the calendar year
in which this Day falls.DayRange objects
representing the full calendar years that are fully contained within this
DayRange.DayRange representing the month (starting
on the specified StartOfMonth) in which this
Day falls.DayRange objects
representing the full months (starting on the specified
StartOfMonth) that are fully contained within this
DayRange.DayRange objects representing the
full-or-partial calendar months that are contained within this
DayRange.DayRange objects representing the
full-or-partial calendar years that are contained within this
DayRange.DayRange objects representing the
full-or-partial months (starting on the specified
StartOfMonth) that are contained within this
DayRange.DayRange objects representing the
full-or-partial weeks (starting on the specified
firstDayOfWeek) that are contained within this
DayRange.DayRange objects representing the
full-or-partial years (starting on the specified StartOfYear)
that are contained within this DayRange.DayRange object indicating the period of
data from which this AverageDataSet's figures were
calculated.DayRange object indicating the period of
time that is covered by this DataSet.DayRange object indicating the period of
time that is covered by this DatedDataSet's
values.DayRange object indicating the period of
time that is covered by this TimeSeriesDataSet's
values.DayRange indicating the total period of
time covered by this InputData object (including any gaps
between its input periods).DayRange extending from the first day
of the first DayRange to the last day of the last
DayRange in this chronologically-ordered set.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 representing the week (starting
on the specified firstDayOfWeek) in which this
Day falls.DayRange objects
representing the full weeks (starting on the specified
firstDayOfWeek) that are fully contained within this
DayRange.DayRange representing the year (starting
on the specified StartOfYear) in which this Day
falls.FullYearsAverageBreakdown object that
specifies average degree days derived from data covering full calendar
years determined by the specified period.AverageBreakdown used to specify that average-degree-day
figures should be derived from data covering a specified number of full
calendar years.FullYearsAverageBreakdown object that specifies
average degree days derived from data covering full calendar years
determined by the specified period.DayRange objects
representing the full years (starting on the specified
StartOfYear) that are fully contained within this
DayRange.DataSet that was generated to fulfil the
specified DataSpec from the request, or throws a
SourceDataException if no such DataSet could be
generated.DataSpec that has been assigned the
specified string key.DayRange at the specified position in this
chronologically-ordered set.AverageDataSet that was generated to fulfil the
specified AverageDataSpec from the request, or throws a
SourceDataException if no such AverageDataSet could
be generated.IllegalStateException if it was never set (call
RegressionSpec.hasCooling() before calling this).DegreeDaysRegressionComponent object
representing the cooling-degree-days component (c*CDD) of
this Regression, or throws an
IllegalStateException if no such component exists (check
Regression.hasCoolingDegreeDays() before calling this).IllegalStateException if no such base temperatures are
specified (check RegressionTestPlan.hasCustomTestCoolingBaseTemperatures() before
calling this).IllegalStateException if no such base temperatures are
specified (check RegressionTestPlan.hasCustomTestHeatingBaseTemperatures() before
calling this).DatedDataSet that was generated to fulfil the
specified DatedDataSpec from the request, or throws a
SourceDataException if no such DatedDataSet could be
generated.MaybeEmptyDayRanges object - definitely
empty in this case, not just maybe!ExtraRegressionComponent object with
the specified extraPredictorKey, or throws an
IllegalStateException if no such component exists in this
Regression (check Regression.hasExtraComponent(java.lang.String) before calling
this).double value of the extra predictor with the
specified string key.ExtraPredictorSpec associated with the
specified string extraPredictorKey.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.DataSpec
objects would cover given temperature data covering
availableDataRange, or null if
availableDataRange is not of use to any of the
DataSpec objects.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.availableDataRange, or null if
availableDataRange would not be enough for this breakdown.IllegalStateException if it was never set (call
RegressionSpec.hasHeating() before calling this).DegreeDaysRegressionComponent object
representing the heating-degree-days component (h*HDD) of
this Regression, or throws an
IllegalStateException if no such component exists (check
Regression.hasHeatingDegreeDays() before calling this).dataSpec.DataSpec
objects stored within this DataSpecs.request for data to the API servers, returning a
non-null response containing data you requested, or throwing an
appropriate subclass of DegreeDaysApiException if something
goes wrong.DataApi.getLocationData(LocationDataRequest) that returns info about the
station(s) that would be used to satisfy an equivalent
LocationDataRequest, but not the data itself.FailureException.failure() details as the exception
message.DayRangePeriod.withMinimumDayRange(net.degreedays.time.DayRange), or throws an
IllegalStateException if no such range was specified (check
DayRangePeriod.hasMinimumDayRange() before calling this).LatestValuesPeriod.withMinimumNumberOfValues(int), or throws an
IllegalStateException if no such number was specified (check
LatestValuesPeriod.hasMinimumNumberOfValues() before calling this).InputPeriod objects that make up this
InputData.Regression objects, or throws a SourceDataException
if the API could not generate regressions because there was not enough
good weather data for the Location specified in your
RegressionRequest.LocationDataResponse.TimeSeriesDataSet that was generated to fulfil
the specified TimeSeriesDataSpec from the request, or throws
a SourceDataException if no such TimeSeriesDataSet
could be generated.DatedDataValue objects that make up this
DatedDataSet.TimeSeriesDataValue objects that make up this
TimeSeriesDataSet.TimeSeriesDataValue objects from this
TimeSeriesDataSet that fall within the specified
DayRange.TimeSeriesDataValue objects from this
TimeSeriesDataSet that fall within the specified
Day.DataSet objects using the string keys that are usually
managed internally.DayRange that includes all the days
within this DayRange, the specified DayRange
(rangeToIncludeInUnion), and any days between.DayRange that includes all the days
within this DayRange, the specified Day
(dayToIncludeInUnion), and any days between.true if the regression is specified to include
cooling degree days; false otherwise.true if this Regression has a
cooling-degree-days component (c*CDD); false
otherwise.true if a custom set of base temperatures is to be
used for the CDD in the regressions tested by the API, or
false if the API should choose the test cooling base
temperatures automatically.true if a custom set of base temperatures is to be
used for the HDD in the regressions tested by the API, or
false if the API should choose the test heating base
temperatures automatically.true if this Regression has an
extra-predictor component with the specified
extraPredictorKey; false otherwise.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.equals.true if the regression is specified to include
heating degree days; false otherwise.true if this Regression has a
heating-degree-days component (h*HDD); false
otherwise.true if this DayRangePeriod specifies
the day(s) that must be covered by any data returned in response
to a request for data covering this DayRangePeriod.true if this LatestValuesPeriod
specifies the number of values that must be included in the
response to a request for data covering this
LatestValuesPeriod.true if this Regression contains the
specified tag; false otherwise.HeatingDegreeDaysCalculation object with
the specified base temperature.Calculation that specifies that heating degree days should
be calculated and that holds the base temperature that they should be
calculated to.HeatingDegreeDaysCalculation object with the
specified base temperature.TimeSeriesDataValue falls in in the local
time-zone of the weather station.DayTime.OffsetDayTime.Time.TemperatureTimeSeriesCalculation object
with TimeSeriesInterval.HOURLY and the specified
TemperatureUnit.HttpRequest objects.HttpRequest to the API servers and returns a stream
containing the response.InputStream that comes as a response from
the API servers.Distance object that represents this
Distance converted into the specified unit of measurement.Day within this
DayRange, or -1 if it is not contained within this
DayRange.DayRange in this
chronologically-ordered set, or -1 if it is not present.DayRange that contains
day, or -1 if no such DayRange
exists in this chronologically-ordered set.Distance object that represents this
Distance converted into feet.Distance object that represents this
Distance converted into kilometres.Distance object that represents this
Distance converted into metres.Distance object that represents this
Distance converted into miles.InputData object containing the specified
InputPeriod objects.InputData object containing the specified
InputPeriod objects.InputData object containing the specified
InputPeriod objects.InputData containing the dated records
of energy usage and any extra-predictor data to be used in the
regressions tested by the API.InputPeriod covering the specified
DayRange and with the specified energy usage.DayRange covering the days that are contained
within both this DayRange and the specified
DayRange, or null if there is no such
intersection.TimeSeriesInterval indicating the
interval (e.g. hourly) that the time-series data should be
calculated with.true if each contained DatedDataValue starts
the day after the previous DatedDataValue ended
(i.e. no gaps); false otherwise.true if each contained InputPeriod starts
the day after the previous InputPeriod ended (i.e. no
gaps); false otherwise.true if each contained DayRange starts
the day after the previous DayRange ended (i.e. no
gaps); false otherwise.true if this DatedDataSet contains a
contiguous (no gaps) set of day-long values, as is the case for
daily-breakdown data returned by the API.true if this failure came in response to a request
that was sent with an unrecognized account key.true if this failure came in response to a request
for data that is not available on the API account plan associated with
the account key.true if this failure came in response to a request
that was sent with an invalid signature, typically caused by a problem
with the security key.true if this failure came in response to a request
that was sent with an invalid timestamp, typically caused by an
out-of-sync clock on the client machine.true if this failure came in response to a
request for data from a location that the API did not recognize as a
weather station or real-world geographic location.true if this failure came in response to a request
for data from a location that is recognized but not currently supported
by the API.true if this failure was caused by a rate limit on
the number of times a location-limited account can change the location(s)
that they access data from.true if this failure was caused by a temporary
problem preventing the API service from functioning properly (sorry!).true if this failure was caused by a unexpected
error in the API service (sorry!).true if the requested data could not be generated
because the source weather station's recorded temperature data did not
cover the requested period in time.true if the requested data could not be generated
because of errors in the recorded temperature data of the source weather
station.true if the requested data could not be generated
because the source weather station's recorded temperature data was not
fine-grained/detailed enough.true if this DatedDataSet contains a
contiguous (no gaps) set of month-long values, as is the case for
monthly-breakdown data returned by the API.DayOfWeek:
1 for Monday, 2 for Tuesday, 3 for
Wednesday, 4 for Thursday, 5 for Friday,
6 for Saturday, and 7 for Sunday.true if this DatedDataSet contains a
contiguous (no gaps) set of week-long values, as is the case for
weekly-breakdown data returned by the API.true if this DatedDataSet contains a
contiguous (no gaps) set of year-long values, as is the case for
yearly-breakdown data returned by the API.Distance object with the specified
value and DistanceUnit.KILOMETRES as the unit of
measurement.Day in this DayRange.Day of the period covered by this
DatedDataValue.LatestValuesPeriod object that
automatically resolves to a date range including the latest available
data and the specified number of degree-day values.Period that automatically resolves to a date range
including the latest available data and the specified number of degree-day
values.LatestValuesPeriod object that automatically
resolves to a date range including the latest available data and the
specified number of degree-day values.Location object that specifies the
location for which the degree days should be generated.Location object for which data is
desired.Location for which the API should
generate degree days to use in the regressions it tests against the
RegressionRequest.inputData().LocationDataRequest object with the specified
Location and DataSpecs.LocationDataRequest.LocationDataResponse
objects e.g. for testing purposes.LocationDataRequest.LocationInfoRequest object with the specified
Location and DataSpecs.LocationInfoRequest.LocationInfoResponse
objects e.g. for testing purposes.LongLatLocation.LongLatLocation object with the specified
longitude and latitude position.LongLat object with the specified longitude and
latitude (take care not to mix these up).LongLatLocation object with the specified
longitude and latitude position.DayRange objects.Failure.code() and what went
wrong.Distance object with the specified
value and DistanceUnit.METRES as the unit of
measurement.Distance object with the specified
value and DistanceUnit.MILES as the unit of
measurement.Day that comes the specified
numberOfDays before this Day in the calendar.Day that comes the specified
numberOfMonths before this Day in the calendar.Day that comes the specified
numberOfWeeks before this Day in the calendar.Day that comes the specified
numberOfYears before this Day in the calendar.TimeSeriesDataValue falls in in the local
time-zone of the weather station.DayTime.OffsetDayTime.Time.DayTime is after
comparisonDayTime, which will be negative if this
DayTime comes first chronologically.OffsetDayTime is after that represented by
comparisonOffsetDayTime, which will be negative if this
OffsetDayTime comes first chronologically.DayTime is before
comparisonDayTime, which will be negative if
comparisonDayTime comes first chronologically.OffsetDayTime is before that represented by
comparisonOffsetDayTime, which will be negative if
comparisonOffsetDayTime comes first chronologically.MonthlyBreakdown object that specifies
monthly degree days covering the specified period in time,
with each "month" starting on the specified day of the month.MonthlyBreakdown object that specifies
monthly degree days covering the specified period in time
and broken down according to regular calendar months.DatedBreakdown used to specify that degree days should be
broken down on a monthly basis and cover a specific Period in time.MonthlyBreakdown object that specifies monthly
degree days covering the specified period in time, with each
"month" starting on the specified day of the month.MonthlyBreakdown object that specifies monthly
degree days covering the specified period in time and broken
down according to regular calendar months.TimeSeriesDataValue falls in in
the local time-zone of the weather station.Day.DayTime.OffsetDayTime.StartOfYear starts.true if the baseload coefficient() is a per-day value that should be multiplied by the number
of days covered by the period in question; or false if the
coefficient is such that it will only work for periods of the same length
used in the InputData.true if the coefficient() is
a per-day value that should be multiplied by the number of days covered
by the period in question; false otherwise.DegreeDaysApi - the starting point for all API operations.net.degreedays.api.data.Day that comes immediately after this
Day in the calendar.DayOfWeek that comes immediately after
this DayOfWeek (e.g. as Monday comes after Sunday).LongLat object that represents a position the
specified distance North of this.MaybeEmptyDayRanges object as a
DayRanges object, which cannot be empty.DataValue object with the specified
configuration.DatedDataValue object with the specified
value and percentage estimated, and covering just the specified
Day.DatedDataValue object with the specified
value and percentage estimated, and covering the specified
DayRange.TimeSeriesDataValue object with the
specified value, percentage estimated, and date-time.Day object representing a date with the
specified year, month, and day.DayRanges object containing the specified
DayRange objects.DayRanges object containing the specified
DayRange objects.DayRanges object containing the specified
DayRange objects.DayRanges object containing the specified
DayRange objects.DayTime object with the specified
Day and Time.DayTime object with the specified year,
month, day, hour, and minute.OffsetDayTime object with the specified
local date-time and UTC offset.OffsetDayTime object with the specified
local date, time, and UTC offset.StartOfMonth object specifying a
definition of "months" that begin on the specified day of the month.StartOfYear object specifying a
definition of "years" that begin on the specified first day of the year.Time object representing a time with the
specified hour and minute.OffsetDayTime object indicating the
YYYY-MM-DDThh:mm date-time of this TimeSeriesDataValue, both
in the local time-zone of the weather station, and relative to UTC.OffsetDayTime object with the specified local
date-time and UTC offset.OffsetDayTime object with the specified local
date, time, and UTC offset.TimeSeriesDataValue (in the local time zone of the weather
station) is offset from UTC.OffsetDayTime is offset from UTC; for example for
2020-08-15T11:43+01:00 this would return 60, and for
2020-08-15T11:43-05:00 it would return -300.responseStream.DataSet is based on estimated
data.DataValue.value() is based on estimated
data.InputPeriod at the specified index,
which must be between 0 (inclusive) and
InputData.periodCount() (exclusive).InputPeriod objects held by this
InputData object.Day that comes the specified
numberOfDays after this Day in the calendar.Day that comes the specified
numberOfMonths after this Day in the calendar.Day that comes the specified
numberOfWeeks after this Day in the calendar.Day that comes the specified
numberOfYears after this Day in the calendar.PostalCodeLocation object with a postal
code (or zip code, post code, or postcode) and a two-letter country code
representing the country that the postal code belongs to.PostalCodeLocation object with a postal code
(or zip code, post code, or postcode) and a two-letter country code
representing the country that the postal code belongs to.PredictorType that defines how the
extra predictor's figures vary with the length of the periods they are
measured over.Day that comes immediately before this
Day in the calendar.DayOfWeek that comes immediately before
this DayOfWeek (e.g. as Sunday comes before Monday).Request object and returns a
Response object which is either a
FailureResponse or a
Response that's type is the counterpart to
that of the Request object passed in.SortedSet of
Temperature objects, with values running from
firstValue to lastValue (inclusive), and the
specified step between each consecutive temperature.RateLimit objects
e.g. for testing purposes.RateLimit for the account's plan had been reached.InputData you provided and, typically, HDD and/or CDD as well.Regression objects
e.g. for testing purposes.RegressionApi object, providing easy,
type-safe access to the API's regression-related operations.RegressionApi object that uses the specified
RequestProcessor internally.b*days) or the heating (h*HDD) component
in a regression like E = b*days + h*HDDRegressionComponent.RegressionRequest with the specified
Location, InputData, and
RegressionTestPlan.RegressionRequest, with the Regression that gave the best
statistical fit listed first.RegressionResponse objects
e.g. for testing purposes.Regression objects to indicate
why it included them in a RegressionResponse.InputData you
provide it.RegressionTestPlan object that defines how the API
should test regressions against the InputData you provide it.Failure.RequestSecurityInfo
objects.Request into an XML string.Request (e.g. degree day data
returned in response to a request for that data).FailureResponse that
brought details of this failure back from the API servers.ResponseMetadata objects
e.g. for testing purposes.Regression.RegressionRequest to the API servers so it can run
regressions against your InputData and return a non-null
RegressionResponse containing the regressions that were
statistically best and/or any that you specifically requested.Regression, excluding any gaps between input periods.DatedDataSet of the degree days this
regression component was calculated with.DataValue representing the total number
of degree days across all the periods this regression component was
calculated for.Regression.DayRange representing the full period
covered by the sample (including any gaps) that was used for this
Regression.Regression.SecurityKey object using the specified string
security key or throws an IllegalArgumentException if the
string is clearly invalid.SecurityKey object using the specified
characters, or throws an IllegalArgumentException if the
characters are clearly invalid.Builder was constructed with.Builder was constructed with.DayNormalization to be used in the regression
process.InputData sent to the API, to help the API test and rank the
regressions that include data for those extra predictors.Source objects
e.g. for testing purposes.LongLat object that represents a position the
specified distance South of this.RegressionSpec specifying the
components that this Regression contains, such that an
equivalent Regression can be requested in another API
request.Regression.StartOfMonth object indicating which day
should be taken as the first of each month (inclusive).StartOfMonth object specifying a definition of
"months" that begin on the specified day of the month.StartOfYear object indicating which day
should be taken as the first of each year (inclusive).StartOfYear object specifying a definition of
"years" that begin on the specified first day of the year.Station that this source represents.Station objects
e.g. for testing purposes.StationIdLocation represents.StationIdLocation object with the
specified weather station ID.LocationDataResponse.StationIdLocation object with the specified
weather station ID.InputStream object that this
HttpResponseStream object was created with.MaybeEmptyDayRanges (which will be a
DayRanges if it isn't empty) containing the DayRange
objects between the specified indexes in this chronologically-ordered
set.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.Regression came to be included in the response from the API.LongLat object that specifies the
geographic position of the Location from the
LocationDataRequest that led to this response.LongLat object that specifies the
geographic position of the Location from the
LocationInfoRequest that led to this response.LongLat object that specifies the
geographic position of the Location from the
RegressionRequest that led to this response.Temperature object with the specified units and
value (rounded to the nearest 0.1 degrees).TimeSeriesCalculation that specifies that temperature data
should be calculated with the specified interval (e.g. hourly) and unit
(e.g. Celsius).TimeSeriesCalculation object with the specified
interval and temperature unit.TemperatureUnit indicating whether the
temperatures should be calculated in Celsius or Fahrenheit.TemperatureUnit that specifies whether
Celsius-based or Fahrenheit-based degree days should be used in
regressions.RegressionTestPlan that defines how
the API should test regressions against the RegressionRequest.inputData().Time object indicating the hh:mm time of
this TimeSeriesDataValue in the local time-zone of the
weather station.Time object representing the hh:mm
component of this DayTime.Time object representing the hh:mm
component of this OffsetDayTime.Time object representing a time with the
specified hour and minute.TimeSeriesDataSpec object with the
specified TimeSeriesCalculation and
DatedBreakdown.TimeSeriesDataSpec for a specific
Location.TimeSeriesDataSet objects
e.g. for testing purposes.TimeSeriesDataSpec object with the specified
TimeSeriesCalculation and DatedBreakdown.DayRange covering (inclusively) the
days between this Day and firstOrLastDayInRange
(which can be before, after, or equal to this Day).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).DayRanges object representing each
Day within this DayRange as its own
DayRange (covering just one day).OffsetDayTime as a non-null java.util.Date.Day object representing the current
date in the system time-zone.Day object representing the current
date in the UTC time-zone.availableDataRange.availableDataRange.availableDataRange.availableDataRange.availableDataRange.availableDataRange.OffsetDayTime as the number of milliseconds since the epoch
of 1970-01-01T00:00Z.Day in YYYYMMDD format.DayTime in YYYYMMDDHHMM format.Time in HHMM format.TemperatureUnit in the
request XML ("Celsius" or "Fahrenheit")."Hourly").DayNormalization in the
request XML ("Weighted", "Unweighted", or
"None").ExpectedCorrelation in the
request XML ("Positive", "Negative", or
"PositiveOrNegative").PredictorType in the request
XML ("Cumulative" or "Average").RegressionTag in the
response XML ("Shortlist", "NotableOther",
"Requested", or "InShortlistRange").SecurityKey object, but not giving any indication
as to what the security key actually is.Day in YYYY-MM-DD format."Monday", "Tuesday",
"Wednesday", "Thursday", "Friday",
"Saturday", or "Sunday".DayTime in YYYY-MM-DDThh:mm format.OffsetDayTime in ISO format like
2020-08-15T17:57+01:00, 2020-08-15T12:57-05:00,
or 2020-08-15T16:57Z.---DD format, the format used by XML Schema's
gDay type (based on ISO 8601).--MM-DD format, the format used by XML Schema's
gMonthDay type (based on ISO 8601).Time in hh:mm format.AverageDataSet object, based on the data
contained within this, but transformed to fit the
targetBreakdown.DatedDataSet object, based on the data
contained within this, but transformed to fit the
targetBreakdown.TransportException with the specified
message and cause.TransportException with the specified
message and null for the cause.TransportException with null
for its message and cause.TransportException with the specified cause
and a detail message of cause.toString() or
null if cause is null.Distance object.InputPeriod.NaN or infinity, and,
for degree days, will always be zero or greater.Distance object.DatedDataValue at the specified
index, which must be between 0 (inclusive) and
DatedDataSet.valueCount() (exclusive).TimeSeriesDataValue at the specified
index, which must be between 0 (inclusive) and
TimeSeriesDataSet.valueCount() (exclusive).DatedDataSet
object, which will always be greater than zero.TimeSeriesDataSet
object, which will always be greater than zero.WeeklyBreakdown object that specifies
weekly degree days covering the specified period in time, with each
"week" starting on the specified day of the week.DatedBreakdown used to specify that degree days should be
broken down on a weekly basis and cover a specific Period in time,
with weeks starting on a specific day of the week.WeeklyBreakdown object that specifies weekly
degree days covering the specified period in time, with each "week"
starting on the specified day of the week.LongLat object that represents a position the
specified distance West of this.CustomBreakdown with the same CustomBreakdown.dayRanges()
as this, but with the DatedBreakdown.allowPartialLatest() property
set to the specified value.DailyBreakdown with the same DailyBreakdown.period() as
this, but with the DatedBreakdown.allowPartialLatest() property
set to the specified value.MonthlyBreakdown with the same MonthlyBreakdown.period()
and MonthlyBreakdown.startOfMonth() as this, but with the
DatedBreakdown.allowPartialLatest() property set to the specified value.WeeklyBreakdown with the same WeeklyBreakdown.period()
and WeeklyBreakdown.firstDayOfWeek() as this, but with the
DatedBreakdown.allowPartialLatest() property set to the specified value.YearlyBreakdown with the same YearlyBreakdown.period()
and YearlyBreakdown.startOfYear() as this, but with the
DatedBreakdown.allowPartialLatest() property set to the specified value.RegressionSpec based on this but
also specifying that cooling degree days with the specified base
temperature are to be included.InputPeriod based on this but
also including an extra predictor with the specified key and
value.RegressionSpec based on this but
also specifying that extra predictors with the specified
keys are to be included.RegressionSpec based on this but
also specifying that extra predictors with the specified
keys are to be included.RegressionSpec based on this but
also specifying that heating degree days with the specified base
temperature are to be included.DayRangePeriod with the same
DayRangePeriod.dayRange() as this, but also specifying
minimumDayRange as the minimum range required.LatestValuesPeriod with the same
LatestValuesPeriod.numberOfValues() as this, but also specifying
minimumNumberOfValues as the minimum number of values
required.RequestProcessor interface that
turns Request objects into XML, adds the necessary security details,
sends them over HTTP to the Degree Days.net API servers, and parses the XML
responses into Response object models.XmlHttpRequestProcessor objects: create and configure a
Builder object, then call XmlHttpRequestProcessor.Builder.build() to create an
XmlHttpRequestProcessor object.RequestSecurityInfo.TimeSeriesDataValue falls in in the local time-zone of the
weather station.Day
object.DayTime.OffsetDayTime.YearlyBreakdown object that specifies
yearly degree days covering the specified period in time,
with each "year" starting on the specified day of the year.YearlyBreakdown object that specifies
yearly degree days covering the specified period in time and
broken down according to regular calendar years.DatedBreakdown used to specify that degree days should be
broken down on a yearly (annual) basis and cover a specific Period in
time.YearlyBreakdown object that specifies yearly
degree days covering the specified period in time, with each
"year" starting on the specified day of the year.YearlyBreakdown object that specifies yearly
degree days covering the specified period in time and broken
down according to regular calendar years.
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.