org.apache.cocoon.xml
Class IncludeXMLConsumer

java.lang.Object
  |
  +--org.apache.cocoon.xml.IncludeXMLConsumer

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, XMLConsumer

public class IncludeXMLConsumer

extends java.lang.Object

implements XMLConsumer

A special purpose XMLConsumer used for including files. It basically ignores the startDocument, endDocument, startDTD and endDTD messages.

Version:

CVS $Id: IncludeXMLConsumer.java,v 1.6 2002/03/11 11:15:25 cziegeler Exp $

Author:

Carsten Ziegeler

Constructor Summary

IncludeXMLConsumer(org.xml.sax.ContentHandler contentHandler)
Constructor

IncludeXMLConsumer(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.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(java.lang.String uri, java.lang.String local, java.lang.String qName)
void	endEntity(java.lang.String name)
void	endPrefixMapping(java.lang.String prefix)
void	ignorableWhitespace(char[] ch, int start, int end)
static void	includeNode(org.w3c.dom.Node node, org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler) Include a node into the current chain.
void	processingInstruction(java.lang.String name, java.lang.String value)
void	setDocumentLocator(org.xml.sax.Locator loc)
void	setIgnoreEmptyCharacters(boolean value) Controll SAX EventHandling If set to true all empty characters events are ignored.
void	setIgnoreRootElement(boolean value) Controll SAX EventHandling If set to true the root element is ignored.
void	skippedEntity(java.lang.String ent)
void	startCDATA()
void	startDocument()
void	startDTD(java.lang.String name, java.lang.String public_id, java.lang.String system_id)
void	startElement(java.lang.String uri, java.lang.String local, java.lang.String qName, org.xml.sax.Attributes attr)
void	startEntity(java.lang.String name)
void	startPrefixMapping(java.lang.String prefix, java.lang.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(org.xml.sax.ContentHandler contentHandler,
                          org.xml.sax.ext.LexicalHandler lexicalHandler)

Constructor

IncludeXMLConsumer

public IncludeXMLConsumer(org.xml.sax.ContentHandler contentHandler)

Constructor

Method Detail

includeNode

public static void includeNode(org.w3c.dom.Node node,
                               org.xml.sax.ContentHandler contentHandler,
                               org.xml.sax.ext.LexicalHandler lexicalHandler)
                        throws org.xml.sax.SAXException

Include a node into the current chain.

Parameters:

docfrag - The DocumentFragment to be included

contentHandler - The SAX ContentHandler receiving the information

lexicalHandler - The SAX LexicalHandler receiving the information (optional)

setIgnoreEmptyCharacters

public void setIgnoreEmptyCharacters(boolean value)

Controll SAX EventHandling If set to true all empty characters events are ignored. The default is false.

setIgnoreRootElement

public void setIgnoreRootElement(boolean value)

Controll SAX EventHandling If set to true the root element is ignored. The default is false.

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator loc)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

startElement

public void startElement(java.lang.String uri,
                         java.lang.String local,
                         java.lang.String qName,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

endElement

public void endElement(java.lang.String uri,
                       java.lang.String local,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

characters

public void characters(char[] ch,
                       int start,
                       int end)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int end)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

processingInstruction

public void processingInstruction(java.lang.String name,
                                  java.lang.String value)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String ent)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String public_id,
                     java.lang.String system_id)
              throws org.xml.sax.SAXException

Specified by:

startDTD in interface org.xml.sax.ext.LexicalHandler

endDTD

public void endDTD()
            throws org.xml.sax.SAXException

Specified by:

endDTD in interface org.xml.sax.ext.LexicalHandler

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException

Specified by:

startEntity in interface org.xml.sax.ext.LexicalHandler

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException

Specified by:

endEntity in interface org.xml.sax.ext.LexicalHandler

startCDATA

public void startCDATA()
                throws org.xml.sax.SAXException

Specified by:

startCDATA in interface org.xml.sax.ext.LexicalHandler

endCDATA

public void endCDATA()
              throws org.xml.sax.SAXException

Specified by:

endCDATA in interface org.xml.sax.ext.LexicalHandler

comment

public void comment(char[] ary,
                    int start,
                    int length)
             throws org.xml.sax.SAXException

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler