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

Class PartManager<O extends PartOwner,P extends PartManager.Part<O>>

java.lang.Object

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

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

uk.ac.ed.epcc.webapp.model.far.PartManager<O,P>

Type Parameters:

O - type of owner

P - type of part.

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<P>, FilterMatcher<P>, TypeConverter<P,java.lang.Number>, DataObjectSelector<P>, Selector<DataObjectItemInput<P>>, Owner<P>, IndexedProducer<P>, Tagged, Targetted<P>

Direct Known Subclasses:

HandlerPartManager, PageManager

public abstract class PartManager<O extends PartOwner,P extends PartManager.Part<O>>
extends PartOwnerFactory<P>

abstract super-class for a part or sub-part of a Form. There may be several levels in the hierarchy so parts also implement PartOwner

Each part references its parent, has an order field that determines the order of parts within the parent and has a name field that is unique within the parent.

The factory classes are expected to always be referenced via their parent and their identifying tags are derived from the parent tags so that if multiple tables of forms are created they automatically generate independent tables of parts this makes it easier to remove entire classes of form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PartManager.ChildCreateAction
static class	PartManager.Part<O extends PartOwner>
class	PartManager.PartCreator
class	PartManager.PartUpdater
class	PartManager.UnusedNameInput

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
protected DynamicFormManager<?>	form_manager
static java.lang.String	NAME_FIELD
static java.lang.String	ORDER_FIELD
static java.lang.String	OWNER_FIELD

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

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors

Constructor and Description
PartManager(DynamicFormManager<?> form_manager, PartOwnerFactory<O> owner_fac, java.lang.String part_tag)

Method Summary

Modifier and Type	Method and Description
void	deleteAll(O owner) recursively delete any parts with a specified owner
void	deleteContent(P part) prepare a PartManager.Part for deletion by removing any content.
void	deletePart(P part) delete a PartManager.Part
P	duplicate(O new_owner, P original) create a (uncommitted) duplicate copy of a part with a new owner
P	findByParentAndName(O owner, java.lang.String name)
PartManager.PartCreator	getChildCreator(O owner)
PartManager	getChildManager() Get the PartManager for the next level of the hierarchy.
Table	getChildTable(P target)
abstract java.lang.String	getChildTypeName() get the type-name for the child type.
PartConfigFactory<O,P>	getConfigFactory()
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
P	getFirst(O owner)
FormUpdate<P>	getFormUpdate(AppContext c) produce a FormUpdate for the target type appropriate for the requesting user
protected java.util.List<OrderClause>	getOrder()
PartOwnerFactory<O>	getOwnerFactory()
FilterResult<P>	getParts(O owner) Get all the parts belonging to an owner.
Table	getPartTable(O owner)
java.lang.String	getPartTag()
P	getSibling(P current, boolean up) get the next sibling (offspring of same parent)
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<P>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
protected abstract PartManager	makeChildManager()
protected PartConfigFactory<O,P>	makeConfigFactory()

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, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSelectors, getTableSpecification, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, 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

Field Detail

OWNER_FIELD

public static final java.lang.String OWNER_FIELD

See Also:

Constant Field Values

ORDER_FIELD

public static final java.lang.String ORDER_FIELD

See Also:

Constant Field Values

NAME_FIELD

public static final java.lang.String NAME_FIELD

See Also:

Constant Field Values

form_manager

protected final DynamicFormManager<?> form_manager

Constructor Detail

PartManager

public PartManager(DynamicFormManager<?> form_manager,
                   PartOwnerFactory<O> owner_fac,
                   java.lang.String part_tag)

Method Detail

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<P extends PartManager.Part<O>>

Returns:

Set

See Also:

DataObjectFormFactory

getFormUpdate

public FormUpdate<P> getFormUpdate(AppContext c)

Description copied from interface: FormUpdateProducer

produce a FormUpdate for the target type appropriate for the requesting user

Specified by:

getFormUpdate in interface FormUpdateProducer<P extends PartManager.Part<O>>

Overrides:

getFormUpdate in class DataObjectFactory<P extends PartManager.Part<O>>

Parameters:

c - AppContext

Returns:

FormUpdate or null

getChildCreator

public PartManager.PartCreator getChildCreator(O owner)

getPartTag

public final java.lang.String getPartTag()

getTarget

public java.lang.Class<P> 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<P extends PartManager.Part<O>>

Specified by:

getTarget in interface Targetted<P extends PartManager.Part<O>>

Overrides:

getTarget in class DataObjectFactory<P extends PartManager.Part<O>>

Returns:

Class object for return type

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<P extends PartManager.Part<O>>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification

getOwnerFactory

public PartOwnerFactory<O> getOwnerFactory()

Returns:

getParts

public FilterResult<P> getParts(O owner)
                         throws DataFault

Get all the parts belonging to an owner.

Parameters:

owner -

Returns:

Throws:

DataFault

findByParentAndName

public P findByParentAndName(O owner,
                             java.lang.String name)
                      throws DataException

Throws:

DataException

getSibling

public P getSibling(P current,
                    boolean up)
             throws DataFault

get the next sibling (offspring of same parent)

Parameters:

current - start position.

up - direction to move

Returns:

sibling or null

Throws:

DataFault

getFirst

public P getFirst(O owner)
           throws DataFault

Throws:

DataFault

getOrder

protected java.util.List<OrderClause> getOrder()

Overrides:

getOrder in class DataObjectFactory<P extends PartManager.Part<O>>

getChildTable

public Table getChildTable(P target)
                    throws DataFault

Throws:

DataFault

getPartTable

public Table getPartTable(O owner)
                   throws DataFault

Throws:

DataFault

deleteAll

public final void deleteAll(O owner)
                     throws DataFault

recursively delete any parts with a specified owner

Parameters:

owner -

Throws:

DataFault

deletePart

public final void deletePart(P part)
                      throws DataFault

delete a PartManager.Part

Parameters:

part -

Throws:

DataFault

deleteContent

public void deleteContent(P part)
                   throws DataFault

prepare a PartManager.Part for deletion by removing any content. This defaults to recursing to child elements but may need to be extended for levels that store additional data in other tables.

Parameters:

part -

Throws:

DataFault

getChildTypeName

public abstract java.lang.String getChildTypeName()

Description copied from class: PartOwnerFactory

get the type-name for the child type.

Specified by:

getChildTypeName in class PartOwnerFactory<P extends PartManager.Part<O>>

Returns:

makeChildManager

protected abstract PartManager makeChildManager()

getChildManager

public final PartManager 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<P extends PartManager.Part<O>>

Returns:

PartManager or null

makeConfigFactory

protected PartConfigFactory<O,P> makeConfigFactory()

getConfigFactory

public PartConfigFactory<O,P> getConfigFactory()

duplicate

public P duplicate(O new_owner,
                   P original)
            throws DataFault

create a (uncommitted) duplicate copy of a part with a new owner

Parameters:

new_owner -

original -

Returns:

Throws:

DataFault