java.lang.Object | |
↳ | org.apache.xerces.dom.DOMNormalizer |
This class adds implementation for normalizeDocument method. It acts as if the document was going through a save and load cycle, putting the document in a "normal" form. The actual result depends on the features being set and governing what operations actually take place. See setNormalizationFeature for details. Noticeably this method normalizes Text nodes, makes the document "namespace wellformed", according to the algorithm described below in pseudo code, by adding missing namespace declaration attributes and adding or changing namespace prefixes, updates the replacement tree of EntityReference nodes, normalizes attribute values, etc. Mutation events, when supported, are generated to reflect the changes occuring on the document. See Namespace normalization for details on how namespace declaration attributes and prefixes are normalized. NOTE: There is an initial support for DOM revalidation with XML Schema as a grammar. The tree might not be validated correctly if entityReferences, CDATA sections are present in the tree. The PSVI information is not exposed, normalized data (including element default content is not available).@xerces.experimental
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DOMNormalizer.XMLAttributesProxy |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean | DEBUG | Debug namespace fix up algorithm | |||||||||
boolean | DEBUG_EVENTS | Debug document handler events | |||||||||
boolean | DEBUG_ND | Debug normalize document | |||||||||
String | PREFIX | prefix added by namespace fixup algorithm should follow a pattern "NS" + index |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
EMPTY_STRING | Empty string to pass to the validator. | ||||||||||
abort | If the user stops the process, this exception will be thrown. | ||||||||||
fAttrProxy | |||||||||||
fAttributeList | list of attributes | ||||||||||
fConfiguration | |||||||||||
fCurrentNode | for setting the PSVI | ||||||||||
fDocument | |||||||||||
fErrorHandler | error handler. | ||||||||||
fLocalNSBinder | Stores all namespace bindings on the current element | ||||||||||
fLocator | DOM Locator - for namespace fixup algorithm | ||||||||||
fNamespaceContext | The namespace context of this document: stores namespaces in scope | ||||||||||
fNamespaceValidation | |||||||||||
fPSVI | |||||||||||
fQName | |||||||||||
fSymbolTable | symbol table | ||||||||||
fValidationHandler | Validation handler represents validator instance. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Character content.
| |||||||||||
A comment.
| |||||||||||
Notifies of the presence of the DOCTYPE line in the document.
| |||||||||||
An empty element.
| |||||||||||
The end of a CDATA section.
| |||||||||||
The end of the document.
| |||||||||||
The end of an element.
| |||||||||||
This method notifies the end of a general entity.
| |||||||||||
Returns the document source.
| |||||||||||
Ignorable whitespace.
| |||||||||||
NON-DOM: check if attribute value is well-formed
| |||||||||||
Check if CDATA section is well-formed
| |||||||||||
NON-DOM: check if value of the comment is well-formed
| |||||||||||
NON-DOM: check for valid XML characters as per the XML version
| |||||||||||
A processing instruction.
| |||||||||||
Reports a DOM error to the user handler.
| |||||||||||
Sets the document source.
| |||||||||||
The start of a CDATA section.
| |||||||||||
The start of the document.
| |||||||||||
The start of an element.
| |||||||||||
This method notifies the start of a general entity.
| |||||||||||
Notifies of the presence of a TextDecl line in an entity.
| |||||||||||
Notifies of the presence of an XMLDecl line in the document.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a namespace attribute or replaces the value of existing namespace
attribute with the given prefix and value for URI.
| |||||||||||
Normalizes document.
| |||||||||||
This method acts as if the document was going through a save
and load cycle, putting the document in a "normal" form.
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.xerces.xni.XMLDocumentHandler
|
Debug namespace fix up algorithm
Debug document handler events
Debug normalize document
prefix added by namespace fixup algorithm should follow a pattern "NS" + index
If the user stops the process, this exception will be thrown.
for setting the PSVI
error handler. may be null.
Stores all namespace bindings on the current element
The namespace context of this document: stores namespaces in scope
Character content.
text | The content. |
---|---|
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
A comment.
text | The text in the comment. |
---|---|
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by application to signal an error. |
---|
Notifies of the presence of the DOCTYPE line in the document.
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 |
XNIException | Thrown by handler to signal an error. |
---|
An empty element.
element | The name of the element. |
---|---|
attributes | The element attributes. |
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
The end of a CDATA section.
augs | Additional information that may include infoset augmentations |
---|
XNIException | Thrown by handler to signal an error. |
---|
The end of the document.
augs | Additional information that may include infoset augmentations |
---|
XNIException | Thrown by handler to signal an error. |
---|
The end of an element.
element | The name of the element. |
---|---|
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
This method notifies the end of a general entity.
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 augmentations |
XNIException | Thrown by handler to signal an error. |
---|
Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.
text | The ignorable whitespace. |
---|---|
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
NON-DOM: check if attribute value is well-formed
Check if CDATA section is well-formed
isXML11Version | = true if XML 1.1 |
---|
NON-DOM: check if value of the comment is well-formed
isXML11Version | = true if XML 1.1 |
---|
NON-DOM: check for valid XML characters as per the XML version
isXML11Version | = true if XML 1.1 |
---|
A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.
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. |
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
Reports a DOM error to the user handler. If the error is fatal, the processing will be always aborted.
The start of a CDATA section.
augs | Additional information that may include infoset augmentations |
---|
XNIException | Thrown by handler to signal an error. |
---|
The start of the document.
locator | The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document. |
---|---|
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 |
XNIException | Thrown by handler to signal an error. |
---|
The start of an element.
element | The name of the element. |
---|---|
attributes | The element attributes. |
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
This method notifies the start of a general entity.
Note: This method is not called for entity references appearing as part of attribute values.
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 |
XNIException | Thrown by handler to signal an error. |
---|
Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.
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. |
augs | Additional information that may include infoset augmentations |
XNIException | Thrown by handler to signal an error. |
---|
Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.
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 |
XNIException | Thrown by handler to signal an error. |
---|
Adds a namespace attribute or replaces the value of existing namespace attribute with the given prefix and value for URI. In case prefix is empty will add/update default namespace declaration.
IOException |
---|
Normalizes document. Note: reset() must be called before this method.
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. The actual result depends on the features being set and governing what operations actually take place. See setNormalizationFeature for details. Noticeably this method normalizes Text nodes, makes the document "namespace wellformed", according to the algorithm described below in pseudo code, by adding missing namespace declaration attributes and adding or changing namespace prefixes, updates the replacement tree of EntityReference nodes,normalizes attribute values, etc.
node | Modified node or null. If node is returned, we need to normalize again starting on the node returned. |
---|