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

Class FormFactoryProviderRegistry<T extends FormFactoryProvider>

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.forms.registry.FormFactoryProviderRegistry<T>

Type Parameters:

T -

All Implemented Interfaces:

UIGenerator, Contexed, TransitionFactoryCreator<TransitionProvider>, NodeMaker

Direct Known Subclasses:

ConfigFormProvider, FormRegistry, HeirarchyFormRegistry

public abstract class FormFactoryProviderRegistry<T extends FormFactoryProvider>
extends AbstractContexed
implements UIGenerator, TransitionFactoryCreator<TransitionProvider>, NodeMaker

Factory class for a set of FormFactoryProviders. This implements UIGenerator to emit a set of edit/update buttons and NodeMaker to expose the same operations as a navigation menu.

Field Summary

Fields

Modifier and Type	Field and Description
static char	TAG_SEPERATOR

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

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

TYPE_SEPERATOR

Constructor Summary

Constructors

Constructor and Description
FormFactoryProviderRegistry(AppContext conn)

Method Summary

Modifier and Type	Method and Description
void	addChildren(Node parent, java.lang.String name, FilteredProperties props) Add additional child nodes specific to the NodeMaker.
ContentBuilder	addContent(ContentBuilder builder)
static java.lang.String	cleanType(java.lang.String type) map a tag string to something that won't break the TransitionServlet
T	find(java.lang.String name)
java.util.Iterator<T>	getCreators(SessionService p) Get all FormTypes that a person can create
abstract java.lang.String	getGroup() get the tag used to produce this class via AppContext.getFactory
static java.lang.String	getGroup(java.lang.String tag)
protected abstract java.util.Map<java.lang.String,T>	getMap() get a map from the cleaned cleanType(String) tag to the FormFactoryProvider.
java.lang.String	getTag(FormFactoryProvider e)
abstract java.lang.String	getTitle() Subject are to use in form title
TransitionProvider<FormOperations,T>	getTransitionProvider(FormFactoryProvider<T> provider)
TransitionProvider	getTransitionProvider(java.lang.String name)
static java.lang.String	getType(java.lang.String tag)
java.util.Iterator<T>	getTypes() Return all FormTypes.
java.util.Iterator<T>	getUpdaters(SessionService p) Get all FormTypes that a person can update
Node	makeNode(java.lang.String name, FilteredProperties props) Create a Node for a named menu item.
static java.lang.String	makeTag(java.lang.String group, java.lang.String type)

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

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.Contexed

getContext

Field Detail

TAG_SEPERATOR

public static final char TAG_SEPERATOR

See Also:

Constant Field Values

Constructor Detail

FormFactoryProviderRegistry

public FormFactoryProviderRegistry(AppContext conn)

Method Detail

getTransitionProvider

public TransitionProvider getTransitionProvider(java.lang.String name)

Specified by:

getTransitionProvider in interface TransitionFactoryCreator<TransitionProvider>

Parameters:

name - TargetName used for the TransitionProvider

Returns:

TransitionProvider

getTransitionProvider

public TransitionProvider<FormOperations,T> getTransitionProvider(FormFactoryProvider<T> provider)

getMap

protected abstract java.util.Map<java.lang.String,T> getMap()

get a map from the cleaned cleanType(String) tag to the FormFactoryProvider. This is abstract to allow the map to be declared static.

Returns:

getGroup

public abstract java.lang.String getGroup()

get the tag used to produce this class via AppContext.getFactory

Returns:

String group used to identify this class

getTitle

public abstract java.lang.String getTitle()

Subject are to use in form title

Returns:

String subject

getTypes

public java.util.Iterator<T> getTypes()

Return all FormTypes. This is for use in unit tests

Returns:

Iterator

getUpdaters

public java.util.Iterator<T> getUpdaters(SessionService p)

Get all FormTypes that a person can update

Parameters:

p - Person

Returns:

Iterator

getCreators

public java.util.Iterator<T> getCreators(SessionService p)

Get all FormTypes that a person can create

Parameters:

p - Person

Returns:

Iterator

find

public T find(java.lang.String name)

getTag

public java.lang.String getTag(FormFactoryProvider e)

cleanType

public static java.lang.String cleanType(java.lang.String type)

map a tag string to something that won't break the TransitionServlet

Parameters:

type -

Returns:

modified type string

makeTag

public static java.lang.String makeTag(java.lang.String group,
                                       java.lang.String type)

getGroup

public static java.lang.String getGroup(java.lang.String tag)

getType

public static java.lang.String getType(java.lang.String tag)

addContent

public ContentBuilder addContent(ContentBuilder builder)

Specified by:

addContent in interface UIGenerator

makeNode

public Node makeNode(java.lang.String name,
                     FilteredProperties props)

Description copied from interface: NodeMaker

Create a Node for a named menu item. This is allowed to return null to indicate that nodes of this type are disabled/empty and should be suppressed. The NavigationMenuService can be configured to substitute a different node in this case (for example to host child nodes added by the configuration).

Automatic child nodes can be added in this method and will appear first. Followed by nodes from the configuration then nodes from NodeMaker.addChildren(Node, String, FilteredProperties)

Specified by:

makeNode in interface NodeMaker

Parameters:

name - name of the node

props - FilteredProperties containing the navigation menu configuration

Returns:

Node

addChildren

public void addChildren(Node parent,
                        java.lang.String name,
                        FilteredProperties props)

Description copied from interface: NodeMaker

Add additional child nodes specific to the NodeMaker. This is intended for Nodes based on the current user or their roles. It is a separate method so the dynamically generated nodes are added after any specified in the configuration. Dynamic nodes that should appear first can be added directly in NodeMaker.makeNode(String, FilteredProperties)

Specified by:

addChildren in interface NodeMaker