|
|||||||||
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.AbstractXMLDocumentParser | +--org.apache.xerces.parsers.AbstractDOMParser
This is the base class of all DOM parsers. It 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. The actual pipeline is defined in
parser configuration.
Field Summary | |
protected static java.lang.String |
CREATE_CDATA_NODES_FEATURE
Feature id: create cdata nodes. |
protected static java.lang.String |
CREATE_ENTITY_REF_NODES
Feature id: create entity ref nodes. |
protected static java.lang.String |
DEFAULT_DOCUMENT_CLASS_NAME
Default document class name. |
protected static java.lang.String |
DEFER_NODE_EXPANSION
Feature id: defer node expansion. |
protected static java.lang.String |
DOCUMENT_CLASS_NAME
Property id: document class name. |
protected boolean |
fCreateCDATANodes
Create cdata nodes. |
protected boolean |
fCreateEntityRefNodes
Create entity reference nodes. |
protected org.w3c.dom.CDATASection |
fCurrentCDATASection
|
protected int |
fCurrentCDATASectionIndex
|
protected org.w3c.dom.Node |
fCurrentNode
Current node. |
protected int |
fCurrentNodeIndex
|
protected boolean |
fDeferNodeExpansion
|
protected DeferredDocumentImpl |
fDeferredDocumentImpl
|
protected org.w3c.dom.Document |
fDocument
The document. |
protected java.lang.String |
fDocumentClassName
The document class name to use. |
protected DocumentImpl |
fDocumentImpl
The default Xerces document implementation, if used. |
protected int |
fDocumentIndex
|
protected org.w3c.dom.DocumentType |
fDocumentType
The document type node. |
protected int |
fDocumentTypeIndex
|
protected boolean |
fInCDATASection
True if inside CDATA section. |
protected boolean |
fIncludeComments
Include Comments. |
protected boolean |
fIncludeIgnorableWhitespace
Include ignorable whitespace. |
protected boolean |
fInDocument
True if inside document. |
protected boolean |
fNamespaceAware
|
protected static java.lang.String |
INCLUDE_COMMENTS_FEATURE
Feature id: include comments. |
protected static java.lang.String |
INCLUDE_IGNORABLE_WHITESPACE
Feature id: include ignorable whitespace. |
protected static java.lang.String |
NAMESPACES
Feature id: namespace. |
Fields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser |
fInDTD |
Fields inherited from class org.apache.xerces.parsers.XMLParser |
ENTITY_RESOLVER,
ERROR_HANDLER,
fConfiguration |
Constructor Summary | |
protected |
AbstractDOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Default constructor. |
Method Summary | |
void |
attributeDecl(java.lang.String elementName,
java.lang.String attributeName,
java.lang.String type,
java.lang.String[] enumeration,
java.lang.String defaultType,
org.apache.xerces.xni.XMLString defaultValue)
An attribute declaration. |
void |
characters(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
Character content. |
void |
comment(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
A comment. |
void |
doctypeDecl(java.lang.String rootElement,
java.lang.String publicId,
java.lang.String systemId,
org.apache.xerces.xni.Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document. |
void |
endCDATA(org.apache.xerces.xni.Augmentations augs)
The end of a CDATA section. |
void |
endDocument(org.apache.xerces.xni.Augmentations augs)
The end of the document. |
void |
endElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.Augmentations augs)
The end of an element. |
void |
endEntity(java.lang.String name,
org.apache.xerces.xni.Augmentations augs)
This method notifies the end of an entity. |
void |
endPrefixMapping(java.lang.String prefix,
org.apache.xerces.xni.Augmentations augs)
The end of a namespace prefix mapping. |
void |
externalEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId)
An external entity declaration. |
org.w3c.dom.Document |
getDocument()
Returns the DOM document object. |
void |
ignorableWhitespace(org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.Augmentations augs)
Ignorable whitespace. |
void |
internalEntityDecl(java.lang.String name,
org.apache.xerces.xni.XMLString text,
org.apache.xerces.xni.XMLString nonNormalizedText)
An internal entity declaration. |
void |
notationDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId)
A notation declaration |
void |
processingInstruction(java.lang.String target,
org.apache.xerces.xni.XMLString data,
org.apache.xerces.xni.Augmentations augs)
A processing instruction. |
void |
reset()
Resets the parser state. |
protected void |
setDocumentClassName(java.lang.String documentClassName)
This method allows the programmer to decide which document factory to use when constructing the DOM tree. |
void |
startCDATA(org.apache.xerces.xni.Augmentations augs)
The start of a CDATA section. |
void |
startDocument(org.apache.xerces.xni.XMLLocator locator,
java.lang.String encoding,
org.apache.xerces.xni.Augmentations augs)
The start of the document. |
void |
startElement(org.apache.xerces.xni.QName element,
org.apache.xerces.xni.XMLAttributes attributes,
org.apache.xerces.xni.Augmentations augs)
The start of an element. |
void |
startEntity(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.lang.String encoding,
org.apache.xerces.xni.Augmentations augs)
This method notifies of the start of an entity. |
void |
textDecl(java.lang.String version,
java.lang.String encoding)
Notifies of the presence of a TextDecl line in an entity. |
void |
unparsedEntityDecl(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notation)
An unparsed entity declaration. |
void |
xmlDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone)
Notifies of the presence of an XMLDecl line in the document. |
Methods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser |
any,
characters,
comment,
element,
elementDecl,
empty,
emptyElement,
endAttlist,
endConditional,
endContentModel,
endDTD,
endEntity,
endGroup,
occurrence,
pcdata,
processingInstruction,
separator,
startAttlist,
startConditional,
startContentModel,
startDTD,
startEntity,
startGroup,
startPrefixMapping,
textDecl,
xmlDecl |
Methods inherited from class org.apache.xerces.parsers.XMLParser |
parse |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected static final java.lang.String CREATE_ENTITY_REF_NODES
protected static final java.lang.String NAMESPACES
protected static final java.lang.String INCLUDE_COMMENTS_FEATURE
protected static final java.lang.String CREATE_CDATA_NODES_FEATURE
protected static final java.lang.String INCLUDE_IGNORABLE_WHITESPACE
protected static final java.lang.String DEFER_NODE_EXPANSION
protected static final java.lang.String DOCUMENT_CLASS_NAME
protected static final java.lang.String DEFAULT_DOCUMENT_CLASS_NAME
protected boolean fCreateEntityRefNodes
protected boolean fIncludeIgnorableWhitespace
protected boolean fIncludeComments
protected boolean fCreateCDATANodes
protected org.w3c.dom.Document fDocument
protected DocumentImpl fDocumentImpl
protected java.lang.String fDocumentClassName
protected org.w3c.dom.DocumentType fDocumentType
protected org.w3c.dom.Node fCurrentNode
protected org.w3c.dom.CDATASection fCurrentCDATASection
protected boolean fDeferNodeExpansion
protected boolean fNamespaceAware
protected DeferredDocumentImpl fDeferredDocumentImpl
protected int fDocumentIndex
protected int fDocumentTypeIndex
protected int fCurrentNodeIndex
protected int fCurrentCDATASectionIndex
protected boolean fInDocument
protected boolean fInCDATASection
Constructor Detail |
protected AbstractDOMParser(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Method Detail |
protected void setDocumentClassName(java.lang.String documentClassName)
documentClassName
- The fully qualified class name of the
document factory to use when constructing
the DOM tree.#getDocumentClassName
,
#setDeferNodeExpansion
,
DEFAULT_DOCUMENT_CLASS_NAME
public org.w3c.dom.Document getDocument()
public void reset() throws org.apache.xerces.xni.XNIException
public void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
Note: This method is not called for entity references appearing as part of attribute values.
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).public void textDecl(java.lang.String version, java.lang.String encoding) throws org.apache.xerces.xni.XNIException
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.
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.public void comment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
text
- The text in the comment.public void processingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
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.
target
- The target.data
- The data or null if none specified.public void startDocument(org.apache.xerces.xni.XMLLocator locator, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
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 entities or a document entity that is
parsed from a java.io.Reader).augs
- Additional information that may include infoset augmentationspublic void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone) throws org.apache.xerces.xni.XNIException
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.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
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 augmentationspublic void startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
element
- The name of the element.attributes
- The element attributes.augs
- Additional information that may include infoset augmentationspublic void characters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
text
- The content.augs
- Additional information that may include infoset augmentationspublic void ignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
text
- The ignorable whitespace.augs
- Additional information that may include infoset augmentationspublic void endElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
element
- The name of the element.augs
- Additional information that may include infoset augmentationspublic void endPrefixMapping(java.lang.String prefix, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
prefix
- The namespace prefix.augs
- Additional information that may include infoset augmentationspublic void startCDATA(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
augs
- Additional information that may include infoset augmentationspublic void endCDATA(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
augs
- Additional information that may include infoset augmentationspublic void endDocument(org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
augs
- Additional information that may include infoset augmentationspublic void endEntity(java.lang.String name, org.apache.xerces.xni.Augmentations augs) throws org.apache.xerces.xni.XNIException
Note: This method is not called for entity references appearing as part of attribute values.
name
- The name of the entity.augs
- Additional information that may include infoset augmentationspublic void internalEntityDecl(java.lang.String name, org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.XMLString nonNormalizedText) throws org.apache.xerces.xni.XNIException
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.public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId) throws org.apache.xerces.xni.XNIException
name
- The name of the entity. Parameter entity names start
with '%', whereas the name of a general entity is just
the entity name.publicId
- The public identifier of the entity or null if the
the entity was specified with SYSTEM.systemId
- The system identifier of the entity.baseSystemId
- The base system identifier where this entity
is declared.public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation) throws org.apache.xerces.xni.XNIException
name
- The name of the entity.publicId
- The public identifier of the entity, or null if not
specified.systemId
- The system identifier of the entity, or null if not
specified.notation
- The name of the notation.public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.apache.xerces.xni.XNIException
name
- The name of the notation.publicId
- The public identifier of the notation, or null if not
specified.systemId
- The system identifier of the notation, or null if not
specified.public void attributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, org.apache.xerces.xni.XMLString defaultValue) throws org.apache.xerces.xni.XNIException
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |