org.dspace.app.xmlui.aspect.administrative
Class Navigation

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.administrative.Navigation

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.caching.CacheableProcessingComponent, 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 Navigation
extends AbstractDSpaceTransformer
implements org.apache.cocoon.caching.CacheableProcessingComponent

Create the navigation options for everything in the administrative aspects. This includes Epeople, group, item, access control, and registry management.

Author:

Scott Phillips, Afonso Araujo Neto (internationalization), Alexey Maslov, Jay Paz

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

Navigation()

Method Summary

int	addContextualOptions(List context)
void	addOptions(Options options) What to add to the options list
java.io.Serializable	getKey() Generate the unique cache key.
org.apache.excalibur.source.SourceValidity	getValidity() Generate the validity object.
void	recycle() recycle
void	setup(org.apache.cocoon.environment.SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters parameters)

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

addBody, addPageMeta, 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

Constructor Detail

Navigation

public Navigation()

Method Detail

getKey

public java.io.Serializable getKey()

Generate the unique cache key.

Specified by:

getKey in interface org.apache.cocoon.caching.CacheableProcessingComponent

Returns:

The generated key hashes the src

getValidity

public org.apache.excalibur.source.SourceValidity getValidity()

Generate the validity object.

Specified by:

getValidity in interface org.apache.cocoon.caching.CacheableProcessingComponent

Returns:

The generated validity object or null if the component is currently not cacheable.

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
                  java.util.Map objectModel,
                  java.lang.String src,
                  org.apache.avalon.framework.parameters.Parameters parameters)
           throws org.apache.cocoon.ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException

Specified by:

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

Overrides:

setup in class AbstractDSpaceTransformer

Throws:

org.apache.cocoon.ProcessingException

org.xml.sax.SAXException

java.io.IOException

addOptions

public void addOptions(Options options)
                throws org.xml.sax.SAXException,
                       WingException,
                       UIException,
                       java.sql.SQLException,
                       java.io.IOException,
                       AuthorizeException

Description copied from class: AbstractDSpaceTransformer

What to add to the options list

Specified by:

addOptions in interface DSpaceTransformer

Specified by:

addOptions in interface WingTransformer

Overrides:

addOptions in class AbstractDSpaceTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

addContextualOptions

public int addContextualOptions(List context)
                         throws java.sql.SQLException,
                                WingException

Throws:

java.sql.SQLException

WingException

recycle

public void recycle()

recycle

Specified by:

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

Overrides:

recycle in class AbstractDSpaceTransformer