org.dspace.app.xmlui.aspect.eperson
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.eperson.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

Add the eperson navigation items to the document. This includes: 1) Login and Logout links 2) Navigational links to register or edit their profile based upon wheather the user is authenticatied or not. 3) User metadata 4) The user's language prefrences (wheather someone is logged in or not)

Author:

Scott Phillips

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

void	addOptions(Options options) Add the eperson aspect navigational options.
void	addUserMeta(UserMeta userMeta) Add the user metadata
java.io.Serializable	getKey() Generate the unique key.
org.apache.excalibur.source.SourceValidity	getValidity() Generate the validity object.
void	recycle() recycle

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

addBody, addPageMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, 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

Navigation

public Navigation()

Method Detail

getKey

public java.io.Serializable getKey()

Generate the unique key. This key must be unique inside the space of this component.

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.

addOptions

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

Add the eperson aspect navigational options.

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

addUserMeta

public void addUserMeta(UserMeta userMeta)
                 throws org.xml.sax.SAXException,
                        WingException,
                        UIException,
                        java.sql.SQLException,
                        java.io.IOException,
                        AuthorizeException

Add the user metadata

Specified by:

addUserMeta in interface DSpaceTransformer

Specified by:

addUserMeta in interface WingTransformer

Overrides:

addUserMeta in class AbstractDSpaceTransformer

Throws:

org.xml.sax.SAXException

WingException

UIException

java.sql.SQLException

java.io.IOException

AuthorizeException

recycle

public void recycle()

recycle

Specified by:

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

Overrides:

recycle in class AbstractDSpaceTransformer