| java.lang.Object
 org.apache.xerces.dom.DOMNormalizer
| DOMNormalizer | | public class DOMNormalizer implements XMLDocumentHandler(Code) | | 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).
author:
Elena Litani, IBM
author:
Neeraj Bajaj, Sun Microsystems, inc.
version:
$Id: DOMNormalizer.java 541770 2007-05-25 20:17:48Z mrglavas $ |
| Inner Class :final protected class XMLAttributesProxy implements XMLAttributes | |
| Method Summary | |
| final protected void | addNamespaceDecl(String prefix, String uri, ElementImpl element)
Adds a namespace attribute or replaces the value of existing namespace
attribute with the given prefix and value for URI. | | public void | characters(XMLString text, Augmentations augs)
Character content. | | public void | comment(XMLString text, Augmentations augs)
A comment. | | public void | doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document. | | public void | emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element. | | public void | endCDATA(Augmentations augs)
The end of a CDATA section. | | public void | endDocument(Augmentations augs)
The end of the document. | | public void | endElement(QName element, Augmentations augs)
The end of an element. | | public void | endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity. | | final protected void | expandEntityRef(Node parent, Node reference)
| | public XMLDocumentSource | getDocumentSource()
Returns the document source. | | public void | ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace. | | final public static void | isAttrValueWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, NamedNodeMap attributes, Attr a, String value, boolean xml11Version)
| | final public static void | isCDataWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
| | final public static void | isCommentWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
| | final public static void | isXMLCharWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
| | final protected void | namespaceFixUp(ElementImpl element, AttributeMap attributes)
| | final String | normalizeAttributeValue(String value, Attr attr)
| | protected void | normalizeDocument(CoreDocumentImpl document, DOMConfigurationImpl config)
Normalizes document. | | protected Node | normalizeNode(Node node)
This method acts as if the document was going through a save
and load cycle, putting the document in a "normal" form. | | public void | processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction. | | final public static void | reportDOMError(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String message, short severity, String type)
Reports a DOM error to the user handler. | | public void | setDocumentSource(XMLDocumentSource source)
Sets the document source. | | public void | startCDATA(Augmentations augs)
The start of a CDATA section. | | public void | startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. | | public void | startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element. | | public void | startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the general entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. | | public void | textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. | | final protected void | updateQName(Node node, QName qname)
| | public void | xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
| DEBUG | | final protected static boolean DEBUG(Code) | | Debug namespace fix up algorithm
|
| DEBUG_EVENTS | | final protected static boolean DEBUG_EVENTS(Code) | | Debug document handler events
|
| DEBUG_ND | | final protected static boolean DEBUG_ND(Code) | | Debug normalize document
|
| EMPTY_STRING | | final public static XMLString EMPTY_STRING(Code) | | Empty string to pass to the validator. *
|
| PREFIX | | final protected static String PREFIX(Code) | | prefix added by namespace fixup algorithm should follow a pattern "NS" + index
|
| abort | | final public static RuntimeException abort(Code) | | If the user stops the process, this exception will be thrown.
|
| fAttrProxy | | final protected XMLAttributesProxy fAttrProxy(Code) | | |
| fAttributeList | | final protected Vector fAttributeList(Code) | | list of attributes
|
| fCurrentNode | | protected Node fCurrentNode(Code) | | for setting the PSVI
|
| fLocalNSBinder | | final protected NamespaceContext fLocalNSBinder(Code) | | Stores all namespace bindings on the current element
|
| fNamespaceContext | | final protected NamespaceContext fNamespaceContext(Code) | | The namespace context of this document: stores namespaces in scope
|
| fNamespaceValidation | | protected boolean fNamespaceValidation(Code) | | |
| fPSVI | | protected boolean fPSVI(Code) | | |
| DOMNormalizer | | public DOMNormalizer()(Code) | | |
| addNamespaceDecl | | final protected void addNamespaceDecl(String prefix, String uri, ElementImpl element)(Code) | | 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.
Parameters:
prefix -
Parameters:
uri -
exception:
IOException - |
| characters | | public void characters(XMLString text, Augmentations augs) throws XNIException(Code) | | Character content.
Parameters:
text - The content.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| comment | | public void comment(XMLString text, Augmentations augs) throws XNIException(Code) | | A comment.
Parameters:
text - The text in the comment.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by application to signal an error. |
| doctypeDecl | | public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of the DOCTYPE line in the document.
Parameters:
rootElement - The name of the root element.
Parameters:
publicId - The public identifier if an external DTD or nullif the external DTD is specified using SYSTEM.
Parameters:
systemId - The system identifier if an external DTD, nullotherwise.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| emptyElement | | public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | An empty element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endCDATA | | public void endCDATA(Augmentations augs) throws XNIException(Code) | | The end of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endDocument | | public void endDocument(Augmentations augs) throws XNIException(Code) | | The end of the document.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endElement | | public void endElement(QName element, Augmentations augs) throws XNIException(Code) | | The end of an element.
Parameters:
element - The name of the element.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endGeneralEntity | | public void endGeneralEntity(String name, Augmentations augs) throws XNIException(Code) | | This method notifies the end of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| expandEntityRef | | final protected void expandEntityRef(Node parent, Node reference)(Code) | | |
| ignorableWhitespace | | public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException(Code) | | 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.
Parameters:
text - The ignorable whitespace.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| isCDataWF | | final public static void isCDataWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)(Code) | | Check if CDATA section is well-formed
Parameters:
datavalue -
Parameters:
isXML11Version - = true if XML 1.1 |
| isCommentWF | | final public static void isCommentWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)(Code) | | NON-DOM: check if value of the comment is well-formed
Parameters:
datavalue -
Parameters:
isXML11Version - = true if XML 1.1 |
| isXMLCharWF | | final public static void isXMLCharWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)(Code) | | NON-DOM: check for valid XML characters as per the XML version
Parameters:
datavalue -
Parameters:
isXML11Version - = true if XML 1.1 |
| normalizeNode | | protected Node normalizeNode(Node node)(Code) | | 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.
Parameters:
node - Modified node or null. If node is returned, we needto normalize again starting on the node returned. the normalized Node |
| processingInstruction | | public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException(Code) | | 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.
Parameters:
target - The target.
Parameters:
data - The data or null if none specified.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startCDATA | | public void startCDATA(Augmentations augs) throws XNIException(Code) | | The start of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startDocument | | public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException(Code) | | The start of the document.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. However, it is stronglyrecommended that a locator be supplied that canat least report the system identifier of thedocument.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
namespaceContext - The namespace context in effect at thestart of this document.This object represents the current context.Implementors of this class are responsiblefor copying the namespace bindings from thethe current context (and its parent contexts)if that information is important.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startElement | | public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | The start of an element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startGeneralEntity | | public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code) | | This method notifies the start of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the general entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| textDecl | | public void textDecl(String version, String encoding, Augmentations augs) throws XNIException(Code) | | 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.
Parameters:
version - The XML version, or null if not specified.
Parameters:
encoding - The IANA encoding name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| xmlDecl | | public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of an XMLDecl line in the document. If
present, this method will be called immediately following the
startDocument call.
Parameters:
version - The XML version.
Parameters:
encoding - The IANA encoding name of the document, or null ifnot specified.
Parameters:
standalone - The standalone value, or null if not specified.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
|
|