uk.ac.ed.epcc.webapp.jdbc.table

Class TableTransitionProvider

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionProvider

All Implemented Interfaces:

Contexed, IndexTransitionFactory<TableTransitionKey,DataObjectFactory>, IndexTransitionProvider<TableTransitionKey,DataObjectFactory>, TransitionFactory<TableTransitionKey,DataObjectFactory>, TransitionProvider<TableTransitionKey,DataObjectFactory>, ViewTransitionFactory<TableTransitionKey,DataObjectFactory>, ViewTransitionProvider<TableTransitionKey,DataObjectFactory>

public class TableTransitionProvider
extends AbstractContexed
implements ViewTransitionProvider<TableTransitionKey,DataObjectFactory>, IndexTransitionProvider<TableTransitionKey,DataObjectFactory>

Class implementing transitions on factory classes identified by table. The target factory must have its class registered as a configuration property. This TransitionProvider needs to be registered under the name Table to enable this feature.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TableTransitionProvider.IndexTransition
class	TableTransitionProvider.UploadTransition A transition to upload an XML dump into the table.

Field Summary

Fields

Modifier and Type	Field and Description
static TableTransitionKey	INDEX
static java.lang.String	TABLE_INDEX_ROLE
static java.lang.String	TABLE_TRANSITION_TAG
static TableTransitionKey	UPLOAD
static Feature	UPLOAD_XML_FEATURE

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

conn

Constructor Summary

Constructors

Constructor and Description
TableTransitionProvider(AppContext conn)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(TransitionFactoryVisitor<R,DataObjectFactory,TableTransitionKey> vis) Accept a TransitionFactoryVisitor.
boolean	allowTransition(AppContext c, DataObjectFactory target, TableTransitionKey name) Access control check.
boolean	canView(DataObjectFactory target, SessionService<?> sess) Can the current person view this target
<X extends ContentBuilder> X	getBottomContent(X hb, DataObjectFactory target, SessionService<?> sess) Get the content to be displayed at the bottom of the target page.
java.util.Set<java.lang.String>	getConfigProperties(DataObjectFactory<?> target) get a set of configuration parameters that configure this object.
java.lang.String	getHelp(TableTransitionKey key) Get tooltip help string for an operation
java.lang.String	getID(DataObjectFactory target) Get the id string for form posts from a target
TableTransitionKey	getIndexTransition() Get the key for the default index transition.
<X extends ContentBuilder> X	getLogContent(X hb, DataObjectFactory target, SessionService<?> sess) Get the content to be displayed on the view target page as part of the target pane.
<X extends ContentBuilder> X	getSummaryContent(AppContext c, X cb, DataObjectFactory target) Get target summary to be shown on transition page.
DataObjectFactory	getTarget(java.lang.String id) Find target type by id string
java.lang.String	getTargetName() What is the name for this type of transition.
java.lang.String	getText(TableTransitionKey key) get custom button content.
<X extends ContentBuilder> X	getTopContent(X hb, DataObjectFactory target, SessionService<?> sess) Get the content to be displayed at the top of the target page.
Transition<DataObjectFactory>	getTransition(DataObjectFactory target, TableTransitionKey key) Find a transition operator for this type by key.
java.util.Set<TableTransitionKey>	getTransitions(DataObjectFactory target) Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition.
TableTransitionKey	lookupTransition(DataObjectFactory target, java.lang.String name) Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

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.forms.transition.ViewTransitionFactory

showTransition

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

getContext

Field Detail

UPLOAD_XML_FEATURE

public static final Feature UPLOAD_XML_FEATURE

TABLE_INDEX_ROLE

public static final java.lang.String TABLE_INDEX_ROLE

See Also:

Constant Field Values

TABLE_TRANSITION_TAG

public static final java.lang.String TABLE_TRANSITION_TAG

See Also:

Constant Field Values

INDEX

public static final TableTransitionKey INDEX

UPLOAD

public static final TableTransitionKey UPLOAD

Constructor Detail

TableTransitionProvider

public TableTransitionProvider(AppContext conn)

Method Detail

getConfigProperties

public java.util.Set<java.lang.String> getConfigProperties(DataObjectFactory<?> target)

get a set of configuration parameters that configure this object. This is used to produce a generic configuration table transtition.

Returns:

allowTransition

public boolean allowTransition(AppContext c,
                               DataObjectFactory target,
                               TableTransitionKey name)

Description copied from interface: TransitionFactory

