uk.ac.ed.epcc.webapp.model.far

Class DynamicFormManager<F extends DynamicFormManager.DynamicForm>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<O>

uk.ac.ed.epcc.webapp.model.far.PartOwnerFactory<F>

uk.ac.ed.epcc.webapp.model.far.DynamicFormManager<F>

Type Parameters:

F - type of DynamicFormManager.DynamicForm

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<F>, TransitionFactoryCreator<TransitionFactory>, FilterMatcher<F>, TypeConverter<F,java.lang.Number>, DataObjectSelector<F>, Selector<DataObjectItemInput<F>>, Owner<F>, IndexedProducer<F>, ParseFactory<F>, ServeDataProducer, Tagged, Targetted<F>

public class DynamicFormManager<F extends DynamicFormManager.DynamicForm>
extends PartOwnerFactory<F>
implements ParseFactory<F>, TransitionFactoryCreator<TransitionFactory>, ServeDataProducer

Each DynamicFormManager.DynamicForm instance represents a single version of a muti-section questionnaire that will be presented to a user.

DynamicFormManager.DynamicForms are edited and dynamically but need to be frozen to generate a fixed structure before being presented to users. New versions can still be constructed by copying a frozen form.

All support classes and TransitionFactorys used to handle the forms produced by this factory are generated from here wither via getChildManager() or getTransitionProvider(String) table names are derived from the table used by this class. Therefore by sub-classing with a new table-name an entirely distinct set of support tables will be generated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicFormManager.DynamicForm
static class	DynamicFormManager.Status

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.AbstractFinder<X>, DataObjectFactory.DataObjectAcceptFilter, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.DestAcceptFilter<T extends DataObject>, DataObjectFactory.FilterAdapter, DataObjectFactory.FilterCounter, DataObjectFactory.FilterExists, DataObjectFactory.FilterIterator, DataObjectFactory.FilterSelector, DataObjectFactory.FilterSet, DataObjectFactory.Finder, DataObjectFactory.MakeRemoteFilterVisitor<R extends DataObject>, DataObjectFactory.MatchFilter, DataObjectFactory.ReferencedAdapter<I extends Indexed>, DataObjectFactory.ReferenceIterator<I extends Indexed>, DataObjectFactory.SortingDataObjectInput, DataObjectFactory.TimeAcceptFilter<T extends DataObject>, DataObjectFactory.TimeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORM_TAG
static java.lang.String	NAME_FIELD
static java.lang.String	PART_TAG
static java.lang.String	VALIDATING_VISITOR_FIELD

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

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.transition.TransitionFactoryCreator

TYPE_SEPERATOR

Fields inherited from interface uk.ac.ed.epcc.webapp.model.serv.ServeDataProducer

DEFAULT_SERVE_DATA_TAG

Constructor Summary

Constructors

Constructor and Description
DynamicFormManager(AppContext conn, java.lang.String homeTable)

Method Summary

Modifier and Type	Method and Description
boolean	canEdit(SessionService<?> sess) Is the specified person allowed to perform targetless operations.
F	duplicate(F original, java.lang.String name)
F	findFromString(java.lang.String name) Find an existing entry by name.
FilterResult<F>	getActive()
BaseFilter<F>	getActiveFilter()
java.lang.String	getCanonicalName(F object) Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.
PageManager	getChildManager() Get the PartManager for the next level of the hierarchy.
java.lang.String	getChildTypeName() get the type-name for the child type.
MimeStreamData	getData(SessionService user, java.util.List<java.lang.String> path) Get a MimeStreamData corresponding to the data to be served This method also implements access control and returns null if access is denied.
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
java.lang.String	getDownloadName(SessionService user, java.util.List<java.lang.String> path) get a download file-name to be added to a download link.
DynamicFormTransitionProvider<F>	getDynamicFormProvider()
SQLValueFilter<F>	getNameFilter(java.lang.String name)
FilterResult<F>	getNew()
SQLFilter<F>	getNewFilter()
protected java.util.Set<java.lang.String>	getOptional() generate the set of optional fields to be used to provide class specific defaults in form creation/update.
PartPathTransitionProvider	getPartPathProvider()
FilterResult<F>	getRetired()
SQLFilter<F>	getRetiredFilter()
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 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.lang.Class	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
TransitionFactory	getTransitionProvider(java.lang.String tag)
boolean	hasActive()
protected F	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.

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

all, allowPreSelect, canCreate, canUpdate, checkComposite, convertToDestinationFilter, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getComposites, getConfigTag, getContext, getCount, getDefaultRelationshipFilter, getDefaults, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getFormCreator, getFormUpdate, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getTableSpecification, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, OrderBy, postCreateTableSetup, postSetContext, release, restrictDefaultInput, setComposites, setContext, setContext, setContextWithMake, setProperty, toString, updateTable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.Tagged

getTag

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Field Detail

NAME_FIELD

public static final java.lang.String NAME_FIELD

See Also:

Constant Field Values

VALIDATING_VISITOR_FIELD

public static final java.lang.String VALIDATING_VISITOR_FIELD

See Also:

Constant Field Values

PART_TAG

public static final java.lang.String PART_TAG

See Also:

Constant Field Values

FORM_TAG

public static final java.lang.String FORM_TAG

See Also:

Constant Field Values

Constructor Detail

DynamicFormManager

public DynamicFormManager(AppContext conn,
                          java.lang.String homeTable)

Method Detail

makeBDO

protected F makeBDO(Repository.Record res)
             throws DataFault

Description copied from class: DataObjectFactory

