org.apache.cocoon.xml
Class IncludeXMLConsumer

java.lang.Object
  org.apache.cocoon.xml.IncludeXMLConsumer

All Implemented Interfaces:

XMLConsumer, ContentHandler, LexicalHandler

public class IncludeXMLConsumer
extends Object
implements XMLConsumer

A special purpose XMLConsumer which can:

• Trim empty characters if ignoreEmptyCharacters is set.
• Ignore root element if ignoreRootElement is set.
• Ignore startDocument, endDocument events.
• Ignore startDTD, endDTD, and all comments within DTD.

It is more complicated version of EmbeddedXMLPipe which, except being used to include other files into the SAX events stream, can perform optional operations described above.

Version:

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

Author:

Berin Loritsch, Carsten Ziegeler

See Also:

EmbeddedXMLPipe

Constructor Summary

IncludeXMLConsumer(ContentHandler contentHandler)
Constructor

IncludeXMLConsumer(ContentHandler contentHandler, LexicalHandler lexicalHandler)
Constructor

IncludeXMLConsumer(XMLConsumer consumer)
Constructor

Method Summary

void	characters(char[] ch, int start, int end)
void	comment(char[] ary, int start, int length)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String uri, String local, String qName)
void	endEntity(String name)
void	endPrefixMapping(String prefix)
void	ignorableWhitespace(char[] ch, int start, int end)
static void	includeNode(Node node, ContentHandler contentHandler, LexicalHandler lexicalHandler) Utility method to stream a DOM node into the provided content handler, lexical handler.
void	processingInstruction(String name, String value)
void	setDocumentLocator(Locator loc)
void	setIgnoreEmptyCharacters(boolean value) Control SAX event handling.
void	setIgnoreRootElement(boolean value) Control SAX event handling.
void	skippedEntity(String ent)
void	startCDATA()
void	startDocument()
void	startDTD(String name, String public_id, String system_id)
void	startElement(String uri, String local, String qName, Attributes attr)
void	startEntity(String name)
void	startPrefixMapping(String prefix, String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeXMLConsumer

public IncludeXMLConsumer(XMLConsumer consumer)

Constructor

IncludeXMLConsumer

public IncludeXMLConsumer(ContentHandler contentHandler)

Constructor

IncludeXMLConsumer

public IncludeXMLConsumer(ContentHandler contentHandler,
                          LexicalHandler lexicalHandler)

Constructor

Method Detail

includeNode

public static void includeNode(Node node,
                               ContentHandler contentHandler,
                               LexicalHandler lexicalHandler)
                        throws SAXException

Utility method to stream a DOM node into the provided content handler, lexical handler.

Parameters:

node - The DOM Node to be included

contentHandler - The SAX ContentHandler receiving the information

lexicalHandler - The SAX LexicalHandler receiving the information (optional)

Throws:

SAXException

setIgnoreEmptyCharacters

public void setIgnoreEmptyCharacters(boolean value)

Control SAX event handling. If set to true all empty characters events are ignored. The default is false.

setIgnoreRootElement

public void setIgnoreRootElement(boolean value)

Control SAX event handling. If set to true the root element is ignored. The default is false.

setDocumentLocator

public void setDocumentLocator(Locator loc)

Specified by:

setDocumentLocator in interface ContentHandler

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

startPrefixMapping

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

Specified by:

startPrefixMapping in interface ContentHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                         String local,
                         String qName,
                         Attributes attr)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Throws:

SAXException

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface ContentHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String name,
                                  String value)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Throws:

SAXException

skippedEntity

public void skippedEntity(String ent)
                   throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Throws:

SAXException

startDTD

public void startDTD(String name,
                     String public_id,
                     String system_id)
              throws SAXException

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Specified by:

startEntity in interface LexicalHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Specified by:

endEntity in interface LexicalHandler

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

comment

public void comment(char[] ary,
                    int start,
                    int length)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Throws:

SAXException