This project has retired. For details please refer to its Attic page.

org.apache.cocoon.transformation
Class AbstractDOMTransformer

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.apache.cocoon.transformation.AbstractDOMTransformer

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, Composable, LogEnabled, SitemapModelComponent, Transformer, DOMBuilder.Listener, XMLPipe, XMLProducer, XMLConsumer, ContentHandler, LexicalHandler

public abstract class AbstractDOMTransformer
extends AbstractTransformer
implements DOMBuilder.Listener, Composable, Disposable

An Abstract DOM Transformer, for use when a transformer needs a DOM-based view of the document. Subclass this interface and implement transform(Document doc). If you need a ComponentManager there is an instance variable manager for use.

Version:

CVS $Id: AbstractDOMTransformer.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Ross Burton, Bruce G. Robertson, Vadim Gritsenko

Field Summary

protected DOMBuilder	builder The DOMBuilder used to build DOM tree out of incoming SAX events.
protected ComponentManager	manager A ComponentManager which is available for use.
protected Map	objectModel The request object model
protected Parameters	parameters Parameters in the sitemap
protected SourceResolver	resolver The SAX entity resolver
protected String	source The URI requested

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

AbstractDOMTransformer()

Method Summary

void	characters(char[] c, int start, int len) Receive notification of character data.
void	comment(char[] ch, int start, int len) Report an XML comment anywhere in the document.
void	compose(ComponentManager manager) Set the component manager.
void	dispose() dispose
void	endCDATA() Report the end of a CDATA section.
void	endDocument() Receive notification of the end of a document.
void	endDTD() Report the end of DTD declarations.
void	endElement(String uri, String loc, String raw) Receive notification of the end of an element.
void	endEntity(String name) Report the end of an entity.
void	endPrefixMapping(String prefix) End the scope of a prefix-URI mapping.
void	ignorableWhitespace(char[] c, int start, int len) Receive notification of ignorable whitespace in element content.
void	notify(Document doc) This method is called when the Document is finished.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
void	recycle() Recycle the component.
void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters par) Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.
void	skippedEntity(String name) Receive notification of a skipped entity.
void	startCDATA() Report the start of a CDATA section.
void	startDocument() Receive notification of the beginning of a document.
void	startDTD(String name, String publicId, String systemId) Report the start of DTD declarations, if any.
void	startElement(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of an element.
void	startEntity(String name) Report the beginning of an entity.
void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.
protected abstract Document	transform(Document doc) Transform the specified DOM, returning a new DOM to stream down the pipeline.

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

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

resolver

protected SourceResolver resolver

The SAX entity resolver

objectModel

protected Map objectModel

The request object model

source

protected String source

The URI requested

parameters

protected Parameters parameters

Parameters in the sitemap

manager

protected ComponentManager manager

A ComponentManager which is available for use.

builder

protected DOMBuilder builder

The DOMBuilder used to build DOM tree out of incoming SAX events.

Constructor Detail

AbstractDOMTransformer

public AbstractDOMTransformer()

Method Detail

compose

public void compose(ComponentManager manager)

Set the component manager.

Specified by:

compose in interface Composable

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request. If you wish to process the parameters, override this method, call super() and then add your code.

Specified by:

setup in interface SitemapModelComponent

Throws:

ProcessingException

SAXException

IOException

recycle

public void recycle()

Recycle the component.

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractXMLProducer

dispose

public void dispose()

dispose

Specified by:

dispose in interface Disposable

notify

public void notify(Document doc)
            throws SAXException

This method is called when the Document is finished.

Specified by:

notify in interface DOMBuilder.Listener

Parameters:

doc - The DOM Document object representing this SAX stream

Throws:

SAXException

See Also:

DOMBuilder.Listener

transform

protected abstract Document transform(Document doc)

Transform the specified DOM, returning a new DOM to stream down the pipeline.

Parameters:

doc - The DOM Document representing the SAX stream

Returns:

A DOM Document to stream down the pipeline

setDocumentLocator

public void setDocumentLocator(Locator locator)

Description copied from class: AbstractXMLPipe

Receive an object for locating the origin of SAX document events.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class AbstractXMLPipe

Parameters:

locator - An object that can return the location of any SAX document event.

startDocument

public void startDocument()
                   throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the beginning of a document.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class AbstractXMLPipe

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the end of a document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class AbstractXMLPipe

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Description copied from class: AbstractXMLPipe

Begin the scope of a prefix-URI Namespace mapping.

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class AbstractXMLPipe

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Description copied from class: AbstractXMLPipe

End the scope of a prefix-URI mapping.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class AbstractXMLPipe

Parameters:

prefix - The prefix that was being mapping.

Throws:

SAXException

startElement

public void startElement(String uri,
                         String loc,
                         String raw,
                         Attributes a)
                  throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class 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.

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

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

a - 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 loc,
                       String raw)
                throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class 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.

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

raw - 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

Description copied from class: AbstractXMLPipe

Receive notification of character data.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class 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

ignorableWhitespace

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

Description copied from class: AbstractXMLPipe

Receive notification of ignorable whitespace in element content.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class 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

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of a processing instruction.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class AbstractXMLPipe

Parameters:

target - The processing instruction target.

data - The processing instruction data, or null if none was supplied.

Throws:

SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of a skipped entity.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class AbstractXMLPipe

Parameters:

name - The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException

startDTD

public void startDTD(String name,
                     String publicId,
                     String systemId)
              throws SAXException

Description copied from class: AbstractXMLPipe

Report the start of DTD declarations, if any.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class AbstractXMLPipe

Parameters:

name - The document type name.

publicId - The declared public identifier for the external DTD subset, or null if none was declared.

systemId - The declared system identifier for the external DTD subset, or null if none was declared.

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Description copied from class: AbstractXMLPipe

Report the end of DTD declarations.

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class AbstractXMLPipe

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Description copied from class: AbstractXMLPipe

Report the beginning of an entity.

Specified by:

startEntity in interface LexicalHandler

Overrides:

startEntity in class AbstractXMLPipe

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Description copied from class: AbstractXMLPipe

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Overrides:

endEntity in class AbstractXMLPipe

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Description copied from class: AbstractXMLPipe

Report the start of a CDATA section.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class AbstractXMLPipe

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Description copied from class: AbstractXMLPipe

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class AbstractXMLPipe

Throws:

SAXException

comment

public void comment(char[] ch,
                    int start,
                    int len)
             throws SAXException

Description copied from class: AbstractXMLPipe

Report an XML comment anywhere in the document.

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class AbstractXMLPipe

Parameters:

ch - An array holding the characters in the comment.

start - The starting position in the array.

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

Throws:

SAXException