uk.ac.ed.epcc.webapp.forms.inputs

Class EnumIntegerInput<E extends java.lang.Enum<E>>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.inputs.BaseInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.ParseAbstractInput<N>

uk.ac.ed.epcc.webapp.forms.inputs.NumberInput<java.lang.Integer>

uk.ac.ed.epcc.webapp.forms.inputs.IntegerInput

uk.ac.ed.epcc.webapp.forms.inputs.EnumIntegerInput<E>

Type Parameters:

E - Type of Enum to use

All Implemented Interfaces:

BoundedInput<java.lang.Integer>, HTML5Input, Input<java.lang.Integer>, ItemInput<java.lang.Integer,E>, LengthInput<java.lang.Integer>, ListInput<java.lang.Integer,E>, ParseInput<java.lang.Integer>, RangedInput<java.lang.Integer>, SuggestedItemInput<java.lang.Integer,E>, UnitInput

public class EnumIntegerInput<E extends java.lang.Enum<E>>
extends IntegerInput
implements ListInput<java.lang.Integer,E>

Input to select values from a Java Enum the DB will contain the Enum ordinal and the menu the result of the toString call.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.forms.inputs.NumberInput

nf

Fields inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

validators

Constructor Summary

Constructors

Constructor and Description
EnumIntegerInput(java.lang.Class<E> clazz)
EnumIntegerInput(java.util.EnumSet<E> set)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
java.lang.Integer	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
int	getCount() get the number of suggested items.
E	getItem() get the domain Object associated with the current value
E	getItembyValue(java.lang.Integer value) get the domain object from the Input value if defined
java.util.Iterator<E>	getItems() get a list of domain objects that are being selected
java.lang.String	getPrettyString(java.lang.Integer val) Convert a value into a user friendly string.
java.lang.String	getTagByItem(E item) get an identifying tag string from the domain object
java.lang.String	getTagByValue(java.lang.Integer value) get the tag string from the actual value of the input
java.lang.String	getText(E item) get the user presented text from the domain object may return null if not selected
protected int	getValue(E e) Method to generate the integer value of an enum.
boolean	isValid(E item) Test if an object of the Item type is one of the possible items.
void	setItem(E v) Set the value of the input using an item

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.IntegerInput

getString, parseValue

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.NumberInput

formatRange, getMax, getMin, getStep, getType, getUnit, setMax, setMin, setNumberFormat, setStep, setUnit

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.ParseAbstractInput

getBoxWidth, getMaxResultLength, getSingle, setBoxWidth, setMaxResultLength, setSingle

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput

getValue, setKey, setValue

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

addValidator, getKey, getString, removeValidator, validate, validateInner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.Input

addValidator, getKey, getString, getValue, isEmpty, removeValidator, setKey, setValue, validate

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.ParseInput

getString, parse

Constructor Detail

EnumIntegerInput

public EnumIntegerInput(java.util.EnumSet<E> set)

EnumIntegerInput

public EnumIntegerInput(java.lang.Class<E> clazz)

Method Detail

getValue

protected int getValue(E e)

Method to generate the integer value of an enum. Defaults to using Enum.ordinal() but can be overridden if a the Enum type can generate a custom value.

Parameters:

e -

Returns:

getItembyValue

public E getItembyValue(java.lang.Integer value)

Description copied from interface: ItemInput

get the domain object from the Input value if defined

Specified by:

getItembyValue in interface ItemInput<java.lang.Integer,E extends java.lang.Enum<E>>

Parameters:

value - input Value

Returns:

Object the domain object or null

getItems

public java.util.Iterator<E> getItems()

Description copied from interface: SuggestedItemInput

get a list of domain objects that are being selected

Specified by:

getItems in interface SuggestedItemInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

Iterator

getCount

public int getCount()

Description copied from interface: SuggestedItemInput

get the number of suggested items. null selections don't count.

Specified by:

getCount in interface SuggestedItemInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

int

getTagByItem

public java.lang.String getTagByItem(E item)

Description copied from interface: ListInput

get an identifying tag string from the domain object

Specified by:

getTagByItem in interface ListInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

String tag

getTagByValue

public java.lang.String getTagByValue(java.lang.Integer value)

Description copied from interface: ListInput

get the tag string from the actual value of the input

Specified by:

getTagByValue in interface ListInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

String tag

getText

public java.lang.String getText(E item)

Description copied from interface: ListInput

get the user presented text from the domain object may return null if not selected

Specified by:

getText in interface ListInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

String user text

getItem

public E getItem()

Description copied from interface: ItemInput

get the domain Object associated with the current value

Specified by:

getItem in interface ItemInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

Object

setItem

public void setItem(E v)

Description copied from interface: ItemInput

Set the value of the input using an item

Specified by:

setItem in interface ItemInput<java.lang.Integer,E extends java.lang.Enum<E>>

getPrettyString

public java.lang.String getPrettyString(java.lang.Integer val)

Description copied from interface: Input

Convert a value into a user friendly string. This usually defaults to the same as getString but can be overridden to produce nicer output

Specified by:

getPrettyString in interface Input<java.lang.Integer>

Overrides:

getPrettyString in class BaseInput<java.lang.Integer>

Returns:

String

See Also:

ListInput

convert

public java.lang.Integer convert(java.lang.Object v)
                          throws TypeError

Description copied from interface: Input

Perform any supported type conversions to to generate a value of the target type

Specified by:

convert in interface Input<java.lang.Integer>

Overrides:

convert in class IntegerInput

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

accept

public <R> R accept(InputVisitor<R> vis)
             throws java.lang.Exception

Specified by:

accept in interface Input<java.lang.Integer>

Overrides:

accept in class ParseAbstractInput<java.lang.Integer>

Throws:

java.lang.Exception

isValid

public boolean isValid(E item)

Description copied from interface: ListInput

Test if an object of the Item type is one of the possible items.

Specified by:

isValid in interface ListInput<java.lang.Integer,E extends java.lang.Enum<E>>

Returns:

boolean