net.degreedays.api.regression

Class ExtraPredictorSpec

java.lang.Object

net.degreedays.api.regression.ExtraPredictorSpec

All Implemented Interfaces:

java.io.Serializable

public final class ExtraPredictorSpec
extends java.lang.Object
implements java.io.Serializable

Defines an extra predictor in terms of its PredictorType and ExpectedCorrelation, to help the API test and rank regressions that include data for that extra predictor.

These are held by the RegressionTestPlan. There's some sample code in the regression API docs on our website, and also there's some additional practical information on specifying and using extra predictors in the docs for our website regression tool (which itself uses the API internally).

Since:

1.4

See Also:

RegressionTestPlan.Builder.addExtraPredictorSpec(java.lang.String, net.degreedays.api.regression.ExtraPredictorSpec)

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
ExtraPredictorSpec(PredictorType predictorType, ExpectedCorrelation expectedCorrelation) Constructs an ExtraPredictorSpec with the specified PredictorType and ExpectedCorrelation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Returns true if o is an ExtraPredictorSpec with the same predictorType() and expectedCorrelation() as this.
ExpectedCorrelation	expectedCorrelation() Returns the non-null ExpectedCorrelation that defines how the extra predictor is expected to correlate with energy usage.
int	hashCode() Overridden to ensure consistency with equals.
PredictorType	predictorType() Returns the non-null PredictorType that defines how the extra predictor's figures vary with the length of the periods they are measured over.
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

ExtraPredictorSpec

public ExtraPredictorSpec(PredictorType predictorType,
                          ExpectedCorrelation expectedCorrelation)

Constructs an ExtraPredictorSpec with the specified PredictorType and ExpectedCorrelation.

Parameters:

predictorType - defines how the extra predictor's figures vary with the length of the periods they are measured over. Cannot be null.

expectedCorrelation - defines how the extra predictor is expected to correlate with energy usage. Cannot be null.

Throws:

java.lang.NullPointerException - if predictorType or expectedCorrelation is null.

Method Detail

predictorType

public PredictorType predictorType()

Returns the non-null PredictorType that defines how the extra predictor's figures vary with the length of the periods they are measured over.

expectedCorrelation

public ExpectedCorrelation expectedCorrelation()

Returns the non-null ExpectedCorrelation that defines how the extra predictor is expected to correlate with energy usage.

equals

public boolean equals(java.lang.Object o)

Returns true if o is an ExtraPredictorSpec with the same predictorType() and expectedCorrelation() 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