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

Class DataObjectFormFactory<BDO extends DataObject>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFormFactory<BDO>

Type Parameters:

BDO -

All Implemented Interfaces:

FormFactory, TypeConverter<BDO,java.lang.Number>, IndexedProducer<BDO>, Targetted<BDO>

Direct Known Subclasses:

CreateTransition, Creator, DataObjectUpdateFormFactory

public abstract class DataObjectFormFactory<BDO extends DataObject>
extends java.lang.Object
implements FormFactory, IndexedProducer<BDO>

Base class for Forms based on DataObject fields such as create/update forms. This class is intended to hold code common to both create and update forms which can customise their behaviour by overriding the various methods. This class implements default implementations for a target class by calling the equivalent methods in the Factory. However sub-classes can customise further.

The class implements IndexedProducer by forwarding onto the nested factory. This allows custom from factories to be installed in IndexedFormEntrys to produce specialised creation forms that add entries to an existing factory.

Note that if FieldConstraints are defined form building may return early (returning false from the buildForm methods) indicating that multi-stage forms are being used. The customise methods are usually still called so these (or any validators they add) may need to be tolerant about missing fields when using FieldConstraints

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	DEFAULT_FORBID_HTML
protected DataObjectFactory<BDO>	factory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataObjectFormFactory(DataObjectFactory<BDO> fac)

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<java.lang.String>	addOptionalFromComposites(java.util.Set<java.lang.String> optional)
static java.util.Map<java.lang.String,Selector>	addSelectors(AppContext conn, java.util.Map<java.lang.String,Selector> sel, Repository res) Add a set of selectors based on the tables referenced by field keys
static java.util.Map<java.lang.String,java.lang.String>	addTranslations(AppContext conn, java.util.Map<java.lang.String,java.lang.String> trans, Repository res) Add default translations for reference fields using the table name in preference to the field name.
static boolean	buildForm(AppContext conn, Repository res, Form f, java.util.Set<java.lang.String> supress_fields, java.util.Set<java.lang.String> optional, java.util.Map<java.lang.String,Selector> selectors, java.util.Map<java.lang.String,java.lang.String> labels)
static boolean	buildForm(AppContext conn, Repository res, Form f, java.util.Set<java.lang.String> supress_fields, java.util.Set<java.lang.String> optional, java.util.Map<java.lang.String,Selector> selectors, java.util.Map<java.lang.String,java.lang.String> labels, java.util.Map<java.lang.String,java.lang.String> tooltips) Construct an edit Form for the associated DataObject based on database meta-data
static boolean	buildForm(AppContext conn, Repository res, java.util.Set<java.lang.String> keys, Form f, java.util.Set<java.lang.String> optional, java.util.Map<java.lang.String,Selector> selectors, java.util.Map<java.lang.String,FieldConstraint> constraints, java.util.Map<java.lang.String,java.lang.String> labels, java.util.Map<java.lang.String,java.lang.String> tooltips, java.util.HashMap fixtures) Construct an edit Form for the associated DataObject based on database meta-data
boolean	buildForm(Form f) builds a default Form for editing the DataObjects belonging to this DataObjectFactory The state of the Form is initialised using getDefaults
boolean	buildForm(Form f, java.util.HashMap fixtures)
void	customiseForm(Form f) Extension hook to allow additional Form customisation generic to all types of Form For example adding a FormValidator or adding min, max values to NumberInputs.
BDO	find(int id)
BDO	find(java.lang.Number o) Find the required object.
AppContext	getContext()
java.util.Map<java.lang.String,java.lang.Object>	getDefaults() Get a set of default values for the form fields
DataObjectFactory<BDO>	getFactory()
protected java.util.Map<java.lang.String,FieldConstraint>	getFieldConstraints() get FieldConstraints to apply when building the form
protected java.util.Map<java.lang.String,java.lang.String>	getFieldHelp() create additional tooltip help text for form fields.
protected java.util.Set<java.lang.String>	getFields()
java.lang.String	getID(BDO obj) Generate the default text identifier of the client object for contexts where the type is unambiguous.
java.lang.Number	getIndex(BDO value) Get the underlying data representation corresponding to the value
static Input<?>	getInputFromName(AppContext conn, java.lang.String table, java.lang.String name)
static Input<?>	getInputFromType(AppContext conn, Repository res, Repository.FieldInfo info)
protected Logger	getLogger()
protected java.util.Set<java.lang.String>	getOptional() Generate the set of optional fields to be used in form creation/update default behaviour is to take the set defined by the factory (or if this is null fields that can be null in the database) modified by the Composite classes.
protected java.util.Map<java.lang.String,Selector>	getSelectors() Get a Map of selectors to use for forms of this type.
protected java.util.Set<java.lang.String>	getSupress() generate the set of suppressed fields to be used in form creation/update
java.lang.Class<BDO>	getTarget() Get a class object that all results of the producer are assignable to.
protected java.util.Map<java.lang.String,java.lang.String>	getTranslations() return a default set of translation between field names and text labels.
boolean	isMyReference(IndexedReference ref) Test if an IndexedReference belongs to this producer.
IndexedReference<BDO>	makeReference(BDO obj) Make a IndexedReference from a target object
IndexedReference<BDO>	makeReference(int id) Make and IndexedReferencce from an integer id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FORBID_HTML

