net.degreedays.api.regression

Class RegressionResponse

java.lang.Object

net.degreedays.api.Response

net.degreedays.api.regression.RegressionResponse

All Implemented Interfaces:

java.io.Serializable

public final class RegressionResponse
extends Response
implements java.io.Serializable

Contains a selection of the regressions that the API tested against your RegressionRequest, with the Regression that gave the best statistical fit listed first.

Since:

1.4

See Also:

RegressionApi.runRegressions(RegressionRequest)

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegressionResponse.Builder A builder class for creating immutable RegressionResponse objects e.g. for testing purposes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Returns true if o is a RegressionResponse with equal values apart from the metadata() (which is not considered in the equality test).
java.util.List<Regression>	getRegressions() Returns a non-null, non-empty, best-first ordered list of 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.
Source[]	getSources() Returns the non-null, non-empty array of source(s) (essentially weather stations) that were used to generate the degree days used for the regressions in this response.
int	hashCode() Overridden to ensure consistency with equals.
java.lang.String	stationId() Returns the non-null, non-empty canonical ID of the weather station or combination of weather stations that supplied the temperature data used to calculate the degree days used for the regressions in this response.
LongLat	targetLongLat() Returns the non-null LongLat object that specifies the geographic position of the Location from the RegressionRequest that led to this response.
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.Response

metadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

stationId

public java.lang.String stationId()

Returns the non-null, non-empty canonical ID of the weather station or combination of weather stations that supplied the temperature data used to calculate the degree days used for the regressions in this response. If this response does not actually contain any regressions, this will be the ID of the weather station that would have been used if it had had enough data to run regressions against the InputData provided in the request.

If the Location in the RegressionRequest was a StationIdLocation, this method will simply return the canonical form of that weather station's ID. We say "canonical" because it's possible for a station ID to be expressed in more than one way, like upper case or lower case. The canonical form of the station ID is the form that you should display in a UI or store in a database if appropriate.

If the Location in the RegressionRequest was a GeographicLocation, then:

• If the degree days used in the regressions were calculated using temperature data from a single station (the usual case), this method will return the canonical form of that station's ID.
• If the degree days used in the regressions were calculated using temperature data combined from multiple stations (something that the API might optionally start doing at some point in the future), this method will return the ID of a "virtual station" that represents the specific combination of weather stations used.

Either way, the station ID returned by this method can be used to run more regressions or fetch more data from the same station(s) that were used to generate the degree days used for the regressions in this response. For example, you might want to start off using a GeographicLocation initially, and then use the returned station ID to fetch more data or run more regressions using the same station.

targetLongLat

public LongLat targetLongLat()

Returns the non-null LongLat object that specifies the geographic position of the Location from the RegressionRequest that led to this response.

If the Location from the request was a PostalCodeLocation, this will return the LongLat that the API determined to be the central point of that postal code.

If the Location from the request was a StationIdLocation, this will return the LongLat of that station (also accessible through getSources()).

If the Location from the request was a LongLatLocation, this will simply return the LongLat that was originally specified. (Bear in mind that the longitude and latitude may have been rounded slightly between the request and the response. Such rounding would only introduce very small differences that would be insignificant as far as the real-world position is concerned, but it's worth bearing this in mind in case you are comparing for equality the returned LongLat with the LongLat from the request. The two positions will be close, but they might not be equal.)

getSources

public Source[] getSources()

Returns the non-null, non-empty array of source(s) (essentially weather stations) that were used to generate the degree days used for the regressions in this response. If this response does not actually contain any regressions, this will return the source(s) that would have been used if they had had enough data to run regressions against the InputData provided in the request.

At the time of writing there will only be one source for any given response (so getSources()[0] is the way to get it)... But at some point we might start combining data from multiple sources to satisfy requests for data from geographic locations. If we do add this feature, it will be optional, and disabled by default, so the behaviour of your system won't change unless you want it to.

The returned array can be modified freely without affecting the immutability of this RegressionResponse or the arrays returned by past, concurrent, or future calls to this method.

getRegressions

public java.util.List<Regression> getRegressions()
                                          throws SourceDataException

Returns a non-null, non-empty, best-first ordered list of 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.

Throws:

SourceDataException - if the API could not generate any regressions because there wasn't enough good weather data available for the Location specified in your RegressionRequest.

equals

public boolean equals(java.lang.Object o)

Returns true if o is a RegressionResponse with equal values apart from the metadata() (which is not considered in the equality test).

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overridden to ensure consistency with equals.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object