org.dom4j.io

Class SAXContentHandler

Implemented Interfaces:
DeclHandler, DTDHandler, LexicalHandler

public class SAXContentHandler
extends DefaultHandler
implements LexicalHandler, DeclHandler, DTDHandler

SAXContentHandler builds a dom4j tree via SAX events.
Version:
$Revision: 1.61 $
Author:
James Strachan

Constructor Summary

SAXContentHandler()
SAXContentHandler(DocumentFactory documentFactory)
SAXContentHandler(DocumentFactory documentFactory, ElementHandler elementHandler)
SAXContentHandler(DocumentFactory documentFactory, ElementHandler elementHandler, org.dom4j.io.ElementStack elementStack)

Method Summary

protected void
addAttributes(Element element, Attributes attributes)
Add all the attributes to the given elements
protected void
addDTDDeclaration(Object declaration)
Adds an internal DTD declaration to the list of declarations
protected void
addDeclaredNamespaces(Element element)
Add all namespaces declared before the startElement() SAX event to the current element so that they are available to child elements and attributes
protected void
addExternalDTDDeclaration(Object declaration)
Adds an external DTD declaration to the list of declarations
void
attributeDecl(String eName, String aName, String type, String valueDefault, String val)
Report an attribute type declaration.
void
characters(char[] ch, int start, int end)
void
comment(char[] ch, int start, int end)
protected void
completeCurrentTextNode()
If the current text buffer contains any text then create a new text node with it and add it to the current element
protected Document
createDocument()
DOCUMENT ME!
protected org.dom4j.io.ElementStack
createElementStack()
void
elementDecl(String name, String model)
Report an element type declaration.
void
endCDATA()
void
endDTD()
void
endDocument()
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
externalEntityDecl(String name, String publicId, String sysId)
Report a parsed external entity declaration.
void
fatalError(SAXParseException exception)
This method is called when a fatal error occurs during parsing.
Document
getDocument()
DOCUMENT ME!
org.dom4j.io.ElementStack
getElementStack()
EntityResolver
getEntityResolver()
InputSource
getInputSource()
void
internalEntityDecl(String name, String value)
Report an internal entity declaration.
protected boolean
isIgnorableEntity(String name)
a Strategy Method to determine if a given entity name is ignorable
boolean
isIgnoreComments()
Returns whether we should ignore comments or not.
boolean
isIncludeExternalDTDDeclarations()
DOCUMENT ME!
boolean
isIncludeInternalDTDDeclarations()
DOCUMENT ME!
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
notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration event.
void
processingInstruction(String target, String data)
void
setDocumentLocator(Locator documentLocator)
void
setElementStack(org.dom4j.io.ElementStack elementStack)
void
setEntityResolver(EntityResolver entityResolver)
void
setIgnoreComments(boolean ignoreComments)
Sets whether we should ignore comments or not.
void
setIncludeExternalDTDDeclarations(boolean include)
Sets whether DTD external declarations should be expanded into the DocumentType object or not.
void
setIncludeInternalDTDDeclarations(boolean include)
Sets whether internal DTD declarations should be expanded into the DocumentType object 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
startDTD(String name, String publicId, String systemId)
void
startDocument()
void
startElement(String namespaceURI, String localName, String qualifiedName, Attributes attributes)
void
startEntity(String name)
void
startPrefixMapping(String prefix, String uri)
void
unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration event.
void
warning(SAXParseException exception)
This method is called when a warning occurs during the parsing of the document.

Constructor Details

SAXContentHandler

public SAXContentHandler()

SAXContentHandler

public SAXContentHandler(DocumentFactory documentFactory)

SAXContentHandler

public SAXContentHandler(DocumentFactory documentFactory,
                         ElementHandler elementHandler)

SAXContentHandler

public SAXContentHandler(DocumentFactory documentFactory,
                         ElementHandler elementHandler,
                         org.dom4j.io.ElementStack elementStack)

Method Details

addAttributes

protected void addAttributes(Element element,
                             Attributes attributes)
Add all the attributes to the given elements
Parameters:
element - DOCUMENT ME!
attributes - DOCUMENT ME!

addDTDDeclaration

protected void addDTDDeclaration(Object declaration)
Adds an internal DTD declaration to the list of declarations
Parameters:
declaration - DOCUMENT ME!

addDeclaredNamespaces

protected void addDeclaredNamespaces(Element element)
Add all namespaces declared before the startElement() SAX event to the current element so that they are available to child elements and attributes
Parameters:
element - DOCUMENT ME!

addExternalDTDDeclaration

protected void addExternalDTDDeclaration(Object declaration)
Adds an external DTD declaration to the list of declarations
Parameters:
declaration - DOCUMENT ME!

attributeDecl

public void attributeDecl(String eName,
                          String aName,
                          String type,
                          String valueDefault,
                          String val)
            throws SAXException
Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", a parenthesized token group with the separator "|" and all whitespace removed, or the word "NOTATION" followed by a space followed by a parenthesized token group with all whitespace removed.

Any parameter entities in the attribute value will be expanded, but general entities will not.

Parameters:
eName - The name of the associated element.
aName - The name of the attribute.
type - A string representing the attribute type.
valueDefault - A string representing the attribute default ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
val - A string representing the attribute's default value, or null if there is none.

characters

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

comment

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

completeCurrentTextNode

protected void completeCurrentTextNode()
If the current text buffer contains any text then create a new text node with it and add it to the current element

createDocument

protected Document createDocument()
DOCUMENT ME!
Returns:
the current document

createElementStack

protected org.dom4j.io.ElementStack createElementStack()

elementDecl

public void elementDecl(String name,
                        String model)
            throws SAXException
Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.

Parameters:
name - The element type name.
model - The content model as a normalized string.

endCDATA

public void endCDATA()
            throws SAXException

endDTD

public void endDTD()
            throws SAXException

endDocument

public void endDocument()
            throws SAXException

endElement

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

endEntity

public void endEntity(String name)
            throws SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
            throws SAXException

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
Parameters:
exception - DOCUMENT ME!

externalEntityDecl

public void externalEntityDecl(String name,
                               String publicId,
                               String sysId)
            throws SAXException
Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

Parameters:
name - The name of the entity. If it is a parameter entity, the name will begin with '%'.
publicId - The declared public identifier of the entity, or null if none was declared.
sysId - The declared system identifier of the entity.
See Also:
internalEntityDecl(String,String), org.xml.sax.DTDHandler.unparsedEntityDecl

fatalError

public void fatalError(SAXParseException exception)
            throws SAXException
This method is called when a fatal error occurs during parsing. This method rethrows the exception
Parameters:
exception - DOCUMENT ME!

getDocument

public Document getDocument()
DOCUMENT ME!
Returns:
the document that has been or is being built

getElementStack

public org.dom4j.io.ElementStack getElementStack()

getEntityResolver

public EntityResolver getEntityResolver()

getInputSource

public InputSource getInputSource()

internalEntityDecl

public void internalEntityDecl(String name,
                               String value)
            throws SAXException
Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.

Parameters:
name - The name of the entity. If it is a parameter entity, the name will begin with '%'.
value - The replacement text of the entity.
See Also:
externalEntityDecl(String,String,String), org.xml.sax.DTDHandler.unparsedEntityDecl

isIgnorableEntity

protected boolean isIgnorableEntity(String name)
a Strategy Method to determine if a given entity name is ignorable
Parameters:
name - DOCUMENT ME!
Returns:
DOCUMENT ME!

isIgnoreComments

public boolean isIgnoreComments()
Returns whether we should ignore comments or not.
Returns:
boolean

isIncludeExternalDTDDeclarations

public boolean isIncludeExternalDTDDeclarations()
DOCUMENT ME!
Returns:
whether external DTD declarations should be expanded into the DocumentType object or not.

isIncludeInternalDTDDeclarations

public boolean isIncludeInternalDTDDeclarations()
DOCUMENT ME!
Returns:
whether internal DTD declarations should be expanded into the DocumentType object or not.

isMergeAdjacentText

public boolean isMergeAdjacentText()
Returns whether adjacent text nodes should be merged together.
Returns:
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.

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
            throws SAXException
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.

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.

processingInstruction

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

setDocumentLocator

public void setDocumentLocator(Locator documentLocator)

setElementStack

public void setElementStack(org.dom4j.io.ElementStack elementStack)

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)

setIgnoreComments

public void setIgnoreComments(boolean ignoreComments)
Sets whether we should ignore comments or not.
Parameters:
ignoreComments - whether we should ignore comments or not.

setIncludeExternalDTDDeclarations

public void setIncludeExternalDTDDeclarations(boolean include)
Sets whether DTD external declarations should be expanded into the DocumentType object or not.
Parameters:
include - whether or not DTD declarations should be expanded and included into the DocumentType object.

setIncludeInternalDTDDeclarations

public void setIncludeInternalDTDDeclarations(boolean include)
Sets whether internal DTD declarations should be expanded into the DocumentType object or not.
Parameters:
include - whether or not DTD declarations should be expanded and included into the DocumentType object.

setInputSource

public void setInputSource(InputSource inputSource)

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.

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.

startCDATA

public void startCDATA()
            throws SAXException

startDTD

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

startDocument

public void startDocument()
            throws SAXException

startElement

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

startEntity

public void startEntity(String name)
            throws SAXException

startPrefixMapping

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

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
            throws SAXException
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.

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.
notationName - The name of the associated notation.
See Also:
notationDecl(String,String,String), org.xml.sax.AttributeList

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.
Parameters:
exception - DOCUMENT ME!

Copyright B) 2005 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo