uk.ac.ed.epcc.webapp.editors.xml

Class DomTransitionProvider

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.model.data.transition.AbstractTransitionFactory<T,K>

uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewTransitionFactory<T,K>

uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewPathTransitionProvider<XMLTarget,XMLKey>

uk.ac.ed.epcc.webapp.editors.xml.DomTransitionProvider

All Implemented Interfaces:

Contexed, ContextCached, PathTransitionProvider<XMLKey,XMLTarget>, TransitionFactory<XMLKey,XMLTarget>, ViewTransitionFactory<XMLKey,XMLTarget>

public class DomTransitionProvider
extends AbstractViewPathTransitionProvider<XMLTarget,XMLKey>
implements PathTransitionProvider<XMLKey,XMLTarget>, ViewTransitionFactory<XMLKey,XMLTarget>

a PathTransitionProvider for editing XML documents. While a full schema driven interface seems to be impractically difficult. at the moment it should be posible to use the schema to:

• mark up syntax errors at the location they occur.
• provide optional choices for elements/namespaces (maybe only those already used in document).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomTransitionProvider.DeleteTransition
static class	DomTransitionProvider.DownLoadTransition
static class	DomTransitionProvider.EditAction
static class	DomTransitionProvider.EditNodeAction
static class	DomTransitionProvider.EditNodeTransition
static class	DomTransitionProvider.EditTransition
static class	DomTransitionProvider.HasParentKey
static class	DomTransitionProvider.ParentTransition

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewTransitionFactory

AbstractViewTransitionFactory.ViewResult, AbstractViewTransitionFactory.ViewTransition

Field Summary

Fields

Modifier and Type	Field and Description
static XMLKey	DELETE_KEY
static XMLKey	DOWNLOAD_KEY
static XMLKey	EDIT_NODE_KEY
static XMLKey	EDIT_TEXT_KEY
static XMLKey	PARENT_KEY

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

conn

Constructor Summary

Constructors

Constructor and Description
DomTransitionProvider(AppContext c)

Method Summary

Modifier and Type	Method and Description
boolean	allowTransition(AppContext c, XMLTarget target, XMLKey key) Access control check.
boolean	canView(XMLTarget target, SessionService<?> sess) Can the current person view this target
static java.lang.String	formatPath(java.util.LinkedList<java.lang.String> path)
java.util.LinkedList<java.lang.String>	getID(XMLTarget target) Get the id string for form posts from a target
<X extends ContentBuilder> X	getLogContent(X cb, XMLTarget 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, XMLTarget target) Get target summary to be shown on transition page.
XMLTarget	getTarget(java.util.LinkedList<java.lang.String> id) Find target type by id string
java.lang.String	getTargetName() What is the name for this type of transition.
static XMLTarget	makeXMLTarget(java.util.LinkedList<java.lang.String> id, AppContext conn)

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewPathTransitionProvider

accept

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewTransitionFactory

getBottomContent, getHelp, getText, getTopContent

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.transition.AbstractTransitionFactory

addTransition, getTransition, getTransition, getTransitions, lookupTransition, sortByKey

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

accept

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.ViewTransitionFactory

getBottomContent, getHelp, getText, getTopContent, showTransition

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.TransitionFactory

getTransition, getTransitions, lookupTransition

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

getContext

Field Detail

DELETE_KEY

public static XMLKey DELETE_KEY

PARENT_KEY

public static XMLKey PARENT_KEY

EDIT_TEXT_KEY

public static XMLKey EDIT_TEXT_KEY

EDIT_NODE_KEY

public static XMLKey EDIT_NODE_KEY

DOWNLOAD_KEY

public static XMLKey DOWNLOAD_KEY

Constructor Detail

DomTransitionProvider

public DomTransitionProvider(AppContext c)

Method Detail

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<XMLKey,XMLTarget>

Returns:

String

allowTransition

public boolean allowTransition(AppContext c,
                               XMLTarget target,
                               XMLKey key)

Description copied from interface: TransitionFactory

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

Specified by:

allowTransition in interface TransitionFactory<XMLKey,XMLTarget>

Parameters:

c - AppContext

target - target object

key - identifying key object for transition

Returns:

boolean is operation allowed

getSummaryContent

public <X extends ContentBuilder> X getSummaryContent(AppContext c,
                                                      X cb,
                                                      XMLTarget 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<XMLKey,XMLTarget>

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

canView

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

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<XMLKey,XMLTarget>

Returns:

boolean

getTarget

public XMLTarget getTarget(java.util.LinkedList<java.lang.String> id)

Description copied from interface: PathTransitionProvider

Find target type by id string

Specified by:

getTarget in interface PathTransitionProvider<XMLKey,XMLTarget>

Returns:

target or null

makeXMLTarget

public static XMLTarget makeXMLTarget(java.util.LinkedList<java.lang.String> id,
                                      AppContext conn)

formatPath

public static java.lang.String formatPath(java.util.LinkedList<java.lang.String> path)

getID

public java.util.LinkedList<java.lang.String> getID(XMLTarget target)

Description copied from interface: PathTransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface PathTransitionProvider<XMLKey,XMLTarget>

Returns:

id value

getLogContent

public <X extends ContentBuilder> X getLogContent(X cb,
                                                  XMLTarget 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<XMLKey,XMLTarget>

Overrides:

getLogContent in class AbstractViewTransitionFactory<XMLTarget,XMLKey>

Returns:

ContentBuilder