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

org.apache.cocoon.transformation
Class TeeTransformer

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.AbstractSAXTransformer
                      org.apache.cocoon.transformation.TeeTransformer

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, Configurable, LogEnabled, Serviceable, SitemapModelComponent, Transformer, XMLPipe, XMLProducer, XMLConsumer, ContentHandler, LexicalHandler

public class TeeTransformer
extends AbstractSAXTransformer

Version:

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

Field Summary

Fields inherited from class org.apache.cocoon.transformation.AbstractSAXTransformer

context, defaultNamespaceURI, EMPTY_ATTRIBUTES, emptyAttributes, ignoreEmptyCharacters, ignoreEventsCount, ignoreHooksCount, ignoreWhitespaces, manager, namespaceURI, objectModel, parameters, recorderStack, request, response, source, stack

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

TeeTransformer()

Method Summary

void	characters(char[] ch, 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	configure(Configuration configuration)
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[] ch, int start, int len) Receive notification of ignorable whitespace in element content.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
void	recycle() Recycle the producer by removing references, and resetting handlers to null (empty) implementations.
void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters parameters) 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.

Methods inherited from class org.apache.cocoon.transformation.AbstractSAXTransformer

addRecorder, dispose, endParametersRecording, endParametersRecording, endRecording, endSAXRecording, endSerializedXMLRecording, endTextRecording, endTransformingElement, findPrefixMapping, getMutableAttributes, removeRecorder, sendEndElementEvent, sendEndElementEventNS, sendEndPrefixMapping, sendEvents, sendParametersEvents, sendStartElementEvent, sendStartElementEvent, sendStartElementEventNS, sendStartElementEventNS, sendStartPrefixMapping, sendTextEvent, service, setupTransforming, startParametersRecording, startRecording, startSAXRecording, startSerializedXMLRecording, startTextRecording, startTransformingElement

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

Constructor Detail

TeeTransformer

public TeeTransformer()

Method Detail

setup

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

Description copied from interface: SitemapModelComponent

Set the SourceResolver, objectModel Map, the source and sitemap Parameters used to process the request.

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractSAXTransformer

Throws:

ProcessingException

SAXException

IOException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSAXTransformer

Throws:

ConfigurationException

setDocumentLocator

public void setDocumentLocator(Locator locator)

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

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class AbstractSAXTransformer

Parameters:

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

See Also:

ContentHandler.setDocumentLocator(org.xml.sax.Locator)

startDocument

public void startDocument()
                   throws SAXException

Receive notification of the beginning of a document.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class AbstractSAXTransformer

Throws:

SAXException

See Also:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

Receive notification of the end of a document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class AbstractSAXTransformer

Throws:

SAXException

See Also:

ContentHandler.endDocument()

startPrefixMapping

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

Begin the scope of a prefix-URI Namespace mapping.

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class AbstractSAXTransformer

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

SAXException

See Also:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

End the scope of a prefix-URI mapping.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class AbstractSAXTransformer

Parameters:

prefix - The prefix that was being mapping.

Throws:

SAXException

See Also:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

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

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class AbstractSAXTransformer

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

See Also:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(String uri,
                       String loc,
                       String raw)
                throws SAXException

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class AbstractSAXTransformer

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

See Also:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

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

Receive notification of character data.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class AbstractSAXTransformer

Parameters:

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

See Also:

ContentHandler.characters(char[], int, int)

ignorableWhitespace

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

Receive notification of ignorable whitespace in element content.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class AbstractSAXTransformer

Parameters:

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

See Also:

ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

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

Receive notification of a processing instruction.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class AbstractSAXTransformer

Parameters:

target - The processing instruction target.

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

Throws:

SAXException

See Also:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Receive notification of a skipped entity.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class AbstractSAXTransformer

Parameters:

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

Throws:

SAXException

See Also:

ContentHandler.skippedEntity(java.lang.String)

startDTD

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

Report the start of DTD declarations, if any.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class AbstractSAXTransformer

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

See Also:

LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)

endDTD

public void endDTD()
            throws SAXException

Report the end of DTD declarations.

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class AbstractSAXTransformer

Throws:

SAXException

See Also:

LexicalHandler.endDTD()

startEntity

public void startEntity(String name)
                 throws SAXException

Report the beginning of an entity.

Specified by:

startEntity in interface LexicalHandler

Overrides:

startEntity in class AbstractSAXTransformer

Parameters:

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

Throws:

SAXException

See Also:

LexicalHandler.startEntity(java.lang.String)

endEntity

public void endEntity(String name)
               throws SAXException

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Overrides:

endEntity in class AbstractSAXTransformer

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException

See Also:

LexicalHandler.endEntity(java.lang.String)

startCDATA

public void startCDATA()
                throws SAXException

Report the start of a CDATA section.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class AbstractSAXTransformer

Throws:

SAXException

See Also:

LexicalHandler.startCDATA()

endCDATA

public void endCDATA()
              throws SAXException

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class AbstractSAXTransformer

Throws:

SAXException

See Also:

LexicalHandler.endCDATA()

comment

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

Report an XML comment anywhere in the document.

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class AbstractSAXTransformer

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

See Also:

LexicalHandler.comment(char[], int, int)

recycle

public void recycle()

Description copied from class: AbstractXMLProducer

Recycle the producer by removing references, and resetting handlers to null (empty) implementations.

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractSAXTransformer