org.dspace.app.xmlui.aspect.general

Class NoticeTransformer

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.general.NoticeTransformer

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, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

public class NoticeTransformer
extends AbstractDSpaceTransformer

This class will add a simple notification div the DRI document. Typically this transformer is used after an action has been performed to let the user know if an operation succeeded or failed. The possible paramaters are: outcome: The outcome determines whether the notice is positive or negative. Possible values are: "success", "failure", or "neutral". If no values are supplied then neutral is assumed. header: An i18n dictionary key referencing the text that should be used as a header for this notice. message: An i18n dictionary key referencing the text that should be used as the content for this notice. characters: Plain text string that should be used as the content for this notice. Normally, all messages should be i18n dictionary keys, however this parameter is useful for error messages that are not necessarily translated. All parameters are optional but you must supply at least the message or the characters Example:

Author:

Scott Phillips, Alexey Maslov

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addBody(Body body) Add the notice div to the body.

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

addOptions, addPageMeta, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, recycle, setup

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

Constructor Detail

NoticeTransformer

public NoticeTransformer()

Method Detail

addBody

public void addBody(Body body)
             throws WingException,
                    java.sql.SQLException,
                    AuthorizeException

Add the notice div to the body.

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Throws:

WingException

java.sql.SQLException

AuthorizeException