public static final Feature DEFAULT_FORBID_HTML

factory

protected final DataObjectFactory<BDO extends DataObject> factory

Constructor Detail

DataObjectFormFactory

protected DataObjectFormFactory(DataObjectFactory<BDO> fac)

Method Detail

getContext

public final AppContext getContext()

Specified by:

getContext in interface FormFactory

getFactory

public final DataObjectFactory<BDO> getFactory()

getLogger

protected final Logger getLogger()

buildForm

public final boolean buildForm(Form f)
                        throws DataFault

builds a default Form for editing the DataObjects belonging to this DataObjectFactory The state of the Form is initialised using getDefaults

Parameters:

f - Form to build

Throws:

DataFault

TransitionException

buildForm

public final boolean buildForm(Form f,
                               java.util.HashMap fixtures)
                        throws DataFault

Throws:

DataFault

buildForm

public static final boolean buildForm(AppContext conn,
                                      Repository res,
                                      Form f,
                                      java.util.Set<java.lang.String> supress_fields,
                                      java.util.Set<java.lang.String> optional,
                                      java.util.Map<java.lang.String,Selector> selectors,
                                      java.util.Map<java.lang.String,java.lang.String> labels)
                               throws DataFault

Throws:

DataFault

buildForm

public static final boolean buildForm(AppContext conn,
                                      Repository res,
                                      Form f,
                                      java.util.Set<java.lang.String> supress_fields,
                                      java.util.Set<java.lang.String> optional,
                                      java.util.Map<java.lang.String,Selector> selectors,
                                      java.util.Map<java.lang.String,java.lang.String> labels,
                                      java.util.Map<java.lang.String,java.lang.String> tooltips)
                               throws DataFault

Construct an edit Form for the associated DataObject based on database meta-data

Parameters:

conn - AppContext

res - Repository to use as template

f - Form to build

supress_fields - Vector of fields to supress in the form

optional - Vector marking fields as optional

selectors - Map of selectors to use.

labels - Map of field names to form labels

Throws:

DataFault

TransitionException

buildForm

public static final boolean buildForm(AppContext conn,
                                      Repository res,
                                      java.util.Set<java.lang.String> keys,
                                      Form f,
                                      java.util.Set<java.lang.String> optional,
                                      java.util.Map<java.lang.String,Selector> selectors,
                                      java.util.Map<java.lang.String,FieldConstraint> constraints,
                                      java.util.Map<java.lang.String,java.lang.String> labels,
                                      java.util.Map<java.lang.String,java.lang.String> tooltips,
                                      java.util.HashMap fixtures)
                               throws DataFault

Construct an edit Form for the associated DataObject based on database meta-data

Parameters:

conn - AppContext

res - Repository to use as template

f - Form to build

supress_fields - Vector of fields to supress in the form

optional - Vector marking fields as optional

selectors - Map of selectors to use.

labels - Map of field names to form labels

tooltips - Map of tooltip/help text for form labels

Throws:

DataFault

TransitionException

getInputFromType

public static Input<?> getInputFromType(AppContext conn,
                                        Repository res,
                                        Repository.FieldInfo info)

getInputFromName

public static Input<?> getInputFromName(AppContext conn,
                                        java.lang.String table,
                                        java.lang.String name)

addSelectors

public static java.util.Map<java.lang.String,Selector> addSelectors(AppContext conn,
                                                                    java.util.Map<java.lang.String,Selector> sel,
                                                                    Repository res)

Add a set of selectors based on the tables referenced by field keys

Parameters:

conn -

sel -

res -

