org.dspace.app.xmlui.aspect.submission.submit

Class DescribeStep

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

org.dspace.app.xmlui.aspect.submission.AbstractSubmissionStep

org.dspace.app.xmlui.aspect.submission.submit.DescribeStep

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 DescribeStep
extends AbstractSubmissionStep

This is a step of the item submission processes. The describe step queries the user for various metadata items about the item. For the most part all the questions queried are completely configurable via the input-sets.xml file. This system allows for multiple pages to be defined so this step is different from all other stages in that it may represent multiple stages within the submission processes.

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission)

Field Summary

Fields

Modifier and Type	Field and Description
protected ChoiceAuthorityService	choiceAuthorityService
protected DCInputsReader	inputsReader
protected ItemService	itemService
protected MetadataAuthorityService	metadataAuthorityService
protected static Message	T_day
protected static Message	T_first_name_help
protected static Message	T_head Language Strings
protected static Message	T_last_name_help
protected static Message	T_month
protected static Message	T_report_no
protected static Message	T_required_field
protected static Message	T_series_name
protected static Message	T_unknown_field
protected static Message	T_year

Fields inherited from class org.dspace.app.xmlui.aspect.submission.AbstractStep

errorFields, errorFlag, handle, id, requireHandle, requireStep, requireSubmission, requireWorkflow, requireWorkspace, stepAndPage, submission, submissionInfo, T_complete, T_creative_commons, T_default_title, T_default_trail, T_describe, T_dspace_home, T_initial_questions, T_license, T_next, T_previous, T_review, T_save, T_showfull, T_showsimple, T_submission_head, T_submission_title, T_submission_trail, T_upload, T_workflow_head, T_workflow_title, T_workflow_trail

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
DescribeStep() Establish our required parameters.

Method Summary

Modifier and Type	Method and Description
void	addBody(Body body) Abstract implementations of WingTransformer.
void	addPageMeta(PageMeta pageMeta) Base pageMeta that is added to ALL submission stages
List	addReviewSection(List reviewList) Each submission step must define its own information to be reviewed during the final Review/Verify Step in the submission process.
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 page's parameters from the sitemap.

Methods inherited from class org.dspace.app.xmlui.aspect.submission.AbstractStep

addControlButtons, addJumpButton, addSubmissionProgressList, getErrorFields, getMaxStepAndPageReached, getPage, getStep, isFirstStep, isLastStep

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

addOptions, addUserMeta, 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

T_head

protected static final Message T_head

Language Strings

T_unknown_field

protected static final Message T_unknown_field

T_required_field

protected static final Message T_required_field

T_last_name_help

protected static final Message T_last_name_help

T_first_name_help

protected static final Message T_first_name_help

T_year

protected static final Message T_year

T_month

protected static final Message T_month

T_day

protected static final Message T_day

T_series_name

protected static final Message T_series_name

T_report_no

protected static final Message T_report_no

itemService

protected ItemService itemService

choiceAuthorityService

protected ChoiceAuthorityService choiceAuthorityService

metadataAuthorityService

protected MetadataAuthorityService metadataAuthorityService

inputsReader

protected DCInputsReader inputsReader

Constructor Detail

DescribeStep

public DescribeStep()

Establish our required parameters. AbstractStep will enforce these.

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

Description copied from class: AbstractStep

Grab all the page'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 AbstractStep

Parameters:

resolver - source resolver.

objectModel - TBD

src - TBD

parameters - sitemap parameters.

Throws:

org.apache.cocoon.ProcessingException - passed through.

SAXException - passed through.

IOException - passed through.

addPageMeta

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

Description copied from class: AbstractStep

Base pageMeta that is added to ALL submission stages

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractStep

Parameters:

pageMeta - to be added.

Throws:

SAXException - passed through.

WingException - passed through.

UIException - passed through.

SQLException - passed through.

IOException - passed through.

AuthorizeException - passed through.

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    IOException,
                    AuthorizeException

Description copied from class: AbstractWingTransformer

Abstract implementations of WingTransformer.

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.

addReviewSection

public List addReviewSection(List reviewList)
                      throws SAXException,
                             WingException,
                             UIException,
                             SQLException,
                             IOException,
                             AuthorizeException

Each submission step must define its own information to be reviewed during the final Review/Verify Step in the submission process.

The information to review should be tacked onto the passed in List object.

NOTE: To remain consistent across all Steps, you should first add a sub-List object (with this step's name as the heading), by using a call to reviewList.addList(). This sublist is the list you return from this method!

Specified by:

addReviewSection in class AbstractSubmissionStep

Parameters:

reviewList - The List to which all reviewable information should be added

Returns:

The new sub-List object created by this step, which contains all the reviewable information. If this step has nothing to review, then return null!

Throws:

SAXException - passed through.

WingException - passed through.

UIException - on reader error.

SQLException - passed through.

IOException - passed through.

AuthorizeException - passed through.

recycle

public void recycle()

Description copied from class: AbstractWingTransformer

Recycle.

Specified by:

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

Overrides:

recycle in class AbstractStep