|
Xerces 2.0.0.alpha | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.parsers.XMLParser | +--org.apache.xerces.parsers.XMLDocumentParser | +--org.apache.xerces.parsers.DOMParser
A parser configuration that builds a W3C DOM tree structure from a parse stream. This class implements the XNI callback methods to create the DOM tree. After a successful parse of an XML document, the DOM Document object can be queried using the getDocument method.
Field Summary | |
protected Node |
fCurrentNode
Current node. |
protected Document |
fDocument
The document. |
protected boolean |
fInCDATASection
True if inside CDATA section. |
protected boolean |
fInDocument
True if inside document. |
protected boolean |
fInDTD
True if inside DTD. |
Fields inherited from class org.apache.xerces.parsers.XMLDocumentParser |
fDatatypeValidatorFactory, fDTDScanner, fGrammarPool, fParseInProgress, fScanner, fValidator |
Fields inherited from class org.apache.xerces.parsers.XMLParser |
fEntityManager, fErrorReporter, fFeatures, fLocator, fProperties, fSymbolTable |
Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler |
CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE |
Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler |
OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE, TYPE_ANY, TYPE_CHILDREN, TYPE_EMPTY, TYPE_MIXED |
Constructor Summary | |
|
DOMParser()
Default constructor. |
protected |
DOMParser(org.apache.xerces.util.SymbolTable symbolTable,
org.apache.xerces.impl.validation.GrammarPool grammarPool)
|
Method Summary | |
protected int |
buildAttrEntityRefs(Text text,
org.apache.xerces.xni.XMLAttributes attributes,
int attrIndex,
int entityCount,
int entityIndex,
int textOffset)
Builds entity references in attribute values. |
void |
characters(org.apache.xerces.xni.XMLString text)
Character content. |
void |
comment(org.apache.xerces.xni.XMLString text)
A comment. |
void |
doctypeDecl(java.lang.String rootElement,
java.lang.String publicId,
java.lang.String systemId)
Notifies of the presence of the DOCTYPE line in the document. |
void |
endCDATA()
The end of a CDATA section. |
void |
endDocument()
The end of the document. |
void |
endDTD()
The end of the DTD. |
void |
endElement(org.apache.xerces.xni.QName element)
The end of an element. |
void |
endEntity(java.lang.String name)
This method notifies the end of an entity. |
void |
endPrefixMapping(java.lang.String prefix)
The end of a namespace prefix mapping. |
Document |
getDocument()
Returns the DOM document object. |
void |
ignorableWhitespace(org.apache.xerces.xni.XMLString text)
Ignorable whitespace. |
void |
processingInstruction(java.lang.String target,
org.apache.xerces.xni.XMLString data)
A processing instruction. |
void |
reset()
Resets the parser state. |
void |
startCDATA()
The start of a CDATA section. |
void |
startDocument()
The start of the document. |
void |
startDTD()
The start of the DTD. |
void |
startElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.XMLAttributes attributes)
The start of an element. |
void |
startEntity(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String encoding)
This method notifies of the start of an entity. |
Methods inherited from class org.apache.xerces.parsers.XMLDocumentParser |
attributeDecl, checkFeature, checkProperty, childrenElement, childrenEndGroup, childrenOccurrence, childrenSeparator, childrenStartGroup, elementDecl, endAttlist, endConditional, endContentModel, externalEntityDecl, internalEntityDecl, mixedElement, notationDecl, parse, setFeature, setProperty, startAttlist, startConditional, startContentModel, startPrefixMapping, textDecl, unparsedEntityDecl, xmlDecl |
Methods inherited from class org.apache.xerces.parsers.XMLParser |
getEntityResolver, getErrorHandler, getFeature, getProperty, parse, setEntityResolver, setErrorHandler, setLocale |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Document fDocument
protected Node fCurrentNode
protected boolean fInDocument
protected boolean fInDTD
protected boolean fInCDATASection
Constructor Detail |
public DOMParser()
protected DOMParser(org.apache.xerces.util.SymbolTable symbolTable, org.apache.xerces.impl.validation.GrammarPool grammarPool)
symbolTable
- grammarPool
- Method Detail |
public Document getDocument()
public void reset() throws SAXException
reset
in class XMLDocumentParser
SAXException
- Thrown on initialization error.public void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String encoding) throws SAXException
Note: Since the document is an entity, the handler will be notified of the start of the document entity by calling the startEntity method with the entity name "[xml]" before calling the startDocument method. When exposing entity boundaries through the SAX API, the document entity is never reported, however.
Note: Since the DTD is an entity, the handler will be notified of the start of the DTD entity by calling the startEntity method with the entity name "[dtd]" before calling the startDTD method.
Note: This method is not called for entity references appearing as part of attribute values.
startEntity
in class XMLDocumentParser
name
- The name of the entity.publicId
- The public identifier of the entity if the entity
is external, null otherwise.systemId
- The system identifier of the entity if the entity
is external, null otherwise.encoding
- The auto-detected IANA encoding name of the entity
stream. This value will be null in those situations
where the entity encoding is not auto-detected (e.g.
internal parameter entities).SAXException
- Thrown by handler to signal an error.public void comment(org.apache.xerces.xni.XMLString text) throws SAXException
comment
in class XMLDocumentParser
text
- The text in the comment.SAXException
- Thrown by application to signal an error.public void processingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data) throws SAXException
Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.
processingInstruction
in class XMLDocumentParser
target
- The target.data
- The data or null if none specified.SAXException
- Thrown by handler to signal an error.public void startDocument() throws SAXException
startDocument
in class XMLDocumentParser
SAXException
- Thrown by handler to signal an error.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId) throws SAXException
doctypeDecl
in class XMLDocumentParser
rootElement
- The name of the root element.publicId
- The public identifier if an external DTD or null
if the external DTD is specified using SYSTEM.systemId
- The system identifier if an external DTD, null
otherwise.SAXException
- Thrown by handler to signal an error.public void startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes) throws SAXException
startElement
in class XMLDocumentParser
element
- The name of the element.attributes
- The element attributes.SAXException
- Thrown by handler to signal an error.public void characters(org.apache.xerces.xni.XMLString text) throws SAXException
characters
in class XMLDocumentParser
text
- The content.SAXException
- Thrown by handler to signal an error.public void ignorableWhitespace(org.apache.xerces.xni.XMLString text) throws SAXException
ignorableWhitespace
in class XMLDocumentParser
text
- The ignorable whitespace.SAXException
- Thrown by handler to signal an error.public void endElement(org.apache.xerces.xni.QName element) throws SAXException
endElement
in class XMLDocumentParser
element
- The name of the element.SAXException
- Thrown by handler to signal an error.public void endPrefixMapping(java.lang.String prefix) throws SAXException
endPrefixMapping
in class XMLDocumentParser
prefix
- The namespace prefix.SAXException
- Thrown by handler to signal an error.public void startCDATA() throws SAXException
startCDATA
in class XMLDocumentParser
SAXException
- Thrown by handler to signal an error.public void endCDATA() throws SAXException
endCDATA
in class XMLDocumentParser
SAXException
- Thrown by handler to signal an error.public void endDocument() throws SAXException
endDocument
in class XMLDocumentParser
SAXException
- Thrown by handler to signal an error.public void endEntity(java.lang.String name) throws SAXException
Note: Since the document is an entity, the handler will be notified of the end of the document entity by calling the endEntity method with the entity name "[xml]" after calling the endDocument method. When exposing entity boundaries through the SAX API, the document entity is never reported, however.
Note: Since the DTD is an entity, the handler will be notified of the end of the DTD entity by calling the endEntity method with the entity name "[dtd]" after calling the endDTD method.
Note: This method is not called for entity references appearing as part of attribute values.
endEntity
in class XMLDocumentParser
name
- The name of the entity.SAXException
- Thrown by handler to signal an error.public void startDTD() throws SAXException
startDTD
in class XMLDocumentParser
SAXException
- Thrown by handler to signal an error.public void endDTD() throws SAXException
endDTD
in class XMLDocumentParser
SAXException
- Thrown by handler to signal an error.protected int buildAttrEntityRefs(Text text, org.apache.xerces.xni.XMLAttributes attributes, int attrIndex, int entityCount, int entityIndex, int textOffset)
text
- The text node that needs to be split.attributes
- The attribute information.attrIndex
- The attribute index.entityCount
- The number of entities. This is passed as
a convenience so that this method doesn't
have to call XMLAttributes#getEntityCount.
The caller already has the entity count so
it's kind of a waste to make each invocation
of this method query it again.entityIndex
- The entity index that this method invocation
should start building from.textOffset
- The offset at which the start of this text
should be considered. We need this to adjust
the offset since the characters in the current
text string are indexed from zero.
|
Xerces 2.0.0.alpha | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |