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

Interface Input<V>

Type Parameters:

V - class of object Input generates

All Known Subinterfaces:

AutoComplete<T,V>, BinaryInput<I>, BoundedDateInput, BoundedInput<T>, DataObjectItemInput<I>, DataObjectItemParseInput<I>, ItemInput<V,T>, LengthInput<T>, ListInput<V,T>, NameInput<T>, OptionalListInput<V,T>, ParseInput<T>, PreSelectInput<V,T>, RangedInput<N>, SuggestedItemInput<V,T>

All Known Implementing Classes:

AbstractCalendarMultiInput, AbstractDateInput, AbstractInput, AlternateInput, AlternateItemInput, AppUserFactory.AppUserNameInput, AutocompleteTextInput, BaseInput, BasicTypeInput, BooleanInput, CalendarFieldInput, CalendarFieldPeriodInput, CalendarMonthInput, CalendarMultiInputWrapper, CheckBoxInput, ClassificationFactory.ClassificationCodeListInput, ClassificationFactory.NameItemInput, ClassInput, CodeListInput, CompositeInput, ConstantInput, ConstructedObjectInput, DataObjectAlternateInput, DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.SortingDataObjectInput, DateInput, DayMultiInput, DNInput, DoubleInput, DurationInput, ElapsedSecondInput, EmailInput, EmailListInput, EnumInput, EnumIntegerInput, ErrorInput, FileInput, FileUploadDecorator, FormattedInput, ImageInput, InfoInput, IntegerInput, IntegerRangeInput, IntegerSetInput, LinkManager.LinkInput, ListInputWrapper, LockedInput, LongInput, MimeFileInput, MonthInput, MonthMultiInput, MultiInput, MultiIntegerHandler.MultiIntegerInput, NameFinderInput, NewFieldInput, NewTableInput, NodeInput, NoHtmlInput, NullListInput, NumberInput, ObjectListInput, OnOffInput, OptionalFieldInput, OptionalIndexInput, OptionalListInputWrapper, ParseAbstractInput, ParseMultiInput, PartManager.UnusedNameInput, PasswordInput, PatternTextInput, PercentInput, PhoneInput, RadioButtonInput, RangeDateInput, RealInput, RegexpInput, RegularPeriodInput, RelativeDateInput, RepositoryFieldInput, RepositoryForeignKeyInput, RepositoryIndexInput, RoleNameInput, RsaPublicKeyArrayInput, RsaPublicKeyInput, SetInput, SetTextInput, SimpleKeyInput, SimplePeriodInput, SshPublicKeyArrayInput, SshPublicKeyInput, StorageUnitNumberInput, StorageUnitTextInput, StringListInput, TableInput, TextInput, TimeStampInput, TimeStampMultiInput, TypeProducerInput, UnusedNameInput, URLInput, WrappedInput, WrappingInput, XMLDocumentInput

public interface Input<V>

Input represents a input box/pulldown etc for a form. It has internal state holding the Object representing its current value. A Input is used to get the Value of an Object from the user. Each Input also has an identifying key that should be unique within the form. This can be used to produce parameter names etc. Selectors may be composite, for example a date selector constructed from pull-downs for year, month and day. The Input classes are kept generic to all different types of Form. The Form class has to implement the different types of edit operation depending on the kind of selector. This allows us to use inheritance between different types of Input. If we sub-classed Inputs by Form type each new Input type would need to be sub-classed for every Form type. Where we subclass an Input by type there is a reasonable chance that the inherited edit code will be sufficient and not need re-implementing For example most Inputs can share text-box edit code from a common superclass.

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
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(V value) convert a value of the correct type for this input into a String.
V	getValue() get the current value of the Object created by this selector.
default boolean	isEmpty() Is the input empty.
void	removeValidator(FieldValidator<V> val) Remove a FieldValidator from this input
void	setKey(java.lang.String key) Set the key used by this Selector
V	setValue(V v) set the value of this selector.
void	validate() Check the validity of the current state of the Object.

Method Detail

getKey

java.lang.String getKey()

get the unique key for this selector

Returns:

Object key for this Selector

getValue

V getValue()

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

Returns:

Object value of this selector

setKey

void setKey(java.lang.String key)

Set the key used by this Selector

Parameters:

key -

setValue

V setValue(V v)
    throws TypeError

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.

Parameters:

v -

Returns:

previous value Object

Throws:

TypeError

convert

V convert(java.lang.Object v)
   throws TypeError

Perform any supported type conversions to to generate a value of the target type

Parameters:

v - Object input

Returns:

target type

Throws:

TypeError

getString

java.lang.String getString(V value)

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.

Parameters:

value -

Returns:

String or null if value is null

See Also:

ParseInput

getPrettyString

java.lang.String getPrettyString(V value)

Convert a value into a user friendly string. This usually defaults to the same as getString but can be overridden to produce nicer output

Parameters:

value -

Returns:

String

See Also:

ListInput

validate

void validate()
       throws FieldException

Check the validity of the current state of the Object.

Throws:

FieldException

accept

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

Throws:

java.lang.Exception

isEmpty

default boolean isEmpty()

Is the input empty. empty inputs are reported as errors for non-optional fields. Additional validation is not performed if the input is empty.

Returns:

addValidator

void addValidator(FieldValidator<V> val)

Add a FieldValidator to this input

Parameters:

val -

removeValidator

void removeValidator(FieldValidator<V> val)

Remove a FieldValidator from this input

Parameters:

val -