|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
AccountKey
object using the specified string
account key or throws an IllegalArgumentException
if the
string is clearly invalid.
DataSpec
in
the request and a DataSet
from the response.
DataSpec
from the request and a
DataSet
from the response, without dealing directly with the
string keys that are used in the XML.
DataSpec
to be associated with
it.
DataSpec
in
the request and a Failure
from the response.
DataSpec
from the request and a
Failure
from the response, without dealing directly with the
string keys that are used in the XML.
DatedDataValue
object.
Day
comes later in time than the
specified comparison Day
.
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
.
Day
comes earlier in time than the
specified comparison Day
.
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.
DataSets
object created according to the
specification held by this builder.
DataSpecs
object with the configuration that
is currently held by this builder.
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.
Temperature
object with the specified
Celsius temperature rounded to the nearest 0.1 C.
HttpResponseStream.stream()
, wrapping any IOException
in a
TransportException
.
Day
objects for chronological ordering.
true
if the specified Day
is fully
contained within this DayRange
; false
otherwise.
true
if the specified DayRange
is
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.
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.
DataSpec
for
a specific Location
.DataSpecs
for a specific Location
.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.ResponseParser
, and that's not an interface that you are
likely to need to deal with unless you are replacing parts of the
framework.
LocationDataRequest
.DataSpecs
object containing the specified
DataSpec
objects.
DataSpecs
object containing the specified
DataSpec
objects.
DataSpecs
object containing just the one
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.DataSpecs.CustomKeyBuilder
.
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 representing a date with the
specified year, month, and day.
Day
at the specified zero-based index
within this DayRange
.
DayRange
(always
1 or more).
Day
object.
StartOfYear.monthOfYear()
(inclusive) indicating which day in
monthOfYear()
is the first day of the "year" defined by this
StartOfYear
.
Day
object.
Day
object.
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
.
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
.
DegreeDaysApi
object that internally uses a
default RequestProcessor
configured with the specified access
keys.
DegreeDaysApi
object that internally uses the
specified RequestProcessor
.
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()
.
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).
Failure
can only be equal to another Failure
with an equal Failure.code()
and Failure.message()
.
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.
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
.
Day
objects are equal if they represent the same date.
true
if o
is a DayRange
covering exactly the same days as this DayRange
;
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.
Temperature
object with the specified
Fahrenheit temperature rounded to the nearest 0.1 F.
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.Response
that indicates a failure in the server-side
processing 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
.
YYYY-MM-DD
format (the format
used by XML schema's date type), or YYYYMMDD
format.
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).
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.
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
.
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
.
get(dataSpec)
with an
AverageDataSpec
and then casting the result.
get(dataSpec)
with a
DatedDataSpec
and then casting the result.
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.
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 (call
DayRangePeriod.hasMinimumDayRange()
before calling this).
LatestValuesPeriod.withMinimumNumberOfValues(int)
, or throws an
IllegalStateException
if no such number was specified (call
LatestValuesPeriod.hasMinimumNumberOfValues()
before calling this).
LocationDataResponse
.
DatedDataValue
objects that make up
this DatedDataSet
.
DataSet
objects using the string keys that are usually
managed internally.
DayRange
that includes all the days
within this DayRange
, the specified DayRange
,
and any days between.
DayRange
that includes all the days
within this DayRange
, the specified Day
, and
any days between.
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 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
.
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.
HttpRequest
objects.HttpRequestDispatcher.dispatch(HttpRequest)
has
been inflated.Distance
object that represents this
Distance
converted into the specified unit of measurement.
Day
within this
DayRange
, or -1 if it is not contained by this
DayRange
.
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.
DayRange
covering the days that are contained
within both this DayRange
and the specified
DayRange
, or null
if there is no such
intersection.
true
if this temperature has
CELSUS
units.
true
if each of the values contained within this
DatedDataSet
covers one day.
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
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 this temperature has
FAHRENHEIT
units.
true
if each of the values contained within this
DatedDataSet
covers one month.
true
if each of the values contained within this
DatedDataSet
covers one week.
true
if each of the values contained within this
DatedDataSet
covers one year.
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.
LocationDataRequest
object with the specified
Location
and DataSpecs
.
LocationDataRequest
.LocationDataResponse
objects e.g. for testing purposes.Failure
in the API's processing of a request, caused by
problems with the Location
that the request specified.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.
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.
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.
Day
object.
StartOfYear
starts.
DegreeDaysApi
- the starting point for all API operations.net.degreedays.api.data
.Day
that comes immediately after this
Day
in the calendar.
LongLat
object that represents a position the
specified distance
North of this
.
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
.
Day
object representing a date with the
specified year, month, and day.
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.
responseStream
.
DataSet
is based on estimated
data.
DataValue.value()
is based on estimated
data.
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.
Day
that comes immediately before this
Day
in the calendar.
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.
RateLimit
objects
e.g. for testing purposes.RateLimit
for the account's plan had been reached.Failure
.RequestSecurityInfo
objects.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.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.
Source
objects
e.g. for testing purposes.Failure
to generate a DataSet
caused by problems
with the source temperature data for the Location
and Period
requested.LongLat
object that represents a position the
specified distance
South of this
.
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.
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.
Temperature
object with the specified units and
value (rounded to the nearest 0.1 degrees).
DayRange
covering (inclusively) the
days between this Day
and firstOrLastDayInRange
(which can be before, after, or equal to this Day
).
availableDataRange
.
availableDataRange
.
availableDataRange
.
availableDataRange
.
availableDataRange
.
Day
object in YYYYMMDD
format.
SecurityKey
object, but not giving any indication
as to what the security key actually is.
Day
object in YYYY-MM-DD
format.
---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).
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.
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).
DatedDataSet
object, which will always be greater than zero.
TemperatureUnit
values.
DistanceUnit
values.
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
.
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.Day
object.
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.
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |