net.degreedays.api.regression

Enum PredictorType

java.lang.Object

java.lang.Enum<PredictorType>

net.degreedays.api.regression.PredictorType

All Implemented Interfaces:

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

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

Defines an extra predictor's figures as being cumulative (increasing with time and naturally larger over longer periods) or average (normalized such that the length of the period has no effect).

Since:

1.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE For an extra predictor that is normalized such that the length of the period has no effect e.g. an AVERAGE measure of occupancy could be the percentage of full occupancy.
CUMULATIVE For an extra predictor that increases with time and is naturally larger over longer periods e.g. a CUMULATIVE measure of occupancy could be the total person-hours worked.

Method Summary

Modifier and Type	Method and Description
static PredictorType	fromString(java.lang.String string) Returns the non-null PredictorType 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 PredictorType in the request XML ("Cumulative" or "Average").
static PredictorType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PredictorType[]	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

CUMULATIVE

public static final PredictorType CUMULATIVE

For an extra predictor that increases with time and is naturally larger over longer periods e.g. a CUMULATIVE measure of occupancy could be the total person-hours worked. If a typical day saw 110 person hours, a typical 5-day week might see 770 person hours (i.e. larger figures for longer periods).

AVERAGE

public static final PredictorType AVERAGE

For an extra predictor that is normalized such that the length of the period has no effect e.g. an AVERAGE measure of occupancy could be the percentage of full occupancy. A building could be 50% occupied for a week, or a month, or a year – longer periods would not mean larger figures.

Method Detail

values

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

Returns:

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

valueOf

public static PredictorType 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 PredictorType in the request XML ("Cumulative" or "Average").

Overrides:

toString in class java.lang.Enum<PredictorType>

fromString

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

Returns the non-null PredictorType 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 "Cumulative" or "Average".