org.apache.xerces.parsers
public class AbstractDOMParser extends AbstractXMLDocumentParser
getDocument
method. The actual pipeline is defined in
parser configuration.
Version: $Id: AbstractDOMParser.java,v 1.116 2005/05/09 19:46:17 ankitp Exp $
Field Summary | |
---|---|
static RuntimeException | abort
If the user stops the process, this exception will be thrown. |
protected static String | CORE_DOCUMENT_CLASS_NAME |
protected static String | CREATE_CDATA_NODES_FEATURE Feature id: create cdata nodes. |
protected static String | CREATE_ENTITY_REF_NODES Feature id: create entity ref nodes. |
protected static String | CURRENT_ELEMENT_NODE |
protected static String | DEFAULT_DOCUMENT_CLASS_NAME Default document class name. |
protected static String | DEFER_NODE_EXPANSION Feature id: defer node expansion. |
protected static String | DOCUMENT_CLASS_NAME Property id: document class name. |
protected Stack | fBaseURIStack Base uri stack |
protected boolean | fCreateCDATANodes Create cdata nodes. |
protected boolean | fCreateEntityRefNodes Create entity reference nodes. |
protected CDATASection | fCurrentCDATASection |
protected int | fCurrentCDATASectionIndex |
protected EntityImpl | fCurrentEntityDecl |
protected Node | fCurrentNode Current node. |
protected int | fCurrentNodeIndex |
protected boolean | fDeferNodeExpansion |
protected DeferredDocumentImpl | fDeferredDocumentImpl |
protected int | fDeferredEntityDecl |
protected Document | fDocument The document. |
protected String | fDocumentClassName The document class name to use. |
protected CoreDocumentImpl | fDocumentImpl The default Xerces document implementation, if used. |
protected int | fDocumentIndex |
protected DocumentType | fDocumentType The document type node. |
protected int | fDocumentTypeIndex |
protected LSParserFilter | fDOMFilter |
protected DOMErrorHandlerWrapper | fErrorHandler DOM L3 error handler |
protected boolean | fFilterReject LSParserFilter: specifies that element with given QNAME and all its children
must be rejected |
protected boolean | fFirstChunk True if saw the first chunk of characters |
protected boolean | fIncludeComments Include Comments. |
protected boolean | fIncludeIgnorableWhitespace Include ignorable whitespace. |
protected boolean | fInCDATASection True if inside CDATA section. |
protected boolean | fInDTD True if inside DTD. |
protected boolean | fInDTDExternalSubset True if inside DTD external subset. |
protected boolean | fInEntityRef LSParserFilter: true if inside entity reference |
protected StringBuffer | fInternalSubset Internal subset buffer. |
protected boolean | fNamespaceAware |
protected QName | fRejectedElement LSParserFilter: the QNAME of rejected element |
protected QName | fRoot Root element name |
protected Stack | fSkippedElemStack LSParserFilter: store qnames of skipped elements |
protected boolean | fStorePSVI Whether to store PSVI information in DOM tree. |
protected StringBuffer | fStringBuffer Character buffer |
protected static String | INCLUDE_COMMENTS_FEATURE Feature id: include comments. |
protected static String | INCLUDE_IGNORABLE_WHITESPACE Feature id: include ignorable whitespace. |
protected static String | NAMESPACES Feature id: namespace. |
protected static String | PSVI_DOCUMENT_CLASS_NAME |
Constructor Summary | |
---|---|
protected | AbstractDOMParser(XMLParserConfiguration config) Default constructor. |
Method Summary | |
---|---|
void | abort() |
void | attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
An attribute declaration.
|
void | characters(XMLString text, Augmentations augs)
Character content.
|
void | comment(XMLString text, Augmentations augs)
A comment.
|
protected Attr | createAttrNode(QName attrQName) |
protected Element | createElementNode(QName element) |
void | doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
|
void | elementDecl(String name, String contentModel, Augmentations augs)
An element declaration.
|
void | emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
|
void | endAttlist(Augmentations augs)
The end of an attribute list.
|
void | endCDATA(Augmentations augs)
The end of a CDATA section. |
void | endConditional(Augmentations augs)
The end of a conditional section.
|
void | endDocument(Augmentations augs)
The end of the document. |
void | endDTD(Augmentations augs)
The end of the DTD.
|
void | endElement(QName element, Augmentations augs)
The end of an element.
|
void | endExternalSubset(Augmentations augs)
The end of the DTD external subset.
|
void | endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
|
void | endParameterEntity(String name, Augmentations augs)
This method notifies the end of a parameter entity. |
void | externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
An external entity declaration.
|
Document | getDocument() Returns the DOM document object. |
protected String | getDocumentClassName()
This method retreives the name of current document class. |
protected void | handleBaseURI(Node node)
Record baseURI information for the Element (by adding xml:base attribute)
or for the ProcessingInstruction (by setting a baseURI field)
Non deferred DOM.
|
protected void | handleBaseURI(int node)
Record baseURI information for the Element (by adding xml:base attribute)
or for the ProcessingInstruction (by setting a baseURI field)
Deferred DOM.
|
void | ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace. |
void | ignoredCharacters(XMLString text, Augmentations augs)
Characters within an IGNORE conditional section.
|
void | internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augs)
An internal entity declaration.
|
void | notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augs)
A notation declaration
|
void | processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction. |
void | reset()
Resets the parser state.
|
protected void | setCharacterData(boolean sawChars) |
protected void | setDocumentClassName(String documentClassName)
This method allows the programmer to decide which document
factory to use when constructing the DOM tree. |
void | setLocale(Locale locale)
Set the locale to use for messages.
|
void | startAttlist(String elementName, Augmentations augs)
The start of an attribute list.
|
void | startCDATA(Augmentations augs)
The start of a CDATA section. |
void | startConditional(short type, Augmentations augs)
The start of a conditional section.
|
void | startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
|
void | startDTD(XMLLocator locator, Augmentations augs)
The start of the DTD.
|
void | startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element. |
void | startExternalSubset(XMLResourceIdentifier identifier, Augmentations augs)
The start of the DTD external subset.
|
void | startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
|
void | startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies of the start of a parameter entity. |
void | textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. |
void | unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augs)
An unparsed entity declaration.
|
void | xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
See Also: org.w3c.dom.ls.LSParser#abort()
Parameters: elementName The name of the element that this attribute is associated with. attributeName The name of the attribute. type The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION". enumeration If the type has the value "ENUMERATION" or "NOTATION", this array holds the allowed attribute values; otherwise, this array is null. defaultType The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null. defaultValue The attribute default value, or null if no default value is specified. nonNormalizedDefaultValue The attribute default value with no normalization performed, or null if no default value is specified. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: text The content. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: text The text in the comment. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by application to signal an error.
Parameters: 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. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the element. contentModel The element content model. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: element The name of the element. attributes The element attributes. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: element The name of the element. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Note: This method is not called for entity references appearing as part of attribute values.
Parameters: name The name of the entity. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the parameter entity. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name. identifier An object containing all location information pertinent to this notation. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: node
Parameters: node
Parameters: text The ignorable whitespace. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: text The ignored text. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name. text The value of the entity. nonNormalizedText The non-normalized value of the entity. This value contains the same sequence of characters that was in the internal entity declaration, without any entity references expanded. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the notation. identifier An object containing all location information pertinent to this notation. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
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.
Parameters: target The target. data The data or null if none specified. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Throws: SAXException Thrown on initialization error.
Parameters: documentClassName The fully qualified class name of the document factory to use when constructing the DOM tree.
See Also: AbstractDOMParser DEFAULT_DOCUMENT_CLASS_NAME
Parameters: locale The locale object to use for localization of messages.
Parameters: elementName The name of the element that this attribute list is associated with. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: type The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
See Also: AbstractDOMParser AbstractDOMParser
Parameters: locator 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 entities or a document entity that is parsed from a java.io.Reader). namespaceContext The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: locator The document locator, or null if the document location cannot be reported during the parsing of the document DTD. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier of the DTD. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: element The name of the element. attributes The element attributes. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Note: This method is not called for entity references appearing as part of attribute values.
Parameters: name The name of the general entity. identifier The resource identifier. 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 entities or a document entity that is parsed from a java.io.Reader). augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the parameter entity. identifier The resource identifier. 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). augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.
Note: This method is not called for entity references appearing as part of attribute values.
Parameters: version The XML version, or null if not specified. encoding The IANA encoding name of the entity. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.
Parameters: name The name of the entity. identifier An object containing all location information pertinent to this entity. notation The name of the notation. augs Additional information that may include infoset augmentations.
Throws: XNIException Thrown by handler to signal an error.
Parameters: version The XML version. encoding The IANA encoding name of the document, or null if not specified. standalone The standalone value, or null if not specified. augs Additional information that may include infoset augmentations
Throws: XNIException Thrown by handler to signal an error.