Class SAXHandler
- All Implemented Interfaces:
ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
,DeclHandler
,LexicalHandler
SAXBuilder
which listens for SAX events.
People overriding this class are cautioned to ensure that the implementation of the cleanUp() method resets to a virgin state. The cleanUp() method will be called when this SAXHandler is reset(), which may happen multiple times between parses. The cleanUp() method must ensure that there are no references remaining to any external instances.
Overriding of this class is permitted to allow for different handling of SAX
events. Once you have created a subclass of this, you also need to create a
custom implementation of SAXHandlerFactory
to supply your instances
to SAXBuilder
If the XMLReader producing the SAX Events supports a document Locator, then
this instance will use the locator to supply the line and column data from
the SAX locator to the JDOMFactory. Note: the SAX
specification for the SAX Locator indicates that the line and column
represent the position of the end of the SAX Event. For
example, the line and column of the simple XML <root />
would be line 1, column 9.
- Author:
- Brett McLaughlin, Jason Hunter, Philip Nelson, Bradley S. Huffman, phil@triloggroup.com, Rolf Lear
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionThis will create a newSAXHandler
that listens to SAX events and creates a JDOM Document.SAXHandler
(JDOMFactory factory) This will create a newSAXHandler
that listens to SAX events and creates a JDOM Document. -
Method Summary
Modifier and TypeMethodDescriptionvoid
This handles an attribute declaration in the internal subset.void
characters
(char[] ch, int start, int length) This will report character data (within an element).void
comment
(char[] ch, int start, int length) This reports that a comments is parsed.void
elementDecl
(String name, String model) Handle an element declaration in a DTD.void
endCDATA()
Report a CDATA sectionvoid
endDTD()
This signifies that the reading of the DTD is complete.void
endElement
(String namespaceURI, String localName, String qName) Indicates the end of an element (</[element name]>
) is reached.void
void
externalEntityDecl
(String name, String publicID, String systemID) This is called when the parser encounters an external entity declaration.protected void
This will flush any characters from SAX character calls we've been buffering.protected void
flushCharacters
(String data) Flush the given string into the document.Returns the being-parsed element.Returns the document.Provides access to theLocator
object provided by the SAX parser.boolean
Returns whether or not entities will be expanded during the build.Returns the factory used for constructing objects.boolean
Returns whether or not the parser will eliminate element content containing only whitespace.boolean
Returns whether or not the parser will eliminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.void
ignorableWhitespace
(char[] ch, int start, int length) Capture ignorable whitespace as text.void
internalEntityDecl
(String name, String value) Handle an internal entity declaration in a DTD.void
notationDecl
(String name, String publicID, String systemID) Handle the declaration of a Notation in a DTDvoid
processingInstruction
(String target, String data) This will indicate that a processing instruction has been encountered.protected void
pushElement
(Element element) Pushes an element onto the tree under construction.final void
reset()
Restore this SAXHandler to a clean state ready for another parse round.protected void
Override this method if you are a subclasser, and you want to clear the state of your SAXHandler instance in preparation for a new parse.void
setDocumentLocator
(Locator locator) Receives an object for locating the origin of SAX document events.void
setExpandEntities
(boolean expand) This sets whether or not to expand entities during the build.void
setIgnoringBoundaryWhitespace
(boolean ignoringBoundaryWhite) Specifies whether or not the parser should eliminate text() nodes containing only whitespace when building the document.void
setIgnoringElementContentWhitespace
(boolean ignoringWhite) Specifies whether or not the parser should eliminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.void
skippedEntity
(String name) This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read.void
Report a CDATA sectionvoid
void
This will signify that a DTD is being parsed, and can be used to ensure that comments and other lexical structures in the DTD are not added to the JDOMDocument
object.void
startElement
(String namespaceURI, String localName, String qName, Attributes atts) This reports the occurrence of an actual element.void
startEntity
(String name) void
startPrefixMapping
(String prefix, String uri) This will add the prefix mapping to the JDOMDocument
object.void
unparsedEntityDecl
(String name, String publicID, String systemID, String notationName) Handler for unparsed entity declarations in the DTDMethods inherited from class org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, error, fatalError, resolveEntity, warning
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
declaration
-
Constructor Details
-
SAXHandler
public SAXHandler()This will create a newSAXHandler
that listens to SAX events and creates a JDOM Document. The objects will be constructed using the default factory. -
SAXHandler
This will create a newSAXHandler
that listens to SAX events and creates a JDOM Document. The objects will be constructed using the provided factory.- Parameters:
factory
-JDOMFactory
to be used for constructing objects
-
-
Method Details
-
resetSubCLass
protected void resetSubCLass()Override this method if you are a subclasser, and you want to clear the state of your SAXHandler instance in preparation for a new parse. -
reset
public final void reset()Restore this SAXHandler to a clean state ready for another parse round. All internal variables are cleared to an initialized state, and then the resetSubClass() method is called to clear any methods that a subclass may need to have reset. -
pushElement
Pushes an element onto the tree under construction. Allows subclasses to put content under a dummy root element which is useful for building content that would otherwise be a non-well formed document.- Parameters:
element
- root element under which content will be built
-
getDocument
Returns the document. Should be called after parsing is complete.- Returns:
Document
- Document that was built
-
getFactory
Returns the factory used for constructing objects.- Returns:
JDOMFactory
- the factory used for constructing objects.- See Also:
-
setExpandEntities
public void setExpandEntities(boolean expand) This sets whether or not to expand entities during the build. A true means to expand entities as normal content. A false means to leave entities unexpanded asEntityRef
objects. The default is true.- Parameters:
expand
-boolean
indicating whether entity expansion should occur.
-
getExpandEntities
public boolean getExpandEntities()Returns whether or not entities will be expanded during the build.- Returns:
boolean
- whether entity expansion will occur during build.- See Also:
-
setIgnoringElementContentWhitespace
public void setIgnoringElementContentWhitespace(boolean ignoringWhite) Specifies whether or not the parser should eliminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. Only whitespace which is contained within element content that has an element only content model will be eliminated (see XML Rec 3.2.1). For this setting to take effect requires that validation be turned on. The default value of this setting isfalse
.- Parameters:
ignoringWhite
- Whether to ignore ignorable whitespace
-
setIgnoringBoundaryWhitespace
public void setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite) Specifies whether or not the parser should eliminate text() nodes containing only whitespace when building the document. SeeSAXBuilder.setIgnoringBoundaryWhitespace(boolean)
.- Parameters:
ignoringBoundaryWhite
- Whether to ignore only whitespace content
-
getIgnoringBoundaryWhitespace
public boolean getIgnoringBoundaryWhitespace()Returns whether or not the parser will eliminate element content containing only whitespace.- Returns:
boolean
- whether only whitespace content will be ignored during build.- See Also:
-
getIgnoringElementContentWhitespace
public boolean getIgnoringElementContentWhitespace()Returns whether or not the parser will eliminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.- Returns:
boolean
- whether ignorable whitespace will be ignored during build.- See Also:
-
startDocument
public void startDocument()- Specified by:
startDocument
in interfaceContentHandler
- Overrides:
startDocument
in classDefaultHandler
-
externalEntityDecl
This is called when the parser encounters an external entity declaration.- Specified by:
externalEntityDecl
in interfaceDeclHandler
- Parameters:
name
- entity namepublicID
- public idsystemID
- system id- Throws:
SAXException
- when things go wrong
-
attributeDecl
public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) This handles an attribute declaration in the internal subset.- Specified by:
attributeDecl
in interfaceDeclHandler
- Parameters:
eName
-String
element name of attributeaName
-String
attribute nametype
-String
attribute typevalueDefault
-String
default value of attributevalue
-String
value of attribute
-
elementDecl
Handle an element declaration in a DTD.- Specified by:
elementDecl
in interfaceDeclHandler
- Parameters:
name
-String
name of elementmodel
-String
model of the element in DTD syntax
-
internalEntityDecl
Handle an internal entity declaration in a DTD.- Specified by:
internalEntityDecl
in interfaceDeclHandler
- Parameters:
name
-String
name of entityvalue
-String
value of the entity
-
processingInstruction
This will indicate that a processing instruction has been encountered. (The XML declaration is not a processing instruction and will not be reported.)- Specified by:
processingInstruction
in interfaceContentHandler
- Overrides:
processingInstruction
in classDefaultHandler
- Parameters:
target
-String
target of PIdata
-String
containing all data sent to the PI. This typically looks like one or more attribute value pairs.- Throws:
SAXException
- when things go wrong
-
skippedEntity
This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read.- Specified by:
skippedEntity
in interfaceContentHandler
- Overrides:
skippedEntity
in classDefaultHandler
- Parameters:
name
-String
name of entity- Throws:
SAXException
- when things go wrong
-
startPrefixMapping
This will add the prefix mapping to the JDOMDocument
object.- Specified by:
startPrefixMapping
in interfaceContentHandler
- Overrides:
startPrefixMapping
in classDefaultHandler
- Parameters:
prefix
-String
namespace prefix.uri
-String
namespace URI.- Throws:
SAXException
-
startElement
public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException This reports the occurrence of an actual element. It will include the element's attributes, with the exception of XML vocabulary specific attributes, such asxmlns:[namespace prefix]
andxsi:schemaLocation
.- Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classDefaultHandler
- Parameters:
namespaceURI
-String
namespace URI this element is associated with, or an emptyString
localName
-String
name of element (with no namespace prefix, if one is present)qName
-String
XML 1.0 version of element name: [namespace prefix]:[localName]atts
-Attributes
list for this element- Throws:
SAXException
- when things go wrong
-
characters
This will report character data (within an element).- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classDefaultHandler
- Parameters:
ch
-char[]
character array with character datastart
-int
index in array where data starts.length
-int
length of data.- Throws:
SAXException
-
ignorableWhitespace
Capture ignorable whitespace as text. If setIgnoringElementContentWhitespace(true) has been called then this method does nothing.- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Overrides:
ignorableWhitespace
in classDefaultHandler
- Parameters:
ch
-[]
- char array of ignorable whitespacestart
-int
- starting position within arraylength
-int
- length of whitespace after start- Throws:
SAXException
- when things go wrong
-
flushCharacters
This will flush any characters from SAX character calls we've been buffering.- Throws:
SAXException
- when things go wrong
-
flushCharacters
Flush the given string into the document. This is a protected method so subclassers can control text handling without knowledge of the internals of this class.- Parameters:
data
- string to flush- Throws:
SAXException
- if the state of the handler does not allow this.
-
endElement
Indicates the end of an element (</[element name]>
) is reached. Note that the parser does not distinguish between empty elements and non-empty elements, so this will occur uniformly.- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classDefaultHandler
- Parameters:
namespaceURI
-String
URI of namespace this element is associated withlocalName
-String
name of element without prefixqName
-String
name of element in XML 1.0 form- Throws:
SAXException
- when things go wrong
-
startDTD
This will signify that a DTD is being parsed, and can be used to ensure that comments and other lexical structures in the DTD are not added to the JDOMDocument
object.- Specified by:
startDTD
in interfaceLexicalHandler
- Parameters:
name
-String
name of element listed in DTDpublicID
-String
public ID of DTDsystemID
-String
system ID of DTD- Throws:
SAXException
-
endDTD
public void endDTD()This signifies that the reading of the DTD is complete.- Specified by:
endDTD
in interfaceLexicalHandler
-
startEntity
- Specified by:
startEntity
in interfaceLexicalHandler
- Throws:
SAXException
-
endEntity
- Specified by:
endEntity
in interfaceLexicalHandler
- Throws:
SAXException
-
startCDATA
public void startCDATA()Report a CDATA section- Specified by:
startCDATA
in interfaceLexicalHandler
-
endCDATA
Report a CDATA section- Specified by:
endCDATA
in interfaceLexicalHandler
- Throws:
SAXException
-
comment
This reports that a comments is parsed. If not in the DTD, this comment is added to the current JDOMElement
, or theDocument
itself if at that level.- Specified by:
comment
in interfaceLexicalHandler
- Parameters:
ch
-ch[]
array of comment characters.start
-int
index to start reading from.length
-int
length of data.- Throws:
SAXException
- if the state of the handler disallows this call
-
notationDecl
Handle the declaration of a Notation in a DTD- Specified by:
notationDecl
in interfaceDTDHandler
- Overrides:
notationDecl
in classDefaultHandler
- Parameters:
name
- name of the notationpublicID
- the public ID of the notationsystemID
- the system ID of the notation- Throws:
SAXException
-
unparsedEntityDecl
Handler for unparsed entity declarations in the DTD- Specified by:
unparsedEntityDecl
in interfaceDTDHandler
- Overrides:
unparsedEntityDecl
in classDefaultHandler
- Parameters:
name
-String
of the unparsed entity declpublicID
-String
of the unparsed entity declsystemID
-String
of the unparsed entity declnotationName
-String
of the unparsed entity decl
-
getCurrentElement
Returns the being-parsed element.- Returns:
Element
- element being built.- Throws:
SAXException
- if the state of the handler disallows this call
-
setDocumentLocator
Receives an object for locating the origin of SAX document events. This method is invoked by the SAX parser.JDOMFactory
implementations can use thegetDocumentLocator()
method to get access to theLocator
during parse.- Specified by:
setDocumentLocator
in interfaceContentHandler
- Overrides:
setDocumentLocator
in classDefaultHandler
- Parameters:
locator
-Locator
an object that can return the location of any SAX document event.
-
getDocumentLocator
Provides access to theLocator
object provided by the SAX parser.- Returns:
Locator
an object that can return the location of any SAX document event.
-