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

Class ConstructedObjectInput<T>

java.lang.Object

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

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

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

Type Parameters:

T -

All Implemented Interfaces:

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

public class ConstructedObjectInput<T>
extends AbstractInput<java.lang.String>
implements ListInput<java.lang.String,T>

Input to select a objects dynamically constructed from the configuration service This defaults to the set of class. definitions AppContext.makeObject(Class, String) The target object is further constrained to be assignable to a specific type. For security reasons its important that this class cannot be forced to generate a class other than than those specified.

Field Summary

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

validators

Constructor Summary

Constructors

Constructor and Description
ConstructedObjectInput(AppContext c, java.lang.Class<T> target) Construct input for all dynamically created types assignable to target
ConstructedObjectInput(AppContext c, java.lang.Class<T> target, java.util.Map<java.lang.String,java.lang.Class> map) Constructor for filtered values.

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
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	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	isValid(T item) Test if an object of the Item type is one of the possible items.
void	setItem(T item) Set the value of the input using an item

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

Constructor Detail

ConstructedObjectInput

public ConstructedObjectInput(AppContext c,
                              java.lang.Class<T> target)

Construct input for all dynamically created types assignable to target

Parameters:

c -

target -

ConstructedObjectInput

public ConstructedObjectInput(AppContext c,
                              java.lang.Class<T> target,
                              java.util.Map<java.lang.String,java.lang.Class> map)

Constructor for filtered values. map should be a sub-map of that returned by AppContext.getClassMap(Class)

Parameters:

c -

target -

map -

Method Detail

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

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

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

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>

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

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