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

Class Creator<BDO extends DataObject>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.data.forms.Creator<BDO>

Type Parameters:

BDO - type we are creating

All Implemented Interfaces:

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

Direct Known Subclasses:

AppUserFactory.SignupFormCreator, ClassificationFactory.ClassificationCreator, PartManager.PartCreator, TextFileOverlay.TextFileCreator

public class Creator<BDO extends DataObject>
extends DataObjectFormFactory<BDO>
implements FormCreator, CreateTemplate<BDO>

Default FormCreator for this Factory

See Also:

CreateTransition

Field Summary

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

DEFAULT_FORBID_HTML, factory

Constructor Summary

Constructors

Constructor and Description
Creator(DataObjectFactory<BDO> dataObjectFactory)

Method Summary

Modifier and Type	Method and Description
void	buildCreationForm(java.lang.String type_name, Form f) build a form to create an object.
void	customiseCreationForm(Form f) Perform target specific customisation of a creation Form.
java.lang.Object	getActionText() Override the text for the create button
java.lang.String	getConfirm(Form f) should a confirm dialog be presented.
FormResult	getResult(java.lang.String type_name, BDO dat, Form f)
void	postCreate(BDO dat, Form f) Take any action after object commit.
void	preCommit(BDO dat, Form f) Populate target from creation form.
void	setAction(java.lang.String type_name, Form f)

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

addOptionalFromComposites, addSelectors, addTranslations, buildForm, buildForm, buildForm, buildForm, buildForm, customiseForm, find, find, getContext, getDefaults, getFactory, getFieldConstraints, getFieldHelp, getFields, getID, getIndex, getInputFromName, getInputFromType, getLogger, getOptional, getSelectors, getSupress, getTarget, getTranslations, isMyReference, makeReference, makeReference

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.factory.FormFactory

getContext

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

getDefaults, getFactory

Constructor Detail

Creator

public Creator(DataObjectFactory<BDO> dataObjectFactory)

Parameters:

dataObjectFactory -

Method Detail

buildCreationForm

public void buildCreationForm(java.lang.String type_name,
                              Form f)
                       throws java.lang.Exception

Description copied from interface: FormCreator

build a form to create an object. This should include Action Buttons that actually create the object

Specified by:

buildCreationForm in interface FormCreator

Parameters:

type_name - NAme of target type as presented to user

Throws:

java.lang.Exception

setAction

public void setAction(java.lang.String type_name,
                      Form f)

getActionText

public java.lang.Object getActionText()

Override the text for the create button

Returns:

object added as button content

customiseCreationForm

public void customiseCreationForm(Form f)
                           throws java.lang.Exception

Perform target specific customisation of a creation Form. For example adding a special validator. Note that this is called in addition to the basic DataObjectFormFactory.customiseForm(Form) call

Specified by:

customiseCreationForm in interface CreateCustomizer<BDO extends DataObject>

Parameters:

f - Form to be modified

Throws:

java.lang.Exception

preCommit

public void preCommit(BDO dat,
                      Form f)
               throws DataException,
                      ActionException

Description copied from interface: CreateCustomizer

Populate target from creation form. This can be sub-classes to add additional information such as the requesting Person or other information derived other than from the form parameters. Normally the form contents have already been set in the Object but the form is passed to this method in case any form parameters are used to control the way the object is created.

Specified by:

preCommit in interface CreateCustomizer<BDO extends DataObject>

Parameters:

dat - Object being created

f - Form providing parameters

Throws:

DataException

ActionException

postCreate

public void postCreate(BDO dat,
                       Form f)
                throws java.lang.Exception

Description copied from interface: CreateCustomizer

Take any action after object commit.

Specified by:

postCreate in interface CreateCustomizer<BDO extends DataObject>

Throws:

java.lang.Exception

getResult

public FormResult getResult(java.lang.String type_name,
                            BDO dat,
                            Form f)

Specified by:

getResult in interface CreateTemplate<BDO extends DataObject>

getConfirm

public java.lang.String getConfirm(Form f)

Description copied from interface: CreateTemplate

should a confirm dialog be presented. A null value means no confirm dialog.

Specified by:

getConfirm in interface CreateTemplate<BDO extends DataObject>

Returns:

confirm type or null