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

Class CodeListInput<O>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.inputs.BaseInput<java.lang.String>

uk.ac.ed.epcc.webapp.forms.inputs.CodeListInput<O>

Type Parameters:

O - type of item

All Implemented Interfaces:

Input<java.lang.String>, ItemInput<java.lang.String,O>, ListInput<java.lang.String,O>, NameInput<O>, SuggestedItemInput<java.lang.String,O>

Direct Known Subclasses:

ClassificationFactory.ClassificationCodeListInput

public abstract class CodeListInput<O>
extends BaseInput<java.lang.String>
implements ListInput<java.lang.String,O>, NameInput<O>

Abstract class to implement ListInput where we want the input to generate a String code for each item.

Field Summary

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

validators

Constructor Summary

Constructors

Constructor and Description
CodeListInput()

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
java.lang.String	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
O	getItem() get the domain Object associated with the current value
java.lang.String	getPrettyString(java.lang.String value) Convert a value into a user friendly string.
java.lang.String	getString(java.lang.String value) get a String representation of an Object that is compatible with the way the input is parsed
java.lang.String	getTagByValue(java.lang.String value) get the tag string from the actual value of the input
java.lang.String	getValue() get the current value of the Object created by this selector.
void	setItem(O item) Set the value of the input using an item
java.lang.String	setValue(java.lang.String v) set the value of this selector.

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

addValidator, getKey, getString, removeValidator, setKey, 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.ListInput

getTagByItem, getText, isValid

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

getCount, getItems

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

getItembyValue

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

addValidator, getKey, isEmpty, removeValidator, setKey, validate

Constructor Detail

CodeListInput

public CodeListInput()

Method Detail

getTagByValue

public java.lang.String getTagByValue(java.lang.String 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.String,O>

Returns:

String tag

convert

public java.lang.String 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.String>

Overrides:

convert in class BaseInput<java.lang.String>

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getPrettyString

public java.lang.String getPrettyString(java.lang.String value)

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.String>

Overrides:

getPrettyString in class BaseInput<java.lang.String>

Returns:

String

See Also:

ListInput

getString

public java.lang.String getString(java.lang.String value)

Description copied from class: BaseInput

get a String representation of an Object that is compatible with the way the input is parsed

Specified by:

getString in interface Input<java.lang.String>

Overrides:

getString in class BaseInput<java.lang.String>

Returns:

String or null if val is null

See Also:

ParseInput

getValue

public java.lang.String getValue()

Description copied from interface: Input

get the current value of the Object created by this selector.

Specified by:

getValue in interface Input<java.lang.String>

Returns:

Object value of this selector

setValue

public java.lang.String setValue(java.lang.String v)
                          throws TypeError

Description copied from interface: Input

set the value of this selector. This is either called by the Form to specify a default value or by the edit methods in the sub-class implementation.

Specified by:

setValue in interface Input<java.lang.String>

Returns:

previous value Object

Throws:

TypeError

getItem

public O getItem()

Description copied from interface: ItemInput

get the domain Object associated with the current value

Specified by:

getItem in interface ItemInput<java.lang.String,O>

Returns:

Object

setItem

public void setItem(O item)

Description copied from interface: ItemInput

Set the value of the input using an item

Specified by:

setItem in interface ItemInput<java.lang.String,O>

accept

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

Specified by:

accept in interface Input<java.lang.String>

Throws:

java.lang.Exception