uk.ac.ed.epcc.webapp.jdbc.table

Class OptionalIndexInput<I>

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.jdbc.table.OptionalIndexInput<I>

Type Parameters:

I -

All Implemented Interfaces:

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

public class OptionalIndexInput<I>
extends ParseAbstractInput<java.lang.String>
implements ListInput<java.lang.String,I>

Select a field from an option map that does not already exist in a Repository. The Value of this input is the field name. This is also an ItemInput and will return the corresponding element from the option map as the Item.

Field Summary

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

validators

Constructor Summary

Constructors

Constructor and Description
OptionalIndexInput(Repository res, java.util.Map<java.lang.String,I> options)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
int	getCount() get the number of suggested items.
I	getItem() get the domain Object associated with the current value
I	getItembyValue(java.lang.String value) get the domain object from the Input value if defined
java.util.Iterator<I>	getItems() get a list of domain objects that are being selected
java.lang.String	getTagByItem(I 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(I item) get the user presented text from the domain object may return null if not selected
boolean	isValid(I item) Test if an object of the Item type is one of the possible items.
java.lang.String	parseValue(java.lang.String v) Parse a String into the correct type for this input.
void	setItem(I 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, convert, getKey, getPrettyString, getString, 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, convert, getKey, getPrettyString, getString, getValue, isEmpty, removeValidator, setKey, setValue, validate

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

getString, parse

Constructor Detail

OptionalIndexInput

public OptionalIndexInput(Repository res,
                          java.util.Map<java.lang.String,I> options)

Method Detail

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

getItem

public I getItem()

Description copied from interface: ItemInput

get the domain Object associated with the current value

Specified by:

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

Returns:

Object

setItem

public void setItem(I item)

Description copied from interface: ItemInput

Set the value of the input using an item

Specified by:

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

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

getItembyValue

public I 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,I>

Parameters:

value - input Value

Returns:

Object the domain object or null

getItems

public java.util.Iterator<I> 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,I>

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

Returns:

int

getTagByItem

public java.lang.String getTagByItem(I item)

Description copied from interface: ListInput

get an identifying tag string from the domain object

Specified by:

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

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

Returns:

String tag

getText

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

Returns:

String user text

isValid

public boolean isValid(I 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,I>

Returns:

boolean