Construct a new Blank DataObject of the correct Class This method takes a Record as an argument. This allows the factory to either create different sub-classes depending on a value in the record or to produce objects from different Repositories/tables. We keep the return type as DataObject instead of making it generic as this helps with legacy compatibility a little bit (problem is if we have another generic sub-type between us and a legacy sub-class

Specified by:

makeBDO in class DataObjectFactory<F extends DynamicFormManager.DynamicForm>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

getTarget

public java.lang.Class getTarget()

Description copied from class: DataObjectFactory

Get a bound on the type of object produced by this factory for run-time checking. This implements IndexedProducer.getTarget(). Normally this method should be overridden each time we make a sub-class that narrows the produced type. However checks should still pass if the super-type method is retained.

Specified by:

getTarget in interface IndexedProducer<F extends DynamicFormManager.DynamicForm>

Specified by:

getTarget in interface Targetted<F extends DynamicFormManager.DynamicForm>

Overrides:

getTarget in class DataObjectFactory<F extends DynamicFormManager.DynamicForm>

Returns:

Class object for return type

getChildManager

public PageManager getChildManager()

Description copied from class: PartOwnerFactory

Get the PartManager for the next level of the hierarchy. This always returns null for the bottom layer.

Specified by:

getChildManager in class PartOwnerFactory<F extends DynamicFormManager.DynamicForm>

Returns:

PartManager or null

getTransitionProvider

public TransitionFactory getTransitionProvider(java.lang.String tag)

Specified by:

getTransitionProvider in interface TransitionFactoryCreator<TransitionFactory>

Parameters:

tag - TargetName used for the TransitionProvider

Returns:

TransitionProvider

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext c,
                                                          java.lang.String table)

Description copied from class: DataObjectFactory

Get the default table specification if the table is to be created. A null result means that a default specification is not available and the table will not be created.

Overrides:

getDefaultTableSpecification in class DataObjectFactory<F extends DynamicFormManager.DynamicForm>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification

findFromString

public F findFromString(java.lang.String name)

Description copied from interface: ParseFactory

Find an existing entry by name.

Specified by:

findFromString in interface ParseFactory<F extends DynamicFormManager.DynamicForm>

Returns:

Matching T or null

getNameFilter

public SQLValueFilter<F> getNameFilter(java.lang.String name)

Parameters:

name -

Returns:

getNew

public FilterResult<F> getNew()
                       throws DataFault

Throws:

DataFault

getNewFilter

public SQLFilter<F> getNewFilter()

getActive

public FilterResult<F> getActive()
                          throws DataFault

Throws:

DataFault

getActiveFilter

public BaseFilter<F> getActiveFilter()

getRetired

public FilterResult<F> getRetired()
                           throws DataFault

Throws:

DataFault

getRetiredFilter

public SQLFilter<F> getRetiredFilter()

canEdit

public boolean canEdit(SessionService<?> sess)

Is the specified person allowed to perform targetless operations.

Parameters:

sess -

Returns:

getSupress

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

Description copied from class: DataObjectFactory

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.

Overrides:

getSupress in class DataObjectFactory<F extends DynamicFormManager.DynamicForm>

Returns:

Set

See Also:

DataObjectFormFactory

getSelectors

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

Description copied from class: DataObjectFactory

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.

Overrides:

getSelectors in class DataObjectFactory<F extends DynamicFormManager.DynamicForm>

Returns:

Map

See Also:

DataObjectFormFactory

getOptional

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

Description copied from class: DataObjectFactory

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 but classes can override with an explicit list of optional fields. In which case it may be a good idea to start with DataObjectFactory.getNullable() and remove any fields that should be forced to be mandatory. Alternatively you can start with an empty set (defaulting to all fields mandatory) and add exceptions Note that for legacy reasons a non-nullable String field CAN be made optional (the Repository will map null values to the empty string)

Overrides:

getOptional in class DataObjectFactory<F extends DynamicFormManager.DynamicForm>

Returns:

Vector

See Also:

DataObjectFactory.getNullable()

getPartPathProvider

public PartPathTransitionProvider getPartPathProvider()

Returns:

getDynamicFormProvider

public DynamicFormTransitionProvider<F> getDynamicFormProvider()

getCanonicalName

public java.lang.String getCanonicalName(F object)

Description copied from interface: ParseFactory

Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.

Specified by:

getCanonicalName in interface ParseFactory<F extends DynamicFormManager.DynamicForm>

Returns:

The canonical name.

getData

public MimeStreamData getData(SessionService user,
                              java.util.List<java.lang.String> path)
                       throws java.lang.Exception

Description copied from interface: ServeDataProducer

Get a MimeStreamData corresponding to the data to be served This method also implements access control and returns null if access is denied. Note that the SessionService may not have a current person set so you have to check for null SessionService and null AppUser as well as the users permissions.

Specified by:

getData in interface ServeDataProducer

Returns:

MimeStreamData or null

Throws:

java.lang.Exception

getDownloadName

public java.lang.String getDownloadName(SessionService user,
                                        java.util.List<java.lang.String> path)
                                 throws java.lang.Exception

Description copied from interface: ServeDataProducer

get a download file-name to be added to a download link. This should be the same as the value returned by MimeStreamData.getName() if ServeDataProducer.getData(SessionService, List) returns a non-null value. However this method may be called by display content generation code so if the result is generated on the fly it might be possible to generate the download name in a more lightweight fashion. It should also work to always return null thought he browser will use the last part of the selection path as the download

Specified by:

getDownloadName in interface ServeDataProducer

Returns:

Throws:

java.lang.Exception

getChildTypeName

public java.lang.String getChildTypeName()

Description copied from class: PartOwnerFactory

get the type-name for the child type.

Specified by:

getChildTypeName in class PartOwnerFactory<F extends DynamicFormManager.DynamicForm>

Returns:

duplicate

public F duplicate(F original,
                   java.lang.String name)
            throws DataException

Throws:

DataException

hasActive

public boolean hasActive()