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

Class RadioButtonInput<V,T>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.inputs.RadioButtonInput<V,T>

Type Parameters:

V - type of value

T - type of item

All Implemented Interfaces:

Input<V>, ItemInput<V,T>, ListInput<V,T>, ParseInput<V>, SuggestedItemInput<V,T>

public class RadioButtonInput<V,T>
extends java.lang.Object
implements ListInput<V,T>, ParseInput<V>

Wrapper class to convert a ListInput to be displayed as a RadioButton. The input is assumed not to be optional. Note that this class implements ParseInput. If the nested input does not also implement this interface then the convert(Object) method needs to be able to convert the String representation of the value.

Constructor Summary

Constructors

Constructor and Description
RadioButtonInput(ListInput<V,T> in) Construct a RadioButtonInput defaulting to the first selectable item unless there is already one set in the ListInput
RadioButtonInput(ListInput<V,T> in, T default_sel) Construct a RadioButtonInput with a specified default (can be null).

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
void	addValidator(FieldValidator<V> val) Add a FieldValidator to this input
V	convert(java.lang.Object v) Perform any supported type conversions to to generate a value of the target type
boolean	equals(java.lang.Object obj)
int	getCount() get the number of suggested items.
T	getItem() get the domain Object associated with the current value
T	getItembyValue(V 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	getKey() get the unique key for this selector
java.lang.String	getPrettyString(V value) Convert a value into a user friendly string.
java.lang.String	getString() get a String representation of the value in a form that is compatible with the way the input is parsed.
java.lang.String	getString(V value) convert a value of the correct type for this input into a String.
java.lang.String	getTagByItem(T item) get an identifying tag string from the domain object
java.lang.String	getTagByValue(V 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
V	getValue() get the current value of the Object created by this selector.
int	hashCode()
boolean	isValid(T item) Test if an object of the Item type is one of the possible items.
V	parseValue(java.lang.String v) Parse a String into the correct type for this input.
void	removeValidator(FieldValidator<V> val) Remove a FieldValidator from this input
void	setItem(T item) Set the value of the input using an item
void	setKey(java.lang.String key) Set the key used by this Selector
V	setValue(V v) set the value of this selector.
java.lang.String	toString()
void	validate() Check the validity of the current state of the Object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isEmpty

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

parse

Constructor Detail

RadioButtonInput

public RadioButtonInput(ListInput<V,T> in)

Construct a RadioButtonInput defaulting to the first selectable item unless there is already one set in the ListInput

Parameters:

in -

RadioButtonInput

public RadioButtonInput(ListInput<V,T> in,
                        T default_sel)

Construct a RadioButtonInput with a specified default (can be null). If null is specified the existing item is kept, if there is no existing default first value from the ListInput is chosen

Parameters:

in -

default_sel -

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: Input

get the unique key for this selector

Specified by:

getKey in interface Input<V>

Returns:

Object key for this Selector

getValue

public V getValue()

Description copied from interface: Input

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

Specified by:

getValue in interface Input<V>

Returns:

Object value of this selector

setKey

public void setKey(java.lang.String key)

Description copied from interface: Input

Set the key used by this Selector

Specified by:

setKey in interface Input<V>

setValue

public V setValue(V 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<V>

Returns:

previous value Object

Throws:

TypeError

convert

public V 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<V>

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getString

public java.lang.String getString(V value)

Description copied from interface: Input

convert a value of the correct type for this input into a String. If this input is a parseInput this must be compatible with the way the input is parsed. To make testing easier equivalent values should convert to the same canonical form.

Specified by:

getString in interface Input<V>

Returns:

String or null if value is null

See Also:

ParseInput

getPrettyString

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

Returns:

String

See Also:

ListInput

validate

public void validate()
              throws FieldException

Description copied from interface: Input

Check the validity of the current state of the Object.

Specified by:

validate in interface Input<V>

Throws:

FieldException

accept

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

Specified by:

accept in interface Input<V>

Throws:

java.lang.Exception

getItem

public T getItem()

Description copied from interface: ItemInput

get the domain Object associated with the current value

Specified by:

getItem in interface ItemInput<V,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<V,T>

getItembyValue

public T getItembyValue(V value)

Description copied from interface: ItemInput

get the domain object from the Input value if defined

Specified by:

getItembyValue in interface ItemInput<V,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<V,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<V,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<V,T>

Returns:

String tag

getTagByValue

public java.lang.String getTagByValue(V value)

Description copied from interface: ListInput

get the tag string from the actual value of the input

Specified by:

getTagByValue in interface ListInput<V,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<V,T>

Returns:

String user text

getString

public java.lang.String getString()

Description copied from interface: ParseInput

get a String representation of the value in a form that is compatible with the way the input is parsed.

Specified by:

getString in interface ParseInput<V>

Returns:

String or null if no value

parseValue

public V 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<V>

Returns:

Throws:

ParseException

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

Returns:

boolean

addValidator

public void addValidator(FieldValidator<V> val)

Description copied from interface: Input

Add a FieldValidator to this input

Specified by:

addValidator in interface Input<V>

removeValidator

public void removeValidator(FieldValidator<V> val)

Description copied from interface: Input

Remove a FieldValidator from this input

Specified by:

removeValidator in interface Input<V>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object