org.apache.cocoon.xml
Class IncludeXMLConsumer

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLConsumer
              |
              +--org.apache.cocoon.xml.IncludeXMLConsumer

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.Loggable, XMLConsumer

public class IncludeXMLConsumer

extends AbstractXMLConsumer

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

Version:

$Revision: 1.1 $ $Date: 2002/01/03 12:31:22 $

Author:

Carsten Ziegeler

Constructor Summary

IncludeXMLConsumer(org.xml.sax.ContentHandler contentHandler)

IncludeXMLConsumer(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler)

IncludeXMLConsumer(XMLConsumer consumer)

Method Summary

void	characters(char[] ch, int start, int end) Receive notification of character data.
void	comment(char[] ary, int start, int length) Report an XML comment anywhere in the document.
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(java.lang.String uri, java.lang.String local, java.lang.String qName) Receive notification of the end of an element.
void	endEntity(java.lang.String name) Report the end of an entity.
void	endPrefixMapping(java.lang.String prefix) End the scope of a prefix-URI mapping.
void	ignorableWhitespace(char[] ch, int start, int end) Receive notification of ignorable whitespace in element content.
void	processingInstruction(java.lang.String name, java.lang.String value) Receive notification of a processing instruction.
void	setDocumentLocator(org.xml.sax.Locator loc) Receive an object for locating the origin of SAX document events.
void	skippedEntity(java.lang.String ent) 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(java.lang.String name, java.lang.String public_id, java.lang.String system_id) Report the start of DTD declarations, if any.
void	startElement(java.lang.String uri, java.lang.String local, java.lang.String qName, org.xml.sax.Attributes attr) Receive notification of the beginning of an element.
void	startEntity(java.lang.String name) Report the beginning of an entity.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Begin the scope of a prefix-URI Namespace mapping.

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

getLogger, setLogger, setupLogger, setupLogger, setupLogger

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)

IncludeXMLConsumer

public IncludeXMLConsumer(org.xml.sax.ContentHandler contentHandler,
                          org.xml.sax.ext.LexicalHandler lexicalHandler)

IncludeXMLConsumer

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

Method Detail

setDocumentLocator

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

Description copied from class: AbstractXMLConsumer

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

Overrides:

setDocumentLocator in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

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

startDocument

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

Description copied from class: AbstractXMLConsumer

Receive notification of the beginning of a document.

Overrides:

startDocument in class AbstractXMLConsumer

endDocument

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

Description copied from class: AbstractXMLConsumer

Receive notification of the end of a document.

Overrides:

endDocument in class AbstractXMLConsumer

startPrefixMapping

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

Description copied from class: AbstractXMLConsumer

Begin the scope of a prefix-URI Namespace mapping.

Overrides:

startPrefixMapping in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

endPrefixMapping

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

Description copied from class: AbstractXMLConsumer

End the scope of a prefix-URI mapping.

Overrides:

endPrefixMapping in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

prefix - The prefix that was being mapping.

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

Description copied from class: AbstractXMLConsumer

Receive notification of the beginning of an element.

Overrides:

startElement in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

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.

endElement

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

Description copied from class: AbstractXMLConsumer

Receive notification of the end of an element.

Overrides:

endElement in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

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.

characters

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

Description copied from class: AbstractXMLConsumer

Receive notification of character data.

Overrides:

characters in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

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.

ignorableWhitespace

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

Description copied from class: AbstractXMLConsumer

Receive notification of ignorable whitespace in element content.

Overrides:

ignorableWhitespace in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

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.

processingInstruction

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

Description copied from class: AbstractXMLConsumer

Receive notification of a processing instruction.

Overrides:

processingInstruction in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

target - The processing instruction target.

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

skippedEntity

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

Description copied from class: AbstractXMLConsumer

Receive notification of a skipped entity.

Overrides:

skippedEntity in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

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

startDTD

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

Description copied from class: AbstractXMLConsumer

Report the start of DTD declarations, if any.

Overrides:

startDTD in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

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.

endDTD

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

Description copied from class: AbstractXMLConsumer

Report the end of DTD declarations.

Overrides:

endDTD in class AbstractXMLConsumer

startEntity

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

Description copied from class: AbstractXMLConsumer

Report the beginning of an entity.

Overrides:

startEntity in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

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

endEntity

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

Description copied from class: AbstractXMLConsumer

Report the end of an entity.

Overrides:

endEntity in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

Parameters:

name - The name of the entity that is ending.

startCDATA

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

Description copied from class: AbstractXMLConsumer

Report the start of a CDATA section.

Overrides:

startCDATA in class AbstractXMLConsumer

endCDATA

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

Description copied from class: AbstractXMLConsumer

Report the end of a CDATA section.

Overrides:

endCDATA in class AbstractXMLConsumer

comment

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

Description copied from class: AbstractXMLConsumer

Report an XML comment anywhere in the document.

Overrides:

comment in class AbstractXMLConsumer

Following copied from class: org.apache.cocoon.xml.AbstractXMLConsumer

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.