org.dspace.app.xmlui.wing

Class Include

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.Include

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, ContentHandler, LexicalHandler

public class Include
extends org.apache.cocoon.transformation.AbstractTransformer
implements org.apache.cocoon.caching.CacheableProcessingComponent

The Include class reads an DRI XML file from and merges it into the existing document stream using the Wing framework. If the file is not present at the source provided a blank document is merged, allowing the pipeline to continue excecution. This is also logged as a warning.

Author:

Scott Phillips

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] c, int start, int len) Receive notification of character data.
void	endDocument() Receive notification of the end of a document.
void	endElement(String uri, String localName, String qName) Receive notification of the end of an element.
Serializable	getKey() Generate the unique key.
org.apache.excalibur.source.SourceValidity	getValidity() Generate the validity object.
void	recycle() Recycle
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters) Read in the given src path into an internal DOM for later processing when needed.
void	startDocument() Receive notification of the beginning of a document.
void	startElement(String uri, String localName, String qName, Attributes attributes) Receive notification of the beginning of an element.

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

comment, endCDATA, endDTD, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity, startPrefixMapping

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

endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping

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

Include

public Include()

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

Read in the given src path into an internal DOM for later processing when needed.

Specified by:

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

Parameters:

resolver - Resolver for cocoon pipelines.

objectModel - The pipelines's object model.

src - The source parameter

parameters - The transformer's parameters.

Throws:

org.apache.cocoon.ProcessingException

SAXException

IOException

getKey

public 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.

startDocument

public void startDocument()
                   throws SAXException

Receive notification of the beginning of a document.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Receive notification of the end of a document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.apache.cocoon.xml.AbstractXMLPipe

Throws:

SAXException

startElement

public void startElement(String uri,
                String localName,
                String qName,
                Attributes attributes)
                  throws SAXException

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

attributes - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

SAXException

endElement

public void endElement(String uri,
              String localName,
              String qName)
                throws SAXException

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

Throws:

SAXException

characters

public void characters(char[] c,
              int start,
              int len)
                throws SAXException

Receive notification of character data.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

c - The characters from the XML document.

start - The start position in the array.

len - The number of characters to read from the array.

Throws:

SAXException

recycle

public void recycle()

Recycle

Specified by:

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

Overrides:

recycle in class org.apache.cocoon.xml.AbstractXMLProducer