hirondelle.predict.main.codes
Enum CodeTable

Object
  Enum<CodeTable>
      hirondelle.predict.main.codes.CodeTable

All Implemented Interfaces:

Serializable, Comparable<CodeTable>

public enum CodeTable
extends Enum<CodeTable>

All code tables used in this application. (This implementation has only a single code table, but most applications will have many code tables.)

See package summary for important information.

Enum Constant Summary

OUTCOMES
End outcome of a prediction.

Method Summary

static Code	codeFor(Id aCodeId, CodeTable aCodeTable) Return a fully populated Code, given its Id and CodeTable.
Id	getTableName() Return the name of the code table.
Boolean	hasExplicitOrderColumn() Return true only if this code table has an explicit ordering.
static CodeTable	valueOf(String name) Returns the enum constant of this type with the specified name.
static CodeTable[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class Enum

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

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OUTCOMES

public static final CodeTable OUTCOMES

End outcome of a prediction. For this item, getTableName() returns: 'outcome'.

A score out of 100 is attached to each outcome :

• Right - 100
• Mostly Right - 75
• Half Right - 50
• Mostly Wrong - 25
• Wrong - 0
• Undecidable - Unknown

Method Detail

values

public static final CodeTable[] values()

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

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

Returns:

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

valueOf

public static CodeTable valueOf(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:

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

getTableName

public Id getTableName()

Return the name of the code table. This name is used as the key for the corresponding List<Code> placed in application scope.

hasExplicitOrderColumn

public Boolean hasExplicitOrderColumn()

Return true only if this code table has an explicit ordering. If there is an explicit order, it is usually related to a database column defined for that purpose.

codeFor

public static Code codeFor(Id aCodeId,
                           CodeTable aCodeTable)

Return a fully populated Code, given its Id and CodeTable.

Called from Model Object constructors that wish to translate a simple Id for a known code table into a fully populated Code, complete with user-presentable text. See CodeTableUtil for more information.