org.dspace.app.xmlui.aspect.xmlworkflow

Class AbstractXMLUIAction

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.xml.AbstractXMLPipe

org.apache.cocoon.transformation.AbstractTransformer

org.dspace.app.xmlui.wing.AbstractWingTransformer

org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

org.dspace.app.xmlui.aspect.xmlworkflow.AbstractXMLUIAction

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, DSpaceTransformer, WingTransformer, ActionInterface, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

Direct Known Subclasses:

AcceptEditRejectAction, ClaimAction, FinalEditAction, ReviewAction, ScoreReviewAction, SelectReviewerAction, SingleUserReviewAction

public abstract class AbstractXMLUIAction
extends AbstractDSpaceTransformer
implements ActionInterface

This abstract class represents an abstract action in the xml workflow This class provides a placeholder for some utility methods

Author:

Bram De Schouwer (bram.deschouwer at dot com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	log
protected static Message	T_dspace_home
protected static Message	T_showfull
protected static Message	T_showsimple
protected static Message	T_workflow_head
protected static Message	T_workflow_title
protected static Message	T_workflow_trail
protected XmlWorkflowItem	workflowItem The current DSpace SubmissionInfo

Fields inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

context, contextPath, eperson, knot, objectModel, parameters, servletPath, sitemapURI, url

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractXMLUIAction()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addBody(Body body) What to add at the end of the body
void	addPageMeta(PageMeta pageMeta) What page metadata to add to the document
protected void	addWorkflowItemInformation(Division div, Item item, org.apache.cocoon.environment.Request request)
void	setup(org.apache.cocoon.environment.SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters parameters)

Methods inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

addOptions, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, recycle

Methods inherited from class org.dspace.app.xmlui.wing.AbstractWingTransformer

createWingDocument, endDocument, endElement, endPrefixMapping, getDefaultMessageCatalogue, message, message, setupWing, startDocument, startElement, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

log

protected static org.apache.log4j.Logger log

T_dspace_home

protected static final Message T_dspace_home

T_showfull

protected static final Message T_showfull

T_showsimple

protected static final Message T_showsimple

T_workflow_title

protected static final Message T_workflow_title

T_workflow_trail

protected static final Message T_workflow_trail

T_workflow_head

protected static final Message T_workflow_head

workflowItem

protected XmlWorkflowItem workflowItem

The current DSpace SubmissionInfo

Constructor Detail

AbstractXMLUIAction

public AbstractXMLUIAction()

Method Detail

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
         java.util.Map objectModel,
         java.lang.String src,
         org.apache.avalon.framework.parameters.Parameters parameters)
           throws org.apache.cocoon.ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException

Specified by:

setup in interface org.apache.cocoon.sitemap.SitemapModelComponent

Overrides:

setup in class AbstractDSpaceTransformer

Throws:

org.apache.cocoon.ProcessingException

org.xml.sax.SAXException

java.io.IOException

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws org.xml.sax.SAXException,
                        WingException,
                        UIException,
                        java.sql.SQLException,
                        java.io.IOException,
                        AuthorizeException

Description copied from class: AbstractDSpaceTransformer

What page metadata to add to the document

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractDSpaceTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

addBody

public abstract void addBody(Body body)
                      throws org.xml.sax.SAXException,
                             WingException,
                             java.sql.SQLException,
                             java.io.IOException,
                             AuthorizeException

Description copied from class: AbstractDSpaceTransformer

What to add at the end of the body

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Throws:

org.xml.sax.SAXException

WingException

java.sql.SQLException

java.io.IOException

AuthorizeException

addWorkflowItemInformation

protected void addWorkflowItemInformation(Division div,
                              Item item,
                              org.apache.cocoon.environment.Request request)
                                   throws WingException

Throws:

WingException