Returns:

modified map

addTranslations

public static java.util.Map<java.lang.String,java.lang.String> addTranslations(AppContext conn,
                                                                               java.util.Map<java.lang.String,java.lang.String> trans,
                                                                               Repository res)

Add default translations for reference fields using the table name in preference to the field name.

Parameters:

conn -

trans -

res -

Returns:

Map of translations

customiseForm

public void customiseForm(Form f)

Extension hook to allow additional Form customisation generic to all types of Form For example adding a FormValidator or adding min, max values to NumberInputs.

Parameters:

f - Form to modify

getSelectors

protected java.util.Map<java.lang.String,Selector> getSelectors()

Get a Map of selectors to use for forms of this type.

Returns:

Map

getSupress

protected java.util.Set<java.lang.String> getSupress()

generate the set of suppressed fields to be used in form creation/update

Returns:

Vector

getFields

protected java.util.Set<java.lang.String> getFields()

getTranslations

protected java.util.Map<java.lang.String,java.lang.String> getTranslations()

return a default set of translation between field names and text labels.

Returns:

Map

getFieldHelp

protected java.util.Map<java.lang.String,java.lang.String> getFieldHelp()

create additional tooltip help text for form fields.

Returns:

getOptional

protected java.util.Set<java.lang.String> getOptional()

Generate the set of optional fields to be used in form creation/update default behaviour is to take the set defined by the factory (or if this is null fields that can be null in the database) modified by the Composite classes. most classes will override with an explicit list of optional fields. If this method is overridden to return an empty set no fields are optional. If it is overridden to return null then fields tha can take null values are optional.

Returns:

Set of field names

addOptionalFromComposites

protected java.util.Set<java.lang.String> addOptionalFromComposites(java.util.Set<java.lang.String> optional)

Parameters:

optional -

Returns:

getDefaults

public java.util.Map<java.lang.String,java.lang.Object> getDefaults()

Get a set of default values for the form fields

Returns:

Map of defaults

getFieldConstraints

protected java.util.Map<java.lang.String,FieldConstraint> getFieldConstraints()

get FieldConstraints to apply when building the form

Returns:

find

public final BDO find(int id)
               throws DataException

Specified by:

find in interface IndexedProducer<BDO extends DataObject>

Throws:

DataException

getTarget

public final java.lang.Class<BDO> getTarget()

Description copied from interface: IndexedProducer

Get a class object that all results of the producer are assignable to. This is intended for run-time type checking so it should be as specific as possible

Specified by:

getTarget in interface IndexedProducer<BDO extends DataObject>

Specified by:

getTarget in interface Targetted<BDO extends DataObject>

Returns:

Class object for target

makeReference

public final IndexedReference<BDO> makeReference(BDO obj)

Description copied from interface: IndexedProducer

Make a IndexedReference from a target object

Specified by:

makeReference in interface IndexedProducer<BDO extends DataObject>

Returns:

IndexedReference

makeReference

public final IndexedReference<BDO> makeReference(int id)

Description copied from interface: IndexedProducer

Make and IndexedReferencce from an integer id.

Specified by:

makeReference in interface IndexedProducer<BDO extends DataObject>

Returns:

IndexedReference

isMyReference

public final boolean isMyReference(IndexedReference ref)

Description copied from interface: IndexedProducer

Test if an IndexedReference belongs to this producer. This returns false for any null reference.

Specified by:

isMyReference in interface IndexedProducer<BDO extends DataObject>

Returns:

boolean

getID

public final java.lang.String getID(BDO obj)

Description copied from interface: IndexedProducer

Generate the default text identifier of the client object for contexts where the type is unambiguous. This is used in urls and html inputs. Normally this should generate the String representation of the integer id. if it generates anything else the IndexedProducer should implement ParseFactory to be able to parse the alternative form.

Specified by:

getID in interface IndexedProducer<BDO extends DataObject>

Returns:

find

public final BDO find(java.lang.Number o)

Description copied from interface: TypeConverter

Find the required object.

Specified by:

find in interface TypeConverter<BDO extends DataObject,java.lang.Number>

Parameters:

o - Value of the database field

Returns:

Target value or null if invalid

getIndex

public final java.lang.Number getIndex(BDO value)

Description copied from interface: TypeConverter

Get the underlying data representation corresponding to the value

Specified by:

getIndex in interface TypeConverter<BDO extends DataObject,java.lang.Number>

Returns:

Field value or null if invalid