RegressionRequest (Degree Days.net API JavaDoc)

java.lang.Object
- net.degreedays.api.Request
- - net.degreedays.api.regression.RegressionRequest

All Implemented Interfaces:

java.io.Serializable
```
public final class RegressionRequest
extends Request
implements java.io.Serializable
```
Defines a request for the API to test regressions against the specified energy data (InputData) using degree days from the specified Location.
A successfully-processed RegressionRequest, sent to the API via RegressionApi.runRegressions(RegressionRequest), will result in a RegressionResponse containing a list of the regressions with the best statistical fit.

See www.degreedays.net/api/regression for more information and code samples.

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.

Constructor Summary

Constructors
Constructor and Description
`RegressionRequest(Location location, InputData inputData, RegressionTestPlan testPlan)` Constructs a `RegressionRequest` with the specified `Location`, `InputData`, and `RegressionTestPlan`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Returns `true` if `o` is a `RegressionRequest` object with the same configuration as `this`.
`int`	`hashCode()` Overridden to ensure consistency with `equals`.
`InputData`	`inputData()` Returns the non-null `InputData` containing the dated records of energy usage and any extra-predictor data to be used in the regressions tested by the API.
`Location`	`location()` Returns the non-null `Location` for which the API should generate degree days to use in the regressions it tests against the `inputData()`.
`RegressionTestPlan`	`testPlan()` Returns the non-null `RegressionTestPlan` that defines how the API should test regressions against the `inputData()`.
`java.lang.String`	`toString()` Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RegressionRequest
```
public RegressionRequest(Location location,
                         InputData inputData,
                         RegressionTestPlan testPlan)
```
    Constructs a RegressionRequest with the specified Location, InputData, and RegressionTestPlan.
    
    Parameters:
    
    location - the location for which the API should generate degree days to use in the regressions it tests against the InputData. Cannot be null.
    
    inputData - the dated records of energy usage and any extra-predictor data to be used in the regressions tested by the API. Cannot be null.
    
    testPlan - defining how the API should test regressions against the InputData. Cannot be null, must have an ExtraPredictorSpec for any extra-predictor keys used in inputData, and, if it has any RegressionTestPlan.requestedRegressionSpecs(), they must not contain any extra-predictor keys that do not have data in inputData.
    
    Throws:
    
    java.lang.NullPointerException - if location, inputData, or testPlan are null.
    
    java.lang.IllegalArgumentException - if inputData contains extra-predictor data but testPlan does not contain an ExtraPredictorSpec for each extra-predictor key included, or if testPlan contains a requested RegressionSpec with an extra-predictor key that does not have data in inputData.
- Method Detail
  - location
```
public Location location()
```
    Returns the non-null Location for which the API should generate degree days to use in the regressions it tests against the inputData().
  - inputData
```
public InputData inputData()
```
    Returns the non-null InputData containing the dated records of energy usage and any extra-predictor data to be used in the regressions tested by the API.
  - testPlan
```
public RegressionTestPlan testPlan()
```
    Returns the non-null RegressionTestPlan that defines how the API should test regressions against the inputData().
  - equals
```
public boolean equals(java.lang.Object o)
```
    Returns true if o is a RegressionRequest object with the same configuration as this.
    
    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

Class RegressionRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegressionRequest

Method Detail

location

inputData

testPlan

equals

hashCode

toString