net.degreedays.api.regression

Enum ExpectedCorrelation

java.lang.Object

java.lang.Enum<ExpectedCorrelation>

net.degreedays.api.regression.ExpectedCorrelation

All Implemented Interfaces:

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

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

Defines how an extra predictor's figures are expected to correlate with energy usage (whether larger predictor numbers lead to larger or smaller energy usage). This helps the API rank the various regressions it tests, as it will downrank the regressions with extra predictors that correlate with energy usage in an unexpected way.

Since:

1.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEGATIVE For an extra predictor expected to have a negative correlation with energy usage i.e. larger extra-predictor figures lead to smaller energy usage.
POSITIVE For an extra predictor expected to have a positive correlation with energy usage i.e. larger extra-predictor figures lead to larger energy usage.
POSITIVE_OR_NEGATIVE For an extra predictor that could be expected to have either a positive or negative correlation with energy usage.

Method Summary

Modifier and Type	Method and Description
static ExpectedCorrelation	fromString(java.lang.String string) Returns the non-null ExpectedCorrelation with the specified string (returned by its toString() method).
java.lang.String	toString() Returns a non-null, non-empty string representation of this object in the format required to specify an ExpectedCorrelation in the request XML ("Positive", "Negative", or "PositiveOrNegative").
static ExpectedCorrelation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExpectedCorrelation[]	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

POSITIVE

public static final ExpectedCorrelation POSITIVE

For an extra predictor expected to have a positive correlation with energy usage i.e. larger extra-predictor figures lead to larger energy usage.

NEGATIVE

public static final ExpectedCorrelation NEGATIVE

For an extra predictor expected to have a negative correlation with energy usage i.e. larger extra-predictor figures lead to smaller energy usage.

POSITIVE_OR_NEGATIVE

public static final ExpectedCorrelation POSITIVE_OR_NEGATIVE

For an extra predictor that could be expected to have either a positive or negative correlation with energy usage. You could look at this as an "I don't know what to expect" option. If possible, it's better to figure out what each extra predictor is and what you expect from it, but this option can be useful if your system is dealing with data it doesn't have much context on.

Method Detail

values

public static ExpectedCorrelation[] 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 (ExpectedCorrelation c : ExpectedCorrelation.values())
    System.out.println(c);

Returns:

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

valueOf

public static ExpectedCorrelation 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 object in the format required to specify an ExpectedCorrelation in the request XML ("Positive", "Negative", or "PositiveOrNegative").

Overrides:

toString in class java.lang.Enum<ExpectedCorrelation>

fromString

public static ExpectedCorrelation fromString(java.lang.String string)

Returns the non-null ExpectedCorrelation 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 "Positive", "Negative", or "PositiveOrNegative".