org.dspace.app.xmlui.aspect.submission

Class StepTransformer

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.submission.StepTransformer

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, ContentHandler, LexicalHandler

public class StepTransformer
extends AbstractDSpaceTransformer

This generic transformer is used to generate the DRI for any Submission Step which extends the class org.dspace.app.xmlui.submission.AbstractStep

This transformer just initializes the current step class and calls the appropriate method(s) for the step.

Author:

Tim Donohue

See Also:

AbstractStep

Field Summary

Fields

Modifier and Type	Field and Description
protected String	collectionHandle The handle of the collection into which this DSpace item is being submitted
protected String	id The id of the currently active workspace or workflow, this contains the incomplete DSpace item

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
StepTransformer()

Method Summary

Modifier and Type	Method and Description
void	addBody(Body body) What to add at the end of the body
void	addOptions(Options options) What to add to the options list
void	addPageMeta(PageMeta pageMeta) What page metadata to add to the document
void	addUserMeta(UserMeta userMeta) What user metadata to add to the document
void	recycle() Recycle
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters) Grab all the step's parameters from the sitemap.

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

decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException

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

id

protected String id

The id of the currently active workspace or workflow, this contains the incomplete DSpace item

collectionHandle

protected String collectionHandle

The handle of the collection into which this DSpace item is being submitted

Constructor Detail

StepTransformer

public StepTransformer()

Method Detail

setup

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

Grab all the step's parameters from the sitemap. This includes workspaceID, step, and a list of errored fields. If the implementer set any required parameters then ensure that they are all present.

Specified by:

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

Overrides:

setup in class AbstractDSpaceTransformer

Throws:

org.apache.cocoon.ProcessingException

SAXException

IOException

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    IOException,
                    AuthorizeException,
                    org.apache.cocoon.ProcessingException

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

Parameters:

body - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

org.apache.cocoon.ProcessingException - whenever.

addOptions

public void addOptions(Options options)
                throws SAXException,
                       WingException,
                       UIException,
                       SQLException,
                       IOException,
                       AuthorizeException

What to add to the options list

Specified by:

addOptions in interface DSpaceTransformer

Specified by:

addOptions in interface WingTransformer

Overrides:

addOptions in class AbstractDSpaceTransformer

Parameters:

options - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

addUserMeta

public void addUserMeta(UserMeta userMeta)
                 throws SAXException,
                        WingException,
                        UIException,
                        SQLException,
                        IOException,
                        AuthorizeException

What user metadata to add to the document

Specified by:

addUserMeta in interface DSpaceTransformer

Specified by:

addUserMeta in interface WingTransformer

Overrides:

addUserMeta in class AbstractDSpaceTransformer

Parameters:

userMeta - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws SAXException,
                        WingException,
                        UIException,
                        SQLException,
                        IOException,
                        AuthorizeException

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

Parameters:

pageMeta - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

recycle

public void recycle()

Recycle

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class AbstractDSpaceTransformer