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

Class EditFileStep

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.submit.EditFileStep

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 EditFileStep
extends AbstractStep

This is a sub step of the Upload step during item submission. This page allows the user to edit metadata about a bitstream (aka file) that has been uploaded. The user can change the format or change the file's description.

Since this page is a sub step, the normal control actions are not present, the user only has the option of returning back to the upload step.

NOTE: As a sub step, it is called directly from the UploadStep class.

Author:

Scott Phillips, Tim Donohue (updated for Configurable Submission)

Field Summary

Fields

Modifier and Type	Field and Description
protected static Message	T_description
protected static Message	T_description_help
protected static Message	T_file
protected static Message	T_format_default
protected static Message	T_format_detected
protected static Message	T_format_selected
protected static Message	T_format_user
protected static Message	T_format_user_help
protected static Message	T_head Language Strings
protected static Message	T_info1
protected static Message	T_info2
protected static Message	T_submit_cancel
protected static Message	T_submit_save

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addBody(Body body) What to add at the end of the body
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters) Get the bitstream we are editing

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

T_file

protected static final Message T_file

T_description

protected static final Message T_description

T_description_help

protected static final Message T_description_help

T_info1

protected static final Message T_info1

T_format_detected

protected static final Message T_format_detected

T_format_selected

protected static final Message T_format_selected

T_format_default

protected static final Message T_format_default

T_info2

protected static final Message T_info2

T_format_user

protected static final Message T_format_user

T_format_user_help

protected static final Message T_format_user_help

T_submit_save

protected static final Message T_submit_save

T_submit_cancel

protected static final Message T_submit_cancel

Constructor Detail

EditFileStep

public EditFileStep()

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

Get the bitstream we are editing

Specified by:

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

Overrides:

setup in class AbstractStep

Throws:

org.apache.cocoon.ProcessingException

SAXException

IOException

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    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:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException