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

Class NameFinderInput<T extends DataObject,F extends DataObjectFactory<T> & NameFinder<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.Integer>

uk.ac.ed.epcc.webapp.model.data.forms.inputs.NameFinderInput<T,F>

All Implemented Interfaces:

AutoComplete<T,java.lang.Integer>, Input<java.lang.Integer>, ItemInput<java.lang.Integer,T>, LengthInput<java.lang.Integer>, ParseInput<java.lang.Integer>, SuggestedItemInput<java.lang.Integer,T>, DataObjectItemInput<T>

Direct Known Subclasses:

AppUserFactory.AppUserNameInput

public class NameFinderInput<T extends DataObject,F extends DataObjectFactory<T> & NameFinder<T>>
extends ParseAbstractInput<java.lang.Integer>
implements AutoComplete<T,java.lang.Integer>, DataObjectItemInput<T>

An DataObjectItemInput for NameFinder factories. This is a text AutoComplete input using the permitted names optionally creating bootstrap entries

Field Summary

Fields

Modifier and Type	Field and Description
protected F	factory

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

validators

Constructor Summary

Constructors

Constructor and Description
NameFinderInput(F factory, boolean create, boolean restrict, BaseFilter<T> autocomplete) create input

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
AppContext	getContext()
T	getItembyValue(java.lang.Integer value) get the domain object from the Input value if defined
protected Logger	getLogger()
java.lang.String	getMatchError()
java.lang.String	getString(java.lang.Integer val) get a String representation of an Object that is compatible with the way the input is parsed
java.util.Set<T>	getSuggestions() Get the set of Items corresponding to a suggested values
java.lang.String	getSuggestionText(T item) get the suggestion text.
java.lang.String	getValue(T item) Map an item to the corresponding value (compatible with the parse method).
boolean	isCreate()
void	parse(java.lang.String v) Set the value of the input by parsing a textual representation of the input.
T	parseItem(java.lang.String v)
java.lang.Integer	parseValue(java.lang.String v) Parse a String into the correct type for this input.
void	setCreate(boolean create)
void	setItem(T item) Set the value of the input using an item
void	setMatchError(java.lang.String match_error)

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

accept, 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, getPrettyString, 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.AutoComplete

getCount, getItems

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

getItem

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

accept, addValidator, getKey, getPrettyString, getValue, isEmpty, removeValidator, setKey, setValue, validate

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

getString

Field Detail

factory

protected final F extends DataObjectFactory<T> & NameFinder<T> factory

Constructor Detail

NameFinderInput

public NameFinderInput(F factory,
                       boolean create,
                       boolean restrict,
                       BaseFilter<T> autocomplete)

create input

Parameters:

create - make entry if not found

restrict - restrict with filter

autocomplete - suggestions/restrict filter

factory - DataObjectFactory and NameFinder

Method Detail

parseItem

public T parseItem(java.lang.String v)
            throws ParseException

Throws:

ParseException

parse

public void parse(java.lang.String v)
           throws ParseException

Description copied from interface: ParseInput

Set the value of the input by parsing a textual representation of the input. Normally this defaults to using ParseInput.parseValue(String) and Input.setValue(Object) but it can be overridden for example if the natural parse mechanism generates an Item in an item input.

Specified by:

parse in interface ParseInput<java.lang.Integer>

Throws:

ParseException

parseValue

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

Returns:

Throws:

ParseException

getItembyValue

public T 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,T extends DataObject>

Parameters:

value - input Value

Returns:

Object the domain object or null

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.Integer,T extends DataObject>

getSuggestions

public java.util.Set<T> getSuggestions()

Description copied from interface: AutoComplete

Get the set of Items corresponding to a suggested values

Specified by:

getSuggestions in interface AutoComplete<T extends DataObject,java.lang.Integer>

Returns:

getContext

public AppContext getContext()

getLogger

protected Logger getLogger()

getValue

public java.lang.String getValue(T item)

Description copied from interface: AutoComplete

Map an item to the corresponding value (compatible with the parse method).

Specified by:

getValue in interface AutoComplete<T extends DataObject,java.lang.Integer>

Returns:

String value

getSuggestionText

public java.lang.String getSuggestionText(T item)

Description copied from interface: AutoComplete

get the suggestion text. This can be an expanded form of the value

Specified by:

getSuggestionText in interface AutoComplete<T extends DataObject,java.lang.Integer>

Returns:

getString

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

Overrides:

getString in class BaseInput<java.lang.Integer>

Returns:

String or null if val is null

See Also:

ParseInput

isCreate

public boolean isCreate()

Returns:

the create

setCreate

public void setCreate(boolean create)

Parameters:

create - the create to set

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 BaseInput<java.lang.Integer>

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getMatchError

public java.lang.String getMatchError()

setMatchError

public void setMatchError(java.lang.String match_error)