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

Class DataObjectFactory.AbstractDataObjectInput

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<N>

uk.ac.ed.epcc.webapp.forms.inputs.NumberInput<java.lang.Integer>

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

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectIntegerInput

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.AbstractDataObjectInput

All Implemented Interfaces:

BoundedInput<java.lang.Integer>, HTML5Input, Input<java.lang.Integer>, ItemInput<java.lang.Integer,BDO>, LengthInput<java.lang.Integer>, ListInput<java.lang.Integer,BDO>, ParseInput<java.lang.Integer>, PreSelectInput<java.lang.Integer,BDO>, RangedInput<java.lang.Integer>, SuggestedItemInput<java.lang.Integer,BDO>, UnitInput, DataObjectItemInput<BDO>

Direct Known Subclasses:

DataObjectFactory.DataObjectInput

Enclosing class:

DataObjectFactory<BDO extends DataObject>

public abstract class DataObjectFactory.AbstractDataObjectInput
extends DataObjectFactory.DataObjectIntegerInput
implements PreSelectInput<java.lang.Integer,BDO>

A form Input used to select objects produced by the owning factory.

Field Summary

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

nf

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

validators

Constructor Summary

Constructors

Constructor and Description
AbstractDataObjectInput(BaseFilter<BDO> f)
AbstractDataObjectInput(BaseFilter<BDO> f, boolean restrict_parse)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
boolean	allowPreSelect()
int	getCount() get the number of suggested items.
BDO	getItembyValue(java.lang.Integer id) get the domain object from the Input value if defined
java.util.Iterator<BDO>	getItems() get a list of domain objects that are being selected
Labeller<? super BDO,java.lang.String>	getLabeller()
protected abstract BaseFilter<BDO>	getMatchFilter(int value) The filter that selects records by input id
int	getMaxIdentifier()
java.lang.String	getPrettyString(java.lang.Integer val) Convert a value into a user friendly string.
java.lang.String	getTagByItem(BDO item) get an identifying tag string from the domain object
java.lang.String	getTagByValue(java.lang.Integer id) get the tag string from the actual value of the input
java.lang.String	getText(BDO obj) get the user presented text from the domain object may return null if not selected
abstract java.lang.Integer	getValueFromItem(BDO item) get the Value from an Item
boolean	isValid(BDO item) Test if an object of the Item type is one of the possible items.
void	setLabeller(Labeller<? super BDO,java.lang.String> labeller)
void	setMaxIdentifier(int max_identifier)
void	setPreSelect(boolean value)

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory.DataObjectIntegerInput

convert, parse, setItem

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

getString, parseValue

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

formatRange, getMax, getMin, getStep, getType, getUnit, setMax, setMin, setNumberFormat, setStep, setUnit

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, getKey, 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.ItemInput

getItem, setItem

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

addValidator, convert, getKey, getString, getValue, isEmpty, removeValidator, setKey, setValue, validate

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

getString

Constructor Detail

AbstractDataObjectInput

public AbstractDataObjectInput(BaseFilter<BDO> f)

AbstractDataObjectInput

public AbstractDataObjectInput(BaseFilter<BDO> f,
                               boolean restrict_parse)

Method Detail

getItembyValue

public BDO getItembyValue(java.lang.Integer id)

Description copied from interface: ItemInput

get the domain object from the Input value if defined

Specified by:

getItembyValue in interface ItemInput<java.lang.Integer,BDO extends DataObject>

Overrides:

getItembyValue in class DataObjectFactory.DataObjectIntegerInput

Parameters:

id - input Value

Returns:

Object the domain object or null

getPrettyString

public java.lang.String getPrettyString(java.lang.Integer val)

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

Overrides:

getPrettyString in class BaseInput<java.lang.Integer>

Returns:

String

See Also:

ListInput

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

Returns:

int

getItems

public java.util.Iterator<BDO> getItems()

Description copied from interface: SuggestedItemInput

get a list of domain objects that are being selected

Specified by:

getItems in interface SuggestedItemInput<java.lang.Integer,BDO extends DataObject>

Returns:

Iterator

getTagByValue

public java.lang.String getTagByValue(java.lang.Integer id)

Description copied from interface: ListInput

get the tag string from the actual value of the input

Specified by:

getTagByValue in interface ListInput<java.lang.Integer,BDO extends DataObject>

Returns:

String tag

getText

public java.lang.String getText(BDO obj)

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

Returns:

String user text

getValueFromItem

public abstract java.lang.Integer getValueFromItem(BDO item)

get the Value from an Item

Parameters:

item -

Returns:

getTagByItem

public java.lang.String getTagByItem(BDO item)

Description copied from interface: ListInput

get an identifying tag string from the domain object

Specified by:

getTagByItem in interface ListInput<java.lang.Integer,BDO extends DataObject>

Returns:

String tag

getMatchFilter

protected abstract BaseFilter<BDO> getMatchFilter(int value)

The filter that selects records by input id

Parameters:

value -

Returns:

accept

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

Specified by:

accept in interface Input<java.lang.Integer>

Overrides:

accept in class ParseAbstractInput<java.lang.Integer>

Throws:

java.lang.Exception

allowPreSelect

public boolean allowPreSelect()

Specified by:

allowPreSelect in interface PreSelectInput<java.lang.Integer,BDO extends DataObject>

setPreSelect

public void setPreSelect(boolean value)

Specified by:

setPreSelect in interface PreSelectInput<java.lang.Integer,BDO extends DataObject>

isValid

public boolean isValid(BDO 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.Integer,BDO extends DataObject>

Returns:

boolean

getMaxIdentifier

public int getMaxIdentifier()

setMaxIdentifier

public void setMaxIdentifier(int max_identifier)

getLabeller

public Labeller<? super BDO,java.lang.String> getLabeller()

setLabeller

public void setLabeller(Labeller<? super BDO,java.lang.String> labeller)