RegressionSpec (Degree Days.net API JavaDoc)

java.lang.Object
- net.degreedays.api.regression.RegressionSpec

All Implemented Interfaces:

java.io.Serializable
```
public final class RegressionSpec
extends java.lang.Object
implements java.io.Serializable
```
Defines a specification of a regression in terms of its HDD and/or CDD base temperature(s) and any extra predictors to be included.
To create a RegressionSpec, start with a baseload-only spec from baseload() (since every regression needs a baseload component), then build upon it using whichever of the withXXX methods you need. For example:
```
 RegressionSpec spec = RegressionSpec.baseload()
     .withHeating(Temperature.celsius(15.5))
     .withCooling(Temperature.celsius(21))
     .withExtraPredictorKeys("occupancy", "production");
 
```
See www.degreedays.net/api/regression#requested for more information and code samples.
Since:

1.4

See Also:

RegressionTestPlan.Builder.setRequestedRegressionSpecs(RegressionSpec...)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegressionSpec`	`baseload()` Returns a specification for a baseload-only regression (e.g. `E = b*days`) which can be built upon as per the example code.
`boolean`	`equals(java.lang.Object o)` Returns `true` if `o` is a `RegressionSpec` with the same configuration as `this`.
`java.util.Set<java.lang.String>`	`extraPredictorKeys()` Returns the non-null, possibly-empty, immutable set of the keys of the extra predictors to be included in the specified regression.
`Temperature`	`getCoolingBaseTemperature()` Returns the non-null base temperature to be used for the cooling degree days in the specified regression, or throws an `IllegalStateException` if it was never set (call `hasCooling()` before calling this).
`Temperature`	`getHeatingBaseTemperature()` Returns the non-null base temperature to be used for the heating degree days in the specified regression, or throws an `IllegalStateException` if it was never set (call `hasHeating()` before calling this).
`boolean`	`hasCooling()` Returns `true` if the regression is specified to include cooling degree days; `false` otherwise.
`int`	`hashCode()` Overridden to ensure consistency with `equals`.
`boolean`	`hasHeating()` Returns `true` if the regression is specified to include heating degree days; `false` otherwise.
`java.lang.String`	`toString()` Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
`RegressionSpec`	`withCooling(Temperature coolingBaseTemperature)` Returns a new `RegressionSpec` based on `this` but also specifying that cooling degree days with the specified base temperature are to be included.
`RegressionSpec`	`withExtraPredictorKeys(java.lang.Iterable<java.lang.String> keys)` Returns a new `RegressionSpec` based on `this` but also specifying that extra predictors with the specified `keys` are to be included.
`RegressionSpec`	`withExtraPredictorKeys(java.lang.String... keys)` Returns a new `RegressionSpec` based on `this` but also specifying that extra predictors with the specified `keys` are to be included.
`RegressionSpec`	`withHeating(Temperature heatingBaseTemperature)` Returns a new `RegressionSpec` based on `this` but also specifying that heating degree days with the specified base temperature are to be included.

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

- Method Detail
  - baseload
```
public static RegressionSpec baseload()
```
    Returns a specification for a baseload-only regression (e.g. E = b*days) which can be built upon as per the example code.
  - withHeating
```
public RegressionSpec withHeating(Temperature heatingBaseTemperature)
```
    Returns a new RegressionSpec based on this but also specifying that heating degree days with the specified base temperature are to be included.
    
    Parameters:
    
    heatingBaseTemperature - the base temperature of the heating degree days to be included in the specified regression. Cannot be null.
    
    Throws:
    
    java.lang.NullPointerException - if heatingBaseTemperature is null.
    
    java.lang.IllegalArgumentException - if this already has a cooling base temperature, but heatingBaseTemperature does not have the same temperature unit.
  - withCooling
```
public RegressionSpec withCooling(Temperature coolingBaseTemperature)
```
    Returns a new RegressionSpec based on this but also specifying that cooling degree days with the specified base temperature are to be included.
    
    Parameters:
    
    coolingBaseTemperature - the base temperature of the cooling degree days to be included in the specified regression. Cannot be null.
    
    Throws:
    
    java.lang.NullPointerException - if coolingBaseTemperature is null.
    
    java.lang.IllegalArgumentException - if this already has a heating base temperature, but coolingBaseTemperature does not have the same temperature unit.
  - withExtraPredictorKeys
```
public RegressionSpec withExtraPredictorKeys(java.lang.String... keys)
```
    Returns a new RegressionSpec based on this but also specifying that extra predictors with the specified keys are to be included.
    
    Parameters:
    
    keys - the extra-predictor keys that identify the extra predictors to be included in the regression. There can be a maximum of 2 keys. Each key must match the regular expression [-_.a-zA-Z0-9]{1,60}, with "baseload", "heatingDegreeDays", and "coolingDegreeDays" specifically disallowed.
    
    Throws:
    
    java.lang.NullPointerException - if keys is null or contains null.
    
    java.lang.IllegalArgumentException - if there are more than 2 keys, or if any of the keys do not match the specification detailed above.
    
    See Also:
    
    withExtraPredictorKeys(Iterable)
  - withExtraPredictorKeys
```
public RegressionSpec withExtraPredictorKeys(java.lang.Iterable<java.lang.String> keys)
```
    Returns a new RegressionSpec based on this but also specifying that extra predictors with the specified keys are to be included.
    
    Parameters:
    
    keys - the extra-predictor keys that identify the extra predictors to be included in the regression. There can be a maximum of 2 keys. Each key must match the regular expression [-_.a-zA-Z0-9]{1,60}, with "baseload", "heatingDegreeDays", and "coolingDegreeDays" specifically disallowed.
    
    Throws:
    
    java.lang.NullPointerException - if keys is null or contains null.
    
    java.lang.IllegalArgumentException - if there are more than 2 keys, or if any of the keys do not match the specification detailed above.
    
    See Also:
    
    withExtraPredictorKeys(String...)
  - hasHeating
```
public boolean hasHeating()
```
    Returns true if the regression is specified to include heating degree days; false otherwise.
    If this returns true, it is safe to call getHeatingBaseTemperature().
    
    See Also:
    
    withHeating(net.degreedays.api.data.Temperature)
  - getHeatingBaseTemperature
```
public Temperature getHeatingBaseTemperature()
```
    Returns the non-null base temperature to be used for the heating degree days in the specified regression, or throws an IllegalStateException if it was never set (call hasHeating() before calling this).
    
    Throws:
    
    java.lang.IllegalStateException - if this RegressionSpec does not hold a heating base temperature.
    
    See Also:
    
    withHeating(net.degreedays.api.data.Temperature)
  - hasCooling
```
public boolean hasCooling()
```
    Returns true if the regression is specified to include cooling degree days; false otherwise.
    If this returns true, it is safe to call getCoolingBaseTemperature().
    
    See Also:
    
    withCooling(net.degreedays.api.data.Temperature)
  - getCoolingBaseTemperature
```
public Temperature getCoolingBaseTemperature()
```
    Returns the non-null base temperature to be used for the cooling degree days in the specified regression, or throws an IllegalStateException if it was never set (call hasCooling() before calling this).
    
    Throws:
    
    java.lang.IllegalStateException - if this RegressionSpec does not hold a cooling base temperature.
    
    See Also:
    
    withCooling(net.degreedays.api.data.Temperature)
  - extraPredictorKeys
```
public java.util.Set<java.lang.String> extraPredictorKeys()
```
    Returns the non-null, possibly-empty, immutable set of the keys of the extra predictors to be included in the specified regression.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Returns true if o is a RegressionSpec 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 RegressionSpec

Method Summary

Methods inherited from class java.lang.Object

Method Detail

baseload

withHeating

withCooling

withExtraPredictorKeys

withExtraPredictorKeys

hasHeating

getHeatingBaseTemperature

hasCooling

getCoolingBaseTemperature

extraPredictorKeys

equals

hashCode

toString