net.degreedays.api.regression

Class Regression.Builder

java.lang.Object

net.degreedays.api.regression.Regression.Builder

Enclosing class:

Regression

public static final class Regression.Builder
extends java.lang.Object

A builder class for creating immutable Regression objects e.g. for testing purposes.

Since:

1.4

Instances of this builder class are designed for single-threaded use only. It's fine to create and use instances in multiple concurrent threads, but, in the absence of external synchronization, the use of each individual builder instance should be restricted to one thread only.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Regression.Builder	addExtraComponent(java.lang.String extraPredictorKey, ExtraRegressionComponent extraComponent) Adds a regression component based on extra-predictor data with the specified extra-predictor key from the request.
Regression.Builder	addTag(RegressionTag tag)
Regression	build()
Regression.Builder	setAdjustedRSquared(double adjustedRSquared)
Regression.Builder	setBaseload(BaseloadRegressionComponent baseload)
Regression.Builder	setCoolingDegreeDays(DegreeDaysRegressionComponent coolingDegreeDays)
Regression.Builder	setCrossValidatedRSquared(double crossValidatedRSquared)
Regression.Builder	setCvrmse(double cvrmse)
Regression.Builder	setHeatingDegreeDays(DegreeDaysRegressionComponent heatingDegreeDays)
Regression.Builder	setRSquared(double rSquared)
Regression.Builder	setSampleDays(int sampleDays)
Regression.Builder	setSampleSize(int sampleSize)
Regression.Builder	setSampleSpan(DayRange sampleSpan)
Regression.Builder	setStandardError(double standardError)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setBaseload

public Regression.Builder setBaseload(BaseloadRegressionComponent baseload)

setHeatingDegreeDays

public Regression.Builder setHeatingDegreeDays(DegreeDaysRegressionComponent heatingDegreeDays)

setCoolingDegreeDays

public Regression.Builder setCoolingDegreeDays(DegreeDaysRegressionComponent coolingDegreeDays)

addExtraComponent

public Regression.Builder addExtraComponent(java.lang.String extraPredictorKey,
                                            ExtraRegressionComponent extraComponent)

Adds a regression component based on extra-predictor data with the specified extra-predictor key from the request.

Parameters:

extraPredictorKey - a string key from the XML response, associated with a particular extra predictor from the original request. Cannot be null, must match the regular expression [-_.a-zA-Z0-9]{1,60}, and cannot be "baseload", "heatingDegreeDays", or "coolingDegreeDays".

extraComponent - the non-null ExtraRegressionComponent associated with extraPredictorKey.

Returns:

this, for method chaining.

Throws:

java.lang.NullPointerException - if extraPredictorKey or extraComponent is null.

java.lang.IllegalArgumentException - if extraPredictorKey does not match the specification detailed above, or if an extra component has already been added with extraPredictorKey.

setSampleSize

public Regression.Builder setSampleSize(int sampleSize)

setSampleDays

public Regression.Builder setSampleDays(int sampleDays)

setSampleSpan

public Regression.Builder setSampleSpan(DayRange sampleSpan)

setRSquared

public Regression.Builder setRSquared(double rSquared)

setAdjustedRSquared

public Regression.Builder setAdjustedRSquared(double adjustedRSquared)

setCrossValidatedRSquared

public Regression.Builder setCrossValidatedRSquared(double crossValidatedRSquared)

setStandardError

public Regression.Builder setStandardError(double standardError)

setCvrmse

public Regression.Builder setCvrmse(double cvrmse)

addTag

public Regression.Builder addTag(RegressionTag tag)

build

public Regression build()