Access control check. Is this transition allowed for the current user/target

Specified by:

allowTransition in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Parameters:

c - AppContext

target - target object

name - identifying key object for transition

Returns:

boolean is operation allowed

getID

public java.lang.String getID(DataObjectFactory target)

Description copied from interface: TransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface TransitionProvider<TableTransitionKey,DataObjectFactory>

Returns:

id value

getSummaryContent

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

Description copied from interface: TransitionFactory

Get target summary to be shown on transition page. In html this content is embedded within a div.block element.

Specified by:

getSummaryContent in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

getTarget

public DataObjectFactory getTarget(java.lang.String id)

Description copied from interface: TransitionProvider

Find target type by id string

Specified by:

getTarget in interface TransitionProvider<TableTransitionKey,DataObjectFactory>

Returns:

target or null

getTargetName

public java.lang.String getTargetName()

Description copied from interface: TransitionFactory

What is the name for this type of transition. This value needs to resolve to the TransitionProvider in the TransitionServlet The value can also be used as the user presented text for the type of object in the title of the transition form page though this can be overridden by setting target-name.transition_title

Specified by:

getTargetName in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

String

canView

public boolean canView(DataObjectFactory target,
                       SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

boolean

getLogContent

public <X extends ContentBuilder> X getLogContent(X hb,
                                                  DataObjectFactory target,
                                                  SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed on the view target page as part of the target pane.

Specified by:

getLogContent in interface ViewTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

ContentBuilder

getTopContent

public <X extends ContentBuilder> X getTopContent(X hb,
                                                  DataObjectFactory target,
                                                  SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed at the top of the target page. This content is at the top level of the page

Specified by:

getTopContent in interface ViewTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

boolean

getBottomContent

public <X extends ContentBuilder> X getBottomContent(X hb,
                                                     DataObjectFactory target,
                                                     SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed at the bottom of the target page. This content is at the top level of the page

Specified by:

getBottomContent in interface ViewTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

boolean

getHelp

public java.lang.String getHelp(TableTransitionKey key)

Description copied from interface: ViewTransitionFactory

Get tooltip help string for an operation

Specified by:

getHelp in interface ViewTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

String or null

getText

public java.lang.String getText(TableTransitionKey key)

Description copied from interface: ViewTransitionFactory

get custom button content. should default to the string representation of the key

Specified by:

getText in interface ViewTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

String

getIndexTransition

public TableTransitionKey getIndexTransition()

Description copied from interface: IndexTransitionFactory

Get the key for the default index transition. This method can return null if a sub-class wants to supress the default transition.

Specified by:

getIndexTransition in interface IndexTransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

transition key

accept

public <R> R accept(TransitionFactoryVisitor<R,DataObjectFactory,TableTransitionKey> vis)

Description copied from interface: TransitionFactory

Accept a TransitionFactoryVisitor. Any code that depends on the particular sub-interface of TransitionFactory should implement TransitionFactoryVisitor this ensures it will always handle all possible sub-classes.

Specified by:

accept in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Specified by:

accept in interface TransitionProvider<TableTransitionKey,DataObjectFactory>

Returns:

getTransitions

public java.util.Set<TableTransitionKey> getTransitions(DataObjectFactory target)

Description copied from interface: TransitionFactory

Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition. Options in this list that are not allowed by TransitionFactory.allowTransition(AppContext, Object, Object) will not be presented. Additional hidden operations may also be supported but these will never be presented to the user as options and can only generated as a ChainedTransitionResult. In most cases the transition set will be the same for all null/non-null targets though in principal dynamic transitions could be generated based on the state of the target e.g. a parameterised transition with the parameter encoded in the key.

Specified by:

getTransitions in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Returns:

Set of keys

getTransition

public Transition<DataObjectFactory> getTransition(DataObjectFactory target,
                                                   TableTransitionKey key)

Description copied from interface: TransitionFactory

Find a transition operator for this type by key. This method is permitted to return null for example if the current user is not permitted to perform the transition.

Specified by:

getTransition in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Parameters:

target - target (may be null)

key - key

Returns:

Transition or null

lookupTransition

public TableTransitionKey lookupTransition(DataObjectFactory target,
                                           java.lang.String name)

Description copied from interface: TransitionFactory

Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

Specified by:

lookupTransition in interface TransitionFactory<TableTransitionKey,DataObjectFactory>

Parameters:

target - (may be null)

Returns:

Transition key