uk.ac.ed.epcc.webapp.forms.registry

Class AbstractFormFactoryProvider<F extends Contexed,T>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.registry.AbstractFormFactoryProvider<F,T>

Type Parameters:

F -

T -

All Implemented Interfaces:

java.lang.Comparable, FormFactoryProvider<T>, FormPolicy

Direct Known Subclasses:

DynamicFormEntry, FormEntry

public abstract class AbstractFormFactoryProvider<F extends Contexed,T>
extends java.lang.Object
implements java.lang.Comparable, FormFactoryProvider<T>

This type is intended to provide a way of producing lists of classes that can be modified via forms. Any type that we wish to access via the generic forms code (as opposed to explicit jsp/servlets for that type) needs to be registered in one of the sub-classes. Each type is marked if update and or create forms should be presented. Some types have their own mechanisms for creation/update The create/update information in encapsulated in a policy object to allow fine grained access control. FormEntry objects are usually created as static instances and also recorded in a static collection. The register method is overridden to record the static instances in the collection. FormRegistry instances created to access the collection. This way we can refer to a particular entry via the static instance and the ObjectServlet can create FormRegistry instances using AppContext.getFactory Organising the FormTypes into collections reduces the amount of additional configuration as only the FormRegistries need to be identified by a property name. This mechanism assumes a default update/create form for each factory class. It would be better to re-write so that a factory can have many methods that can produce form classes and identify these by annotations. moving the access conditions to an annotation as well might be useful changing this type to a register of factory classes.

Constructor Summary

Constructors

Constructor and Description
AbstractFormFactoryProvider(java.lang.String name, FormPolicy policy)

Method Summary

Modifier and Type	Method and Description
boolean	canCreate(SessionService p) Can the current user create
boolean	canUpdate(SessionService p) Can the current user update
int	compareTo(java.lang.Object o)
protected boolean	disabled(AppContext c)
boolean	equals(java.lang.Object obj)
protected abstract F	getFactory(AppContext c) Get the Factory associated with this entry.
FormCreator	getFormCreator(AppContext c) Get a FormCreator appropriate for this type and the current person
FormUpdate<T>	getFormUpdate(AppContext c) Get a FormUpdate appropriate for this type and the current person
java.lang.String	getName() Name of the object type as presented to the User
int	hashCode()
protected abstract void	register(java.lang.String clean_tag) register this object with its parent collection.
boolean	targets(AppContext c, java.lang.Object target)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.registry.FormFactoryProvider

getID, getTarget

Constructor Detail

AbstractFormFactoryProvider

public AbstractFormFactoryProvider(java.lang.String name,
                                   FormPolicy policy)

Method Detail

register

protected abstract void register(java.lang.String clean_tag)

register this object with its parent collection. This allows the object to be declared as a static constant in the registry

Parameters:

clean_tag -

getName

public java.lang.String getName()

Description copied from interface: FormFactoryProvider

Name of the object type as presented to the User

Specified by:

getName in interface FormFactoryProvider<T>

Returns:

String name

canUpdate

public boolean canUpdate(SessionService p)

Description copied from interface: FormPolicy

Can the current user update

Specified by:

canUpdate in interface FormPolicy

Parameters:

p - Person

Returns:

boolean

canCreate

public boolean canCreate(SessionService p)

Description copied from interface: FormPolicy

Can the current user create

Specified by:

canCreate in interface FormPolicy

Parameters:

p - Person

Returns:

boolean

disabled

protected boolean disabled(AppContext c)

getFactory

protected abstract F getFactory(AppContext c)
                         throws java.lang.Exception

Get the Factory associated with this entry.

Parameters:

c -

Returns:

Throws:

java.lang.Exception

getFormCreator

public FormCreator getFormCreator(AppContext c)
                           throws java.lang.Exception

Get a FormCreator appropriate for this type and the current person

Specified by:

getFormCreator in interface FormFactoryProvider<T>

Parameters:

c - AppContext

Returns:

FormCreator or null

Throws:

java.lang.Exception

getFormUpdate

public FormUpdate<T> getFormUpdate(AppContext c)
                            throws java.lang.Exception

Get a FormUpdate appropriate for this type and the current person

Specified by:

getFormUpdate in interface FormFactoryProvider<T>

Parameters:

c - AppContest

Returns:

FormUpdate or null

Throws:

java.lang.Exception

targets

public boolean targets(AppContext c,
                       java.lang.Object target)

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object