net.degreedays.api.regression

Enum DayNormalization

java.lang.Object

java.lang.Enum<DayNormalization>

net.degreedays.api.regression.DayNormalization

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DayNormalization>

public enum DayNormalization
extends java.lang.Enum<DayNormalization>

Defines the day normalization used in the regression process – an important consideration when periods of energy usage cover different lengths of time.

The best explanation of the day-normalization options is in the docs for our online regression tool (which itself uses the API internally).

Since:

1.4

See Also:

www.degreedays.net/regression#day-normalization

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE For no day normalization at all, this works fine for InputData with periods that are all the same length, but not so well for data with periods of different length.
UNWEIGHTED For InputData with periods of different length this is typically better than using no day normalization at all, but it's not as good as the WEIGHTED option.
WEIGHTED The recommended option, this gives the best results for InputData with periods of different length, and the weighting makes no difference if the periods are all the same length.

Method Summary

Modifier and Type	Method and Description
static DayNormalization	fromString(java.lang.String string) Returns the non-null DayNormalization with the specified string (returned by its toString() method).
java.lang.String	toString() Returns a non-null, non-empty string representation of this enum constant in the format required to specify a DayNormalization in the request XML ("Weighted", "Unweighted", or "None").
static DayNormalization	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DayNormalization[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WEIGHTED

public static final DayNormalization WEIGHTED

The recommended option, this gives the best results for InputData with periods of different length, and the weighting makes no difference if the periods are all the same length. With this option longer periods effectively have a greater influence on the regression coefficients than shorter periods.

See Also:

www.degreedays.net/regression#day-normalization

UNWEIGHTED

public static final DayNormalization UNWEIGHTED

For InputData with periods of different length this is typically better than using no day normalization at all, but it's not as good as the WEIGHTED option.

See Also:

www.degreedays.net/regression#day-normalization

NONE

public static final DayNormalization NONE

For no day normalization at all, this works fine for InputData with periods that are all the same length, but not so well for data with periods of different length.

See Also:

www.degreedays.net/regression#day-normalization

Method Detail

values

public static DayNormalization[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DayNormalization c : DayNormalization.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DayNormalization valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this enum constant in the format required to specify a DayNormalization in the request XML ("Weighted", "Unweighted", or "None").

Overrides:

toString in class java.lang.Enum<DayNormalization>

fromString

public static DayNormalization fromString(java.lang.String string)
                                   throws java.lang.IllegalArgumentException

Returns the non-null DayNormalization with the specified string (returned by its toString() method).

Throws:

java.lang.NullPointerException - if string is null.

java.lang.IllegalArgumentException - if string is not one of "Weighted", "Unweighted", or "None".