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

Class MultiComposite<BDO extends DataObject,X extends Composite<BDO,X>>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.Composite<BDO,X>

uk.ac.ed.epcc.webapp.model.data.MultiComposite<BDO,X>

All Implemented Interfaces:

Contexed, TableStructureContributer<BDO>

public abstract class MultiComposite<BDO extends DataObject,X extends Composite<BDO,X>>
extends Composite<BDO,X>

An abstract base class for a Composite that combines multiple Composites of the same type. Each nested Composite adds its own fields to the parent factory.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.Composite

fac

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	addDefaults(java.util.Map<java.lang.String,java.lang.Object> defaults) Generate a set of default property values.
java.util.Set<java.lang.String>	addOptional(java.util.Set<java.lang.String> optional) generate the set of optional fields to be used to provide class specific defaults in form creation/update.
java.util.Map<java.lang.String,Selector>	addSelectors(java.util.Map<java.lang.String,Selector> selectors) Get a Map of selectors to use for forms of this type.
java.util.Set<java.lang.String>	addSuppress(java.util.Set<java.lang.String> suppress) generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.
java.util.Map<java.lang.String,java.lang.String>	addTranslations(java.util.Map<java.lang.String,java.lang.String> translations) return a default set of translation between field names and text labels.
void	customiseForm(Form f) Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator .
abstract java.util.Collection<X>	getNested() get the collection of underlying composites
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
void	postUpdate(BDO o, Form f, java.util.Map<java.lang.String,java.lang.Object> orig, boolean changed) perform side effects after a formupdate

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

addFieldHelp, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, getType, preRegister, release, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.TableStructureContributer

addFieldConstraints, addFormFields

Constructor Detail

MultiComposite

protected MultiComposite(DataObjectFactory<BDO> fac)

Parameters:

fac -

Method Detail

getNested

public abstract java.util.Collection<X> getNested()

get the collection of underlying composites

Returns:

Collection of nested Composites

modifyDefaultTableSpecification

public TableSpecification modifyDefaultTableSpecification(TableSpecification spec,
                                                          java.lang.String table)

Description copied from interface: TableStructureContributer

Modify the TableSpecification of the target factory.

Specified by:

modifyDefaultTableSpecification in interface TableStructureContributer<BDO extends DataObject>

Overrides:

modifyDefaultTableSpecification in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Returns:

addOptional

public java.util.Set<java.lang.String> addOptional(java.util.Set<java.lang.String> optional)

Description copied from interface: TableStructureContributer

generate the set of optional fields to be used to provide class specific defaults in form creation/update. If null is returned the default behaviour is to take fields that can be null in the database.

Specified by:

addOptional in interface TableStructureContributer<BDO extends DataObject>

Overrides:

addOptional in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Returns:

Set

addDefaults

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

Description copied from interface: TableStructureContributer

Generate a set of default property values. override this in sub-classes to give defaults when creating objects.

Specified by:

addDefaults in interface TableStructureContributer<BDO extends DataObject>

Overrides:

addDefaults in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Returns:

Map of default values

addTranslations

public java.util.Map<java.lang.String,java.lang.String> addTranslations(java.util.Map<java.lang.String,java.lang.String> translations)

Description copied from interface: TableStructureContributer

return a default set of translation between field names and text labels. This method provides a class specific set of defaults. The individual Form classes can still override this.

Specified by:

addTranslations in interface TableStructureContributer<BDO extends DataObject>

Overrides:

addTranslations in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Returns:

Map

addSelectors

public java.util.Map<java.lang.String,Selector> addSelectors(java.util.Map<java.lang.String,Selector> selectors)

Description copied from interface: TableStructureContributer

Get a Map of selectors to use for forms of this type. This method provides a class specific set of defaults but the specific form classes can override this.

Specified by:

addSelectors in interface TableStructureContributer<BDO extends DataObject>

Overrides:

addSelectors in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Returns:

Map of modified selectors/inputs

addSuppress

public java.util.Set<java.lang.String> addSuppress(java.util.Set<java.lang.String> suppress)

Description copied from interface: TableStructureContributer

generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.

Specified by:

addSuppress in interface TableStructureContributer<BDO extends DataObject>

Overrides:

addSuppress in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Returns:

Set of fields to suppress in forms.

customiseForm

public void customiseForm(Form f)

Description copied from interface: TableStructureContributer

Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator . Logic that requires an existing object can be added to TableStructureContributer.customiseUpdateForm(Form, DataObject, SessionService)

Specified by:

customiseForm in interface TableStructureContributer<BDO extends DataObject>

Overrides:

customiseForm in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Parameters:

f - Form to modify

postUpdate

public void postUpdate(BDO o,
                       Form f,
                       java.util.Map<java.lang.String,java.lang.Object> orig,
                       boolean changed)
                throws DataException

Description copied from interface: TableStructureContributer

perform side effects after a formupdate

Specified by:

postUpdate in interface TableStructureContributer<BDO extends DataObject>

Overrides:

postUpdate in class Composite<BDO extends DataObject,X extends Composite<BDO,X>>

Throws:

DataException