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

Class FormEntry<F extends Contexed,T>

java.lang.Object

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

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

Type Parameters:

F - Factory type

T - Target type

All Implemented Interfaces:

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

Direct Known Subclasses:

IndexedFormEntry

public abstract class FormEntry<F extends Contexed,T>
extends AbstractFormFactoryProvider<F,T>
implements SummaryContentProvider<T>

FormEntry holds a reference to a Factory class that is capable of being manipulated via the form interfaces This type is intended to provide an entry in 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 here. 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 often created as static instances and also recorded in a static collection. The register method is overridden to record the static instances in the collection. For this reason the FormEntry does not hold an AppContext reference or cache the Factory object. FormRegistry instances created to access the collection. This way we can refer to a particular FormType 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	config_tag

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormEntry(java.lang.String name, java.lang.Class<? extends F> c, FormPolicy policy)
protected	FormEntry(java.lang.String name, java.lang.Class<? extends F> c, java.lang.String config_tag, FormPolicy policy)

Method Summary

Modifier and Type	Method and Description
boolean	allowNullTag(AppContext c)
protected boolean	disabled(AppContext c)
protected F	getFactory(AppContext c) Get the Factory associated with this entry.
<X extends ContentBuilder> X	getSummaryContent(AppContext c, X cb, T target)

Methods inherited from class uk.ac.ed.epcc.webapp.forms.registry.AbstractFormFactoryProvider

canCreate, canUpdate, compareTo, equals, getFormCreator, getFormUpdate, getName, hashCode, register, targets

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

Field Detail

config_tag

protected final java.lang.String config_tag

Constructor Detail

FormEntry

protected FormEntry(java.lang.String name,
                    java.lang.Class<? extends F> c,
                    FormPolicy policy)

FormEntry

protected FormEntry(java.lang.String name,
                    java.lang.Class<? extends F> c,
                    java.lang.String config_tag,
                    FormPolicy policy)

Method Detail

getSummaryContent

public <X extends ContentBuilder> X getSummaryContent(AppContext c,
                                                      X cb,
                                                      T target)

Specified by:

getSummaryContent in interface SummaryContentProvider<T>

getFactory

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

Description copied from class: AbstractFormFactoryProvider

Get the Factory associated with this entry.

Specified by:

getFactory in class AbstractFormFactoryProvider<F extends Contexed,T>

Returns:

Throws:

java.lang.Exception

allowNullTag

public boolean allowNullTag(AppContext c)

disabled

protected boolean disabled(AppContext c)

Overrides:

disabled in class AbstractFormFactoryProvider<F extends Contexed,T>