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

Class SetInput<T>

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

uk.ac.ed.epcc.webapp.forms.inputs.SetInput<T>

Type Parameters:

T - type of item

All Implemented Interfaces:

Input<java.lang.String>, ItemInput<java.lang.String,T>, LengthInput<java.lang.String>, ListInput<java.lang.String,T>, ParseInput<java.lang.String>, SuggestedItemInput<java.lang.String,T>

Direct Known Subclasses:

OnOffInput

public class SetInput<T>
extends ParseAbstractInput<java.lang.String>
implements ListInput<java.lang.String,T>

Simple ListInput that gives a choice of items (parsed and returned as their String representation) Optionally alternate string values/labels can be presented.

Field Summary

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

validators

Constructor Summary

Constructors

Constructor and Description
SetInput()
SetInput(java.util.Collection<T> items)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
void	addChoice(java.lang.String tag, java.lang.String label, T item) Add an item to the set.
void	addChoice(java.lang.String label, T item) Add an item using the same String value for both the label and the tab.
void	addChoice(T item) add an item to the set using default rules for tags and labels.
java.lang.String	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.
T	getItem() get the domain Object associated with the current value
T	getItembyValue(java.lang.String value) get the domain object from the Input value if defined
java.util.Iterator<T>	getItems() get a list of domain objects that are being selected
java.lang.String	getPrettyString(java.lang.String val) Convert a value into a user friendly string.
java.lang.String	getString(java.lang.String val) get a String representation of an Object that is compatible with the way the input is parsed
java.lang.String	getTagByItem(T item) get an identifying tag string from the domain object
java.lang.String	getTagByValue(java.lang.String value) get the tag string from the actual value of the input
java.lang.String	getText(T item) get the user presented text from the domain object may return null if not selected
boolean	isCaseInsensative()
boolean	isValid(T item) Test if an object of the Item type is one of the possible items.
java.lang.String	makeDefaultTag(T item)
java.lang.String	parseValue(java.lang.String v) Parse a String into the correct type for this input.
void	setCaseInsensative(boolean case_insensative)
void	setItem(T item) Set the value of the input using an item

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, getValue, isEmpty, removeValidator, setKey, setValue, validate

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

getString, parse

Constructor Detail

SetInput

public SetInput()

SetInput

public SetInput(java.util.Collection<T> items)

Method Detail

addChoice

public void addChoice(java.lang.String label,
                      T item)

Add an item using the same String value for both the label and the tab.

Parameters:

label - String value used as both value and label.

item - Item associated with the tag

addChoice

public void addChoice(java.lang.String tag,
                      java.lang.String label,
                      T item)

Add an item to the set. Arbitrary tags/labels can be associated with an item provided the tags are unique.

Parameters:

tag - key value generated by input

label - test presented to the user

item - item associated with key.

addChoice

public void addChoice(T item)

add an item to the set using default rules for tags and labels.

Parameters:

item -

getItembyValue

public T getItembyValue(java.lang.String value)

Description copied from interface: ItemInput

get the domain object from the Input value if defined

Specified by:

getItembyValue in interface ItemInput<java.lang.String,T>

Parameters:

value - input Value

Returns:

Object the domain object or null

getItems

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

Description copied from interface: SuggestedItemInput

get a list of domain objects that are being selected

Specified by:

getItems in interface SuggestedItemInput<java.lang.String,T>

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

Returns:

int

makeDefaultTag

public java.lang.String makeDefaultTag(T item)

getTagByItem

public java.lang.String getTagByItem(T item)

Description copied from interface: ListInput

get an identifying tag string from the domain object

Specified by:

getTagByItem in interface ListInput<java.lang.String,T>

Returns:

String tag

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,T>

Returns:

String tag

getText

public java.lang.String getText(T 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.String,T>

Returns:

String user text

getItem

public T getItem()

Description copied from interface: ItemInput

get the domain Object associated with the current value

Specified by:

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

Returns:

Object

setItem

public void setItem(T item)

Description copied from interface: ItemInput

Set the value of the input using an item

Specified by:

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

parseValue

public java.lang.String parseValue(java.lang.String v)
                            throws ParseException

Description copied from interface: ParseInput

Parse a String into the correct type for this input. This must be compatible with the Input.getString(Object) method.

Specified by:

parseValue in interface ParseInput<java.lang.String>

Returns:

Throws:

ParseException

accept

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

Specified by:

accept in interface Input<java.lang.String>

Overrides:

accept in class ParseAbstractInput<java.lang.String>

Throws:

java.lang.Exception

isValid

public boolean isValid(T 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.String,T>

Returns:

boolean

isCaseInsensative

public boolean isCaseInsensative()

Returns:

the case_insensative

setCaseInsensative

public void setCaseInsensative(boolean case_insensative)

Parameters:

case_insensative - the case_insensative to set

getString

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

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

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

Overrides:

getPrettyString in class BaseInput<java.lang.String>

Returns:

String

See Also:

ListInput