public class SAX2DOM extends java.lang.Object implements ContentHandler, LexicalHandler, Constants
ANY, ATTRIBUTE, COMMENT, ELEMENT, EMPTYSTRING, NAMESPACE_FEATURE, PROCESSING_INSTRUCTION, ROOT, TEXT, XML_PREFIX, XMLNS_PREFIX, XMLNS_STRING, XMLNS_URI, XSLT_URI| Constructor and Description |
|---|
SAX2DOM() |
SAX2DOM(Node root) |
SAX2DOM(Node root,
Node nextSibling) |
| Modifier and Type | Method and Description |
|---|---|
void |
characters(char[] ch,
int start,
int length)
Receive notification of character data.
|
void |
comment(char[] ch,
int start,
int length)
Lexical Handler method to create comment node in DOM tree.
|
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 namespace,
java.lang.String localName,
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.
|
Node |
getDOM() |
void |
ignorableWhitespace(char[] ch,
int start,
int length)
This class is only used internally so this method should never
be called.
|
void |
processingInstruction(java.lang.String target,
java.lang.String data)
adds processing instruction node to DOM.
|
void |
setDocumentLocator(Locator locator)
This class is only used internally so this method should never
be called.
|
void |
skippedEntity(java.lang.String name)
This class is only used internally so this method should never
be called.
|
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 publicId,
java.lang.String systemId)
Report the start of DTD declarations, if any.
|
void |
startElement(java.lang.String namespace,
java.lang.String localName,
java.lang.String qName,
Attributes attrs)
Receive notification of the beginning of an element.
|
void |
startEntity(java.lang.String name)
Report the beginning of some internal and external XML entities.
|
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
Begin the scope of a prefix-URI Namespace mapping.
|
public SAX2DOM()
throws ParserConfigurationException
ParserConfigurationExceptionpublic SAX2DOM(Node root, Node nextSibling) throws ParserConfigurationException
ParserConfigurationExceptionpublic SAX2DOM(Node root) throws ParserConfigurationException
ParserConfigurationExceptionpublic Node getDOM()
public void characters(char[] ch,
int start,
int length)
ContentHandlerThe Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Individual characters may consist of more than one Java
char value. There are two important cases where this
happens, because characters can't be represented in just sixteen bits.
In one case, characters are represented in a Surrogate Pair,
using two special Unicode values. Such characters are in the so-called
"Astral Planes", with a code point above U+FFFF. A second case involves
composite characters, such as a base character combining with one or
more accent characters.
Your code should not assume that algorithms using
char-at-a-time idioms will be working in character
units; in some cases they will split characters. This is relevant
wherever XML permits arbitrary characters, such as attribute values,
processing instruction data, and comments as well as in data reported
from this method. It's also generally relevant whenever Java code
manipulates internationalized text; the issue isn't unique to XML.
Note that some parsers will report whitespace in element
content using the ignorableWhitespace
method rather than this one (validating parsers must
do so).
characters in interface ContentHandlerch - the characters from the XML documentstart - the start position in the arraylength - the number of characters to read from the arrayContentHandler.ignorableWhitespace(char[], int, int),
Locatorpublic void startDocument()
ContentHandlerThe SAX parser will invoke this method only once, before any
other event callbacks (except for setDocumentLocator).
startDocument in interface ContentHandlerContentHandler.endDocument()public void endDocument()
ContentHandlerThere is an apparent contradiction between the
documentation for this method and the documentation for ErrorHandler.fatalError(org.xml.sax.SAXParseException). Until this ambiguity is
resolved in a future major release, clients should make no
assumptions about whether endDocument() will or will not be
invoked when the parser has reported a fatalError() or thrown
an exception.
The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
endDocument in interface ContentHandlerContentHandler.startDocument()public void startElement(java.lang.String namespace,
java.lang.String localName,
java.lang.String qName,
Attributes attrs)
ContentHandlerThe Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
endElement event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixes
property is true (it is false by default, and support for a
true value is optional).
Like characters(), attribute values may have
characters that need more than one char value.
startElement in interface ContentHandlernamespace - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName - the local name (without prefix), or the
empty string if Namespace processing is not being
performedqName - the qualified name (with prefix), or the
empty string if qualified names are not availableattrs - the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefinedContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String),
Attributes,
AttributesImplpublic void endElement(java.lang.String namespace,
java.lang.String localName,
java.lang.String qName)
ContentHandlerThe SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
startElement event for every endElement
event (even when the element is empty).
For information on the names, see startElement.
endElement in interface ContentHandlernamespace - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName - the local name (without prefix), or the
empty string if Namespace processing is not being
performedqName - the qualified XML name (with prefix), or the
empty string if qualified names are not availablepublic void startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
ContentHandlerThe information from this event is not necessary for
normal Namespace processing: the SAX XML reader will
automatically replace prefixes for element and attribute
names when the http://xml.org/sax/features/namespaces
feature is true (the default).
There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.
Note that start/endPrefixMapping events are not
guaranteed to be properly nested relative to each other:
all startPrefixMapping events will occur immediately before the
corresponding startElement event,
and all endPrefixMapping
events will occur immediately after the corresponding
endElement event,
but their order is not otherwise
guaranteed.
There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.
startPrefixMapping in interface ContentHandlerprefix - the Namespace prefix being declared.
An empty string is used for the default element namespace,
which has no prefix.uri - the Namespace URI the prefix is mapped toContentHandler.endPrefixMapping(java.lang.String),
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)public void endPrefixMapping(java.lang.String prefix)
ContentHandlerSee startPrefixMapping for
details. These events will always occur immediately after the
corresponding endElement event, but the order of
endPrefixMapping events is not otherwise
guaranteed.
endPrefixMapping in interface ContentHandlerprefix - the prefix that was being mapped.
This is the empty string when a default mapping scope ends.ContentHandler.startPrefixMapping(java.lang.String, java.lang.String),
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)public void ignorableWhitespace(char[] ch,
int start,
int length)
ignorableWhitespace in interface ContentHandlerch - the characters from the XML documentstart - the start position in the arraylength - the number of characters to read from the arrayContentHandler.characters(char[], int, int)public void processingInstruction(java.lang.String target,
java.lang.String data)
processingInstruction in interface ContentHandlertarget - the processing instruction targetdata - the processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the targetpublic void setDocumentLocator(Locator locator)
setDocumentLocator in interface ContentHandlerlocator - an object that can return the location of
any SAX document eventLocatorpublic void skippedEntity(java.lang.String name)
skippedEntity in interface ContentHandlername - the name of the skipped entity. If it is a
parameter entity, the name will begin with '%', and if
it is the external DTD subset, it will be the string
"[dtd]"public void comment(char[] ch,
int start,
int length)
comment in interface LexicalHandlerch - An array holding the characters in the comment.start - The starting position in the array.length - The number of characters to use from the array.public void startCDATA()
LexicalHandlerThe contents of the CDATA section will be reported through
the regular characters event; this event is intended only to report
the boundary.
startCDATA in interface LexicalHandlerLexicalHandler.endCDATA()public void endCDATA()
LexicalHandlerendCDATA in interface LexicalHandlerLexicalHandler.startCDATA()public void startEntity(java.lang.String name)
LexicalHandlerThe reporting of parameter entities (including
the external DTD subset) is optional, and SAX2 drivers that
report LexicalHandler events may not implement it; you can use the
http://xml.org/sax/features/lexical-handler/parameter-entities
feature to query or control the reporting of parameter entities.
General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".
When a SAX2 driver is providing these events, all other
events must be properly nested within start/end entity
events. There is no additional requirement that events from
DeclHandler or
DTDHandler be properly ordered.
Note that skipped entities will be reported through the
skippedEntity
event, which is part of the ContentHandler interface.
Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:
These will be silently expanded, with no indication of where the original entity boundaries were.
Note also that the boundaries of character references (which are not really entities anyway) are not reported.
All start/endEntity events must be properly nested.
startEntity in interface LexicalHandlername - The name of the entity. If it is a parameter
entity, the name will begin with '%', and if it is the
external DTD subset, it will be "[dtd]".LexicalHandler.endEntity(java.lang.String),
DeclHandler.internalEntityDecl(java.lang.String, java.lang.String),
DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)public void endDTD()
LexicalHandlerThis method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.
endDTD in interface LexicalHandlerLexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)public void endEntity(java.lang.String name)
LexicalHandlerendEntity in interface LexicalHandlername - The name of the entity that is ending.LexicalHandler.startEntity(java.lang.String)public void startDTD(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
throws SAXException
LexicalHandlerThis method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.
All declarations reported through
DTDHandler or
DeclHandler events must appear
between the startDTD and endDTD events.
Declarations are assumed to belong to the internal DTD subset
unless they appear between startEntity
and endEntity events. Comments and
processing instructions from the DTD should also be reported
between the startDTD and endDTD events, in their original
order of (logical) occurrence; they are not required to
appear in their correct locations relative to DTDHandler
or DeclHandler events, however.
Note that the start/endDTD events will appear within
the start/endDocument events from ContentHandler and
before the first
startElement
event.
startDTD in interface LexicalHandlername - 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.
(Note that this is not resolved against the document
base URI.)SAXException - The application may raise an
exception.LexicalHandler.endDTD(),
LexicalHandler.startEntity(java.lang.String)Copyright © 2014 Apache XML Project. All Rights Reserved.