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

Class Composite<BDO extends DataObject,X>

java.lang.Object

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

Type Parameters:

BDO - target type

All Implemented Interfaces:

Contexed, TableStructureContributer<BDO>

Direct Known Subclasses:

AppUserComposite, ConfigNamedFilterComposite, CreateComposite, CrossCookieComposite, MultiComposite, ServiceFilterComposite, StateRelationshipComposite

public abstract class Composite<BDO extends DataObject,X>
extends java.lang.Object
implements Contexed, TableStructureContributer<BDO>

A Composite adds behaviour to a DataObjectFactory by composition but persisted to the same database table. It is a TableStructureContributer so specifies additional fields for the Repository and methods to customise the forms and may be extended to add functionality based on those fields.

For this class to affect the table specification it needs to be registered before the DataObjectFactory.setContext(uk.ac.ed.epcc.webapp.AppContext, String)method is called. The easiest way to do this is to specify them as configuration parameters. You can create the composite during field initialisation. If you do this you MUST call the setContext method from the constructor body in the same class not recurse to the superclass constructor that calls setContext. This is because superclass constructors run before field initialisation but local constructor bodies run afterwards.

Composites that have a public constructor that takes the DataObjectFactory as the argument (optionally followed by a String), can be added to a factory by setting a (comma separated) list of classdef or property class names in the parameter factory-tag.composites and these will be added in the DataObjectFactory.setContext(uk.ac.ed.epcc.webapp.AppContext, String) method and can therefore modify the table specification. If the constructor takes the String parameter the construction tag of the composite will be passed.

The areas that Composites can customise can be extended by having a factory check all composites for specific interfaces for example TableStructureDataObjectFactory checks the composites for TransitionSource If you find yourself testing for the existence of multiple composites at the same location consider extracting an interface for that all the contributing composites can implement.

Each Composite provides a type Class that it is registered under. It should itself be assignable to that type. A factory cannot contain two Composites registered under the same class. Any functionality that should only be included once (but has many implementations) should use the same registration class (which should be an interface or abstract supertype representing the operation) and can be retrieved by the registration type. Otherwise composites usually register under their own type. This does mean that if you want to add several copies of the same composite you need to introduce trivial sub-classes.

Composites augment a DataObjectFactory so it is easiest to add behaviour to the factory rather than the DataObject. To add behaviour to DataObject is easier if the object is an inner class or contains a reference to its factory. You can also introduce additional handler classes that wrap the repository these can have the same relation to the Composite as DataObject has to the DataObjectFactory.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataObjectFactory<BDO>	fac

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Composite(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.Map<java.lang.String,java.lang.String>	addFieldHelp(java.util.Map<java.lang.String,java.lang.String> help) return a default set of tooltip help text for form fields.
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 .
void	customiseUpdateForm(Form f, BDO target, SessionService operator) Extension hook to allow additional Form customisation specific to the update of an existing object.
AppContext	getContext()
DataObjectFactory<BDO>	getFactory() return the DataObjectFactory the Composite is registered with.
protected Logger	getLogger() get a Logger for this class
protected Repository.Record	getRecord(BDO data) method to allow sub-classes to retrieve the Repository.Record from a target DataObject.
protected Repository	getRepository() method to allow sub-classes to retrieve the Repository.
protected abstract java.lang.Class<? super X>	getType() Returns the type the composite should be registered under.
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
protected void	preRegister() extension point called before the composite is registered.
protected void	release() perform extra clean-up when factory is released
java.lang.String	toString() used to list composites on table structure page.

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

Field Detail

fac

protected final DataObjectFactory<BDO extends DataObject> fac

Constructor Detail

Composite

protected Composite(DataObjectFactory<BDO> fac)

Method Detail

preRegister

protected void preRegister()

extension point called before the composite is registered. This is to allow the class setup to be completed that can't wait till after registration.

getType

protected abstract java.lang.Class<? super X> getType()

Returns the type the composite should be registered under.

Returns:

registration type

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>

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>

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>

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>

Returns:

Map

addFieldHelp

public java.util.Map<java.lang.String,java.lang.String> addFieldHelp(java.util.Map<java.lang.String,java.lang.String> help)

Description copied from interface: TableStructureContributer

return a default set of tooltip help text for form fields. This method provides a class specific set of defaults. The individual Form classes can still override this.

Specified by:

addFieldHelp in interface TableStructureContributer<BDO extends DataObject>

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>

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>

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>

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>

Throws:

DataException

getRecord

protected final Repository.Record getRecord(BDO data)

method to allow sub-classes to retrieve the Repository.Record from a target DataObject. This allows composite functionality to be added to these as well as to the factory.

Parameters:

data -

Returns:

getRepository

protected final Repository getRepository()

method to allow sub-classes to retrieve the Repository.

Returns:

getFactory

public final DataObjectFactory<BDO> getFactory()

return the DataObjectFactory the Composite is registered with.

Returns:

getContext

public final AppContext getContext()

Specified by:

getContext in interface Contexed

getLogger

protected final Logger getLogger()

get a Logger for this class

Returns:

customiseUpdateForm

public void customiseUpdateForm(Form f,
                                BDO target,
                                SessionService operator)

Description copied from interface: TableStructureContributer

Extension hook to allow additional Form customisation specific to the update of an existing object. This can also add constraints based on the relationship of the operator to the object being updated. Logic that does not require an existing object can be added to TableStructureContributer.customiseForm(Form)

Specified by:

customiseUpdateForm in interface TableStructureContributer<BDO extends DataObject>

release

protected void release()

perform extra clean-up when factory is released

toString

public java.lang.String toString()

used to list composites on table structure page.

Overrides:

toString in class java.lang.Object