Package org.dom4j.io

Class SAXModifyContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.dom4j.io.SAXContentHandler

org.dom4j.io.SAXModifyContentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, LexicalHandler

class SAXModifyContentHandler
extends SAXContentHandler

This extension of the SAXContentHandler writes SAX events immediately to the provided XMLWriter, unless some org.dom4.ElementHandleris still handling the current Element.

Author:

Wonne Keysers (Realsoftware.be)

See Also:

SAXContentHandler

Constructor Summary

Constructors

Constructor	Description
SAXModifyContentHandler()
SAXModifyContentHandler(DocumentFactory documentFactory)
SAXModifyContentHandler(DocumentFactory documentFactory, ElementHandler elementHandler)
SAXModifyContentHandler(DocumentFactory documentFactory, ElementHandler elementHandler, ElementStack elementStack)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] parm1, int parm2, int parm3)
void	comment(char[] characters, int parm2, int parm3)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String uri, String localName, String qName)
void	endEntity(String name)
void	endPrefixMapping(String prefix)
protected XMLWriter	getXMLWriter()
void	ignorableWhitespace(char[] parm1, int parm2, int parm3)
void	notationDecl(String name, String publicId, String systemId)	Receive notification of a notation declaration event.
void	processingInstruction(String target, String data)
void	setDocumentLocator(Locator locator)
void	setXMLWriter(XMLWriter writer)
void	skippedEntity(String name)
void	startCDATA()
void	startDocument()
void	startDTD(String name, String publicId, String systemId)
void	startElement(String uri, String localName, String qName, Attributes atts)
void	startEntity(String name)
void	startPrefixMapping(String prefix, String uri)
void	unparsedEntityDecl(String name, String publicId, String systemId, String notation)	Receive notification of an unparsed entity declaration event.

Methods inherited from class org.dom4j.io.SAXContentHandler

addAttributes, addDeclaredNamespaces, addDTDDeclaration, addExternalDTDDeclaration, attributeDecl, completeCurrentTextNode, createDocument, createElementStack, elementDecl, error, externalEntityDecl, fatalError, getDocument, getElementStack, getEntityResolver, getInputSource, internalEntityDecl, isIgnorableEntity, isIgnoreComments, isIncludeExternalDTDDeclarations, isIncludeInternalDTDDeclarations, isMergeAdjacentText, isStripWhitespaceText, setElementStack, setEntityResolver, setIgnoreComments, setIncludeExternalDTDDeclarations, setIncludeInternalDTDDeclarations, setInputSource, setMergeAdjacentText, setStripWhitespaceText, warning

Methods inherited from class org.xml.sax.helpers.DefaultHandler

resolveEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

SAXModifyContentHandler

public SAXModifyContentHandler()

SAXModifyContentHandler

public SAXModifyContentHandler(DocumentFactory documentFactory)

SAXModifyContentHandler

public SAXModifyContentHandler(DocumentFactory documentFactory,
                               ElementHandler elementHandler)

SAXModifyContentHandler

public SAXModifyContentHandler(DocumentFactory documentFactory,
                               ElementHandler elementHandler,
                               ElementStack elementStack)

Method Detail

setXMLWriter

public void setXMLWriter(XMLWriter writer)

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class SAXContentHandler

Throws:

SAXException

startDTD

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

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class SAXContentHandler

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class SAXContentHandler

Throws:

SAXException

comment

public void comment(char[] characters,
                    int parm2,
                    int parm3)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class SAXContentHandler

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Specified by:

startEntity in interface LexicalHandler

Overrides:

startEntity in class SAXContentHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class SAXContentHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Specified by:

endEntity in interface LexicalHandler

Overrides:

endEntity in class SAXContentHandler

Throws:

SAXException

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notation)
                        throws SAXException

Description copied from class: SAXContentHandler

Receive notification of an unparsed entity declaration event.

Note that the notation name corresponds to a notation reported by the notationDeclevent. It is up to the application to record the entity for later reference, if necessary.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in class SAXContentHandler

Parameters:

name - The unparsed entity's name.

publicId - The entity's public identifier, or null if none was given.

systemId - The entity's system identifier.

notation - The name of the associated notation.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

SAXContentHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String), AttributeList

notationDecl

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

Description copied from class: SAXContentHandler

Receive notification of a notation declaration event.

It is up to the application to record the notation for later reference, if necessary.

At least one of publicId and systemId must be non-null. If a system identifier is present, and it is a URL, the SAX parser must resolve it fully before passing it to the application through this event.

There is no guarantee that the notation declaration will be reported before any unparsed entities that use it.

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in class SAXContentHandler

Parameters:

name - The notation name.

publicId - The notation's public identifier, or null if none was given.

systemId - The notation's system identifier, or null if none was given.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

SAXContentHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String), AttributeList

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class SAXContentHandler

Throws:

SAXException

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class SAXContentHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] parm1,
                                int parm2,
                                int parm3)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

processingInstruction

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

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class SAXContentHandler

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class SAXContentHandler

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class SAXContentHandler

Throws:

SAXException

startPrefixMapping

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

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class SAXContentHandler

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class SAXContentHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class SAXContentHandler

Throws:

SAXException

characters

public void characters(char[] parm1,
                       int parm2,
                       int parm3)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class SAXContentHandler

Throws:

SAXException

getXMLWriter

protected XMLWriter getXMLWriter()