net.degreedays.api.regression

Class DegreeDaysRegressionComponent

java.lang.Object

net.degreedays.api.regression.RegressionComponent

net.degreedays.api.regression.DegreeDaysRegressionComponent

All Implemented Interfaces:

java.io.Serializable

public final class DegreeDaysRegressionComponent
extends RegressionComponent

Contains details of a heating or cooling component in a regression, with the base temperature and degree days used, as well as the usual coefficient and stats.

Since:

1.4

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	DegreeDaysRegressionComponent.Builder A builder class for creating immutable DegreeDaysRegressionComponent objects e.g. for testing purposes.

Method Summary

Modifier and Type	Method and Description
Temperature	baseTemperature() Returns the non-null base temperature of the degree days this regression component was calculated with.
DatedDataSet	sampleDegreeDaysDataSet() Returns the non-null DatedDataSet of the degree days this regression component was calculated with.
DataValue	sampleDegreeDaysTotal() Returns the non-null DataValue representing the total number of degree days across all the periods this regression component was calculated for.
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.regression.RegressionComponent

coefficient, coefficientPValue, coefficientStandardError, equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

baseTemperature

public Temperature baseTemperature()

Returns the non-null base temperature of the degree days this regression component was calculated with.

sampleDegreeDaysDataSet

public DatedDataSet sampleDegreeDaysDataSet()

Returns the non-null DatedDataSet of the degree days this regression component was calculated with.

sampleDegreeDaysTotal

public DataValue sampleDegreeDaysTotal()

Returns the non-null DataValue representing the total number of degree days across all the periods this regression component was calculated for.

This will have a value equal to the total of all the degree-day values in sampleDegreeDaysDataSet().

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