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

Class UploadStep

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

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

Direct Known Subclasses:

UploadWithEmbargoStep

public class UploadStep
extends AbstractSubmissionStep

This is a step of the item submission processes. The upload stages allow the user to upload files into the submission. The form is optimized for one file, but allows the user to upload more if needed.

The form is broken up into three sections:

Part A: Ask the user to upload a file Part B: List previously uploaded files Part C: The standard action bar

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission)

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemService	itemService
protected static Message	T_checksum
protected static Message	T_column0
protected static Message	T_column1
protected static Message	T_column2
protected static Message	T_column3
protected static Message	T_column4
protected static Message	T_column5
protected static Message	T_column6
protected static Message	T_description
protected static Message	T_description_help
protected static Message	T_file
protected static Message	T_file_error
protected static Message	T_file_help
protected static Message	T_head Language Strings for Uploading
protected static Message	T_head2
protected static Message	T_known
protected static Message	T_sherpa_colour
protected static Message	T_sherpa_consult
protected static Message	T_sherpa_journal
protected static Message	T_sherpa_more
protected static Message	T_sherpa_publisher
protected static Message	T_sherpa_title
protected static Message	T_submit_edit
protected static Message	T_submit_remove
protected static Message	T_submit_upload
protected static Message	T_supported
protected static Message	T_unknown_format
protected static Message	T_unknown_name
protected static Message	T_unsupported
protected static Message	T_upload_error
protected static Message	T_virus_checker_error
protected static Message	T_virus_error

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
UploadStep() Establish our required parameters, abstractStep will enforce these.

Method Summary

Modifier and Type	Method and Description
void	addBody(Body body) Abstract implementations of WingTransformer.
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	make_sherpaRomeo_submission(Item item, Division divIn) Sherpa RoMEO submission support.
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters) Check if user has requested to edit information about an uploaded file.

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

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

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 for Uploading

T_file

protected static final Message T_file

T_file_help

protected static final Message T_file_help

T_file_error

protected static final Message T_file_error

T_upload_error

protected static final Message T_upload_error

T_virus_checker_error

protected static final Message T_virus_checker_error

T_virus_error

protected static final Message T_virus_error

T_description

protected static final Message T_description

T_description_help

protected static final Message T_description_help

T_submit_upload

protected static final Message T_submit_upload

T_head2

protected static final Message T_head2

T_column0

protected static final Message T_column0

T_column1

protected static final Message T_column1

T_column2

protected static final Message T_column2

T_column3

protected static final Message T_column3

T_column4

protected static final Message T_column4

T_column5

protected static final Message T_column5

T_column6

protected static final Message T_column6

T_unknown_name

protected static final Message T_unknown_name

T_unknown_format

protected static final Message T_unknown_format

T_supported

protected static final Message T_supported

T_known

protected static final Message T_known

T_unsupported

protected static final Message T_unsupported

T_submit_edit

protected static final Message T_submit_edit

T_checksum

protected static final Message T_checksum

T_submit_remove

protected static final Message T_submit_remove

T_sherpa_consult

protected static final Message T_sherpa_consult

T_sherpa_title

protected static final Message T_sherpa_title

T_sherpa_journal

protected static final Message T_sherpa_journal

T_sherpa_publisher

protected static final Message T_sherpa_publisher

T_sherpa_colour

protected static final Message T_sherpa_colour

T_sherpa_more

protected static final Message T_sherpa_more

itemService

protected ItemService itemService

Constructor Detail

UploadStep

public UploadStep()

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

Check if user has requested to edit information about an uploaded file.

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.

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.

make_sherpaRomeo_submission

public void make_sherpaRomeo_submission(Item item,
                                        Division divIn)
                                 throws WingException

Sherpa RoMEO submission support.

Parameters:

item - the item in question.

divIn - add to this division.

Throws:

WingException - passed through.

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.

UIException - passed through.

SQLException - passed through.

IOException - passed through.

AuthorizeException - passed through.

WingException - whenever.