Class DOMSAXContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.dom4j.io.DOMSAXContentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler

public class DOMSAXContentHandler
extends DefaultHandler
implements LexicalHandler

SAXContentHandler builds W3C DOM object via SAX events.

Field Summary

Fields

Modifier and Type	Field	Description
private StringBuffer	cdataText	buffer to hold contents of cdata section across multiple characters events
private Element	currentElement	The current element we are on
private int	declaredNamespaceIndex	The number of namespaces that are declared in the current scope
private Document	document	The document that is being built
private DOMDocumentFactory	documentFactory	The factory used to create new Document instances
private ElementStack	elementStack	stack of Element objects
private EntityResolver	entityResolver	The entity resolver
private boolean	ignoreComments	Should we ignore comments
private InputSource	inputSource
private boolean	insideCDATASection	Flag used to indicate that we are inside a CDATA section
private Locator	locator	the Locator
private boolean	mergeAdjacentText	Whether adjacent text nodes should be merged
private NamespaceStack	namespaceStack	stack of Namespace and QName objects
private boolean	stripWhitespaceText	Holds value of property stripWhitespaceText.
private StringBuffer	textBuffer	Buffer used to concatenate text together
private boolean	textInTextBuffer	Have we added text to the buffer

Constructor Summary

Constructors

Constructor	Description
DOMSAXContentHandler()
DOMSAXContentHandler(DOMDocumentFactory documentFactory)

Method Summary

Modifier and Type	Method	Description
protected void	addAttributes(Element element, Attributes attributes)
protected void	addDeclaredNamespaces(Element element)
protected String	attributeNameForNamespace(Namespace namespace)
void	characters(char[] ch, int start, int end)
void	comment(char[] ch, int start, int end)
protected void	completeCurrentTextNode()
protected Document	createDocument()
protected ElementStack	createElementStack()
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String namespaceURI, String localName, String qName)
void	endEntity(String name)
void	endPrefixMapping(String prefix)
void	error(SAXParseException exception)	This method is called when an error is detected during parsing such as a validation error.
void	fatalError(SAXParseException exception)	This method is called when a fatal error occurs during parsing.
Document	getDocument()	Retrieves w3c document object built via generated sax events.
ElementStack	getElementStack()
private String	getEncoding()
EntityResolver	getEntityResolver()
InputSource	getInputSource()
boolean	isIgnoreComments()	Returns whether we should ignore comments or not.
boolean	isMergeAdjacentText()	Returns whether adjacent text nodes should be merged together.
boolean	isStripWhitespaceText()	Sets whether whitespace between element start and end tags should be ignored
void	processingInstruction(String target, String data)
void	setDocumentLocator(Locator documentLocator)
void	setElementStack(ElementStack elementStack)
void	setEntityResolver(EntityResolver entityResolver)
void	setIgnoreComments(boolean ignoreComments)	Sets whether we should ignore comments or not.
void	setInputSource(InputSource inputSource)
void	setMergeAdjacentText(boolean mergeAdjacentText)	Sets whether or not adjacent text nodes should be merged together when parsing.
void	setStripWhitespaceText(boolean stripWhitespaceText)	Sets whether whitespace between element start and end tags should be ignored.
void	startCDATA()
void	startDocument()
void	startDTD(String name, String publicId, String systemId)
void	startElement(String namespaceURI, String localName, String qualifiedName, Attributes attributes)
void	startEntity(String name)
void	startPrefixMapping(String prefix, String uri)
void	warning(SAXParseException exception)	This method is called when a warning occurs during the parsing of the document.

Methods inherited from class DefaultHandler

ignorableWhitespace, notationDecl, resolveEntity, skippedEntity, unparsedEntityDecl

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

documentFactory

private DOMDocumentFactory documentFactory

The factory used to create new Document instances

document

private Document document

The document that is being built

elementStack

private ElementStack elementStack

stack of Element objects

namespaceStack

private NamespaceStack namespaceStack

stack of Namespace and QName objects

locator

private Locator locator

the Locator

insideCDATASection

private boolean insideCDATASection

Flag used to indicate that we are inside a CDATA section

cdataText

private StringBuffer cdataText

buffer to hold contents of cdata section across multiple characters events

declaredNamespaceIndex

private int declaredNamespaceIndex

The number of namespaces that are declared in the current scope

inputSource

private InputSource inputSource

currentElement

private Element currentElement

The current element we are on

entityResolver

private EntityResolver entityResolver

The entity resolver

mergeAdjacentText

private boolean mergeAdjacentText

Whether adjacent text nodes should be merged

textInTextBuffer

private boolean textInTextBuffer

Have we added text to the buffer

ignoreComments

private boolean ignoreComments

Should we ignore comments

textBuffer

private StringBuffer textBuffer

Buffer used to concatenate text together

stripWhitespaceText

private boolean stripWhitespaceText

Holds value of property stripWhitespaceText.

Constructor Details

DOMSAXContentHandler

public DOMSAXContentHandler()

DOMSAXContentHandler

public DOMSAXContentHandler(DOMDocumentFactory documentFactory)

Method Details

getDocument

public Document getDocument()

Retrieves w3c document object built via generated sax events.

Returns:

the document that has been or is being built

setDocumentLocator

public void setDocumentLocator(Locator documentLocator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

processingInstruction

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

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

startPrefixMapping

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

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

Throws:

SAXException

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String namespaceURI,
 String localName,
 String qualifiedName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

warning

public void warning(SAXParseException exception)
             throws SAXException

This method is called when a warning occurs during the parsing of the document. This method does nothing.

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Parameters:

exception - DOCUMENT ME!

Throws:

SAXException - DOCUMENT ME!

error

public void error(SAXParseException exception)
           throws SAXException

This method is called when an error is detected during parsing such as a validation error. This method rethrows the exception

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Parameters:

exception - DOCUMENT ME!

Throws:

SAXException - DOCUMENT ME!

fatalError

public void fatalError(SAXParseException exception)
                throws SAXException

This method is called when a fatal error occurs during parsing. This method rethrows the exception

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Parameters:

exception - DOCUMENT ME!

Throws:

SAXException - DOCUMENT ME!

startDTD

public void startDTD(String name,
 String publicId,
 String systemId)
              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[] ch,
 int start,
 int end)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

getElementStack

public ElementStack getElementStack()

setElementStack

public void setElementStack(ElementStack elementStack)

getEntityResolver

public EntityResolver getEntityResolver()

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)

getInputSource

public InputSource getInputSource()

setInputSource

public void setInputSource(InputSource inputSource)

isMergeAdjacentText

public boolean isMergeAdjacentText()

Returns whether adjacent text nodes should be merged together.

Returns:

Value of property mergeAdjacentText.

setMergeAdjacentText

public void setMergeAdjacentText(boolean mergeAdjacentText)

Sets whether or not adjacent text nodes should be merged together when parsing.

Parameters:

mergeAdjacentText - New value of property mergeAdjacentText.

isStripWhitespaceText

public boolean isStripWhitespaceText()

Sets whether whitespace between element start and end tags should be ignored

Returns:

Value of property stripWhitespaceText.

setStripWhitespaceText

public void setStripWhitespaceText(boolean stripWhitespaceText)

Sets whether whitespace between element start and end tags should be ignored.

Parameters:

stripWhitespaceText - New value of property stripWhitespaceText.

isIgnoreComments

public boolean isIgnoreComments()

Returns whether we should ignore comments or not.

Returns:

boolean

setIgnoreComments

public void setIgnoreComments(boolean ignoreComments)

Sets whether we should ignore comments or not.

Parameters:

ignoreComments - whether we should ignore comments or not.

completeCurrentTextNode

protected void completeCurrentTextNode()

createDocument

protected Document createDocument()

getEncoding

private String getEncoding()

addDeclaredNamespaces

protected void addDeclaredNamespaces(Element element)

addAttributes

protected void addAttributes(Element element,
 Attributes attributes)

createElementStack

protected ElementStack createElementStack()

attributeNameForNamespace

protected String attributeNameForNamespace(Namespace namespace)