org.dspace.app.xmlui.cocoon

Class AbstractDSpaceTransformer

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

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:

AbstractRecentSubmissionTransformer, AbstractSearch, AbstractSearch, AbstractStatisticsDataTransformer, AbstractStep, AbstractXMLUIAction, AccessStepUtil, AddBitstreamForm, AddEPersonForm, AdvacedAuthorizationsForm, AdvancedFormTest, AssignCollectionRoles, AssignCommunityRoles, AuthorizationMain, BasicFormTest, BrowseFacet, BrowseItemForm, CannotRegister, ChoiceLookupTransformer, CollectionBrowse, CollectionRecentSubmissions, CollectionSearch, CollectionSearch, CollectionViewer, CollectionViewer, CommunityBrowse, CommunityBrowser, CommunityRecentSubmissions, CommunitySearch, CommunitySearch, CommunityViewer, ConfigurableBrowse, ConfirmItemForm, Contact, ControlledVocabularyTransformer, ControlPanel, CreateCollectionForm, CreateCommunityForm, CurateCollectionForm, CurateCommunityForm, CurateForm, CurateItemForm, DeleteBitstreamFormatsConfirm, DeleteBitstreamsConfirm, DeleteCollectionConfirm, DeleteCollectionRoleConfirm, DeleteCommunityConfirm, DeleteCommunityRoleConfirm, DeleteEPeopleConfirm, DeleteGroupsConfirm, DeleteMetadataFieldsConfirm, DeleteMetadataSchemaConfirm, DeletePoliciesConfirm, DeleteVersionsConfirm, EditBitstreamForm, EditBitstreamFormat, EditCollectionHarvestingForm, EditCollectionMetadataForm, EditCommunityMetadataForm, EditContainerPolicies, EditEPersonForm, EditGroupForm, EditItemBitstreamsForm, EditItemMetadataForm, EditItemPolicies, EditItemStatusForm, EditMetadataSchema, EditPolicyForm, EditProfile, ElasticSearchStatsViewer, FailedAuthentication, FeedbackForm, FeedbackSent, FindItemForm, ForgotPasswordFinished, FormatRegistryMain, FrontPageFeeds, HTMLTest, InlineFormTest, InvalidToken, ItemExport, ItemRequestChangeStatusForm, ItemRequestForm, ItemRequestResponseDecisionForm, ItemRequestResponseFalseForm, ItemRequestResponseTrueForm, ItemRequestSent, ItemRequestStatusChanged, ItemViewer, LDAPLogin, LoginChooser, ManageEPeopleMain, ManageGroupsMain, MapperMain, MetadataImportConfirm, MetadataImportMain, MetadataImportUpload, MetadataRegistryMain, MoveItemForm, MoveMetadataFields, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, Navigation, NotAuthorized, NoticeTransformer, PageNotFoundTransformer, PasswordLogin, PrivateItems, ProfileUpdated, RecentSubmissionTransformer, RegistrationFinished, RelatedItems, ResetPassword, RestoreVersionForm, RestrictedItem, SearchFacetFilter, SearchItemForm, SelectCollectionTransformer, SelectPackagingTransformer, SelectTargetTransformer, SetupCollectionHarvestingForm, SidebarFacetsTransformer, SiteViewer, StartForgotPassword, StartRegistration, StaticPage, StatisticsSearchResultTransformer, StatisticsTransformer, StatisticsViewer, StepTransformer, StructureTest, Submissions, Submissions, Submissions, SwordResponseTransformer, SystemwideAlerts, ToggleCollectionHarvestingForm, VerifyEmail, VersionHistoryForm, VersionItemForm, VersionNoticeTransformer, VersionUpdateForm, ViewItem, WithdrawnItems, WorkflowExceptionTransformer, WorkflowItemTransformer, WorkflowOverviewTransformer, WorkflowTransformer

public abstract class AbstractDSpaceTransformer
extends AbstractWingTransformer
implements DSpaceTransformer

Author:

Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	context
protected String	contextPath
protected EPerson	eperson
protected org.apache.cocoon.components.flow.WebContinuation	knot
protected Map	objectModel
protected org.apache.avalon.framework.parameters.Parameters	parameters
protected String	servletPath
protected String	sitemapURI
protected String	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
AbstractDSpaceTransformer()

Method Summary

Methods

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
static String	decodeFromURL(String encodedString) Decode the given string from URL transmission.
void	dispose() Dispose
static String	encodeForURL(String unencodedString) Encode the given string for URL transmission.
static String	generateURL(String baseURL, Map<String,String> parameters) Generate a URL for the given base URL with the given parameters.
String	getComponentName() What is a unique name for this component?
ObjectManager	getObjectManager() Return the ObjectManager associated with this component.
protected void	handleException(Exception e) Handle exceptions that occurred during the document's creation.
void	recycle() Recyle
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters)

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

objectModel

protected Map objectModel

context

protected Context context

contextPath

protected String contextPath

servletPath

protected String servletPath

sitemapURI

protected String sitemapURI

url

protected String url

parameters

protected org.apache.avalon.framework.parameters.Parameters parameters

eperson

protected EPerson eperson

knot

protected org.apache.cocoon.components.flow.WebContinuation knot

Constructor Detail

AbstractDSpaceTransformer

public AbstractDSpaceTransformer()

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

Specified by:

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

Throws:

org.apache.cocoon.ProcessingException

SAXException

IOException

handleException

protected void handleException(Exception e)
                        throws SAXException

Description copied from class: AbstractWingTransformer

Handle exceptions that occurred during the document's creation. When errors occur a SAX event is being processed it will be sent through this method. This allows implementing classes to override this method for specific error handling hooks.

Overrides:

handleException in class AbstractWingTransformer

Parameters:

e - The thrown exception

Throws:

SAXException

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 AbstractWingTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

org.apache.cocoon.ProcessingException

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 AbstractWingTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

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 AbstractWingTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

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 AbstractWingTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

getObjectManager

public ObjectManager getObjectManager()

Description copied from class: AbstractWingTransformer

Return the ObjectManager associated with this component. If no objectManager needed then return null.

Overrides:

getObjectManager in class AbstractWingTransformer

getComponentName

public String getComponentName()

What is a unique name for this component?

Specified by:

getComponentName in interface DSpaceTransformer

Specified by:

getComponentName in interface WingTransformer

Overrides:

getComponentName in class AbstractWingTransformer

encodeForURL

public static String encodeForURL(String unencodedString)
                           throws UIException

Encode the given string for URL transmission.

Parameters:

unencodedString - The unencoded string.

Returns:

The encoded string

Throws:

UIException

decodeFromURL

public static String decodeFromURL(String encodedString)
                            throws UIException

Decode the given string from URL transmission.

Parameters:

encodedString - The encoded string.

Returns:

The unencoded string

Throws:

UIException

generateURL

public static String generateURL(String baseURL,
                 Map<String,String> parameters)

Generate a URL for the given base URL with the given parameters. This is a convenance method to make it easier to generate URL references with parameters. Example Map parameters = new Map(); parameters.put("arg1","value1"); parameters.put("arg2","value2"); parameters.put("arg3","value3"); String url = genrateURL("/my/url",parameters); would result in the string: url == "/my/url?arg1=value1&arg2=value2&arg3=value3"

Parameters:

baseURL - The baseURL without any parameters.

parameters - The parameters to be encoded on in the URL.

Returns:

The parameterized Post URL.

recycle

public void recycle()

Recyle

Specified by:

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

Overrides:

recycle in class AbstractWingTransformer

dispose

public void dispose()

Dispose

Overrides:

dispose in class AbstractWingTransformer