org.apache.xerces.dom

Class DOMNormalizer

public class DOMNormalizer extends Object implements XMLDocumentHandler

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).

Version: $Id: DOMNormalizer.java,v 1.62 2005/07/25 04:24:21 mrglavas Exp $

Author: Elena Litani, IBM Neeraj Bajaj, Sun Microsystems, inc.

UNKNOWN:

Nested Class Summary
protected classDOMNormalizer.XMLAttributesProxy
Field Summary
static RuntimeExceptionabort
If the user stops the process, this exception will be thrown.
protected static booleanDEBUG
Debug namespace fix up algorithm
protected static booleanDEBUG_EVENTS
Debug document handler events
protected static booleanDEBUG_ND
Debug normalize document
protected VectorfAttributeList
list of attributes
protected DOMNormalizer.XMLAttributesProxyfAttrProxy
protected DOMConfigurationImplfConfiguration
protected NodefCurrentNode
for setting the PSVI
protected CoreDocumentImplfDocument
protected DOMErrorHandlerfErrorHandler
error handler. may be null.
protected NamespaceContextfLocalNSBinder
Stores all namespace bindings on the current element
protected DOMLocatorImplfLocator
DOM Locator - for namespace fixup algorithm
protected NamespaceContextfNamespaceContext
The namespace context of this document: stores namespaces in scope
protected booleanfNamespaceValidation
protected booleanfPSVI
protected QNamefQName
protected SymbolTablefSymbolTable
symbol table
protected RevalidationHandlerfValidationHandler
Validation handler represents validator instance.
protected static StringPREFIX
prefix added by namespace fixup algorithm should follow a pattern "NS" + index
Constructor Summary
DOMNormalizer()
Method Summary
protected voidaddNamespaceDecl(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.
voidcharacters(XMLString text, Augmentations augs)
Character content.
voidcomment(XMLString text, Augmentations augs)
A comment.
voiddoctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
voidemptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
voidendCDATA(Augmentations augs)
The end of a CDATA section.
voidendDocument(Augmentations augs)
The end of the document.
voidendElement(QName element, Augmentations augs)
The end of an element.
voidendGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
protected voidexpandEntityRef(Node parent, Node reference)
XMLDocumentSourcegetDocumentSource()
Returns the document source.
voidignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
static voidisAttrValueWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, NamedNodeMap attributes, Attr a, String value, boolean xml11Version)
NON-DOM: check if attribute value is well-formed
static voidisCDataWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
Check if CDATA section is well-formed
static voidisCommentWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
NON-DOM: check if value of the comment is well-formed
static voidisXMLCharWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
NON-DOM: check for valid XML characters as per the XML version
protected voidnamespaceFixUp(ElementImpl element, AttributeMap attributes)
protected voidnormalizeDocument(CoreDocumentImpl document, DOMConfigurationImpl config)
Normalizes document.
protected NodenormalizeNode(Node node)
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form.
voidprocessingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
static voidreportDOMError(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String message, short severity, String type)
Reports a DOM error to the user handler.
voidsetDocumentSource(XMLDocumentSource source)
Sets the document source.
voidstartCDATA(Augmentations augs)
The start of a CDATA section.
voidstartDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element.
voidstartGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
voidtextDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
protected voidupdateQName(Node node, QName qname)
voidxmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.

Field Detail

abort

public static final RuntimeException abort
If the user stops the process, this exception will be thrown.

DEBUG

protected static final boolean DEBUG
Debug namespace fix up algorithm

DEBUG_EVENTS

protected static final boolean DEBUG_EVENTS
Debug document handler events

DEBUG_ND

protected static final boolean DEBUG_ND
Debug normalize document

fAttributeList

protected final Vector fAttributeList
list of attributes

fAttrProxy

protected final DOMNormalizer.XMLAttributesProxy fAttrProxy

fConfiguration

protected DOMConfigurationImpl fConfiguration

fCurrentNode

protected Node fCurrentNode
for setting the PSVI

fDocument

protected CoreDocumentImpl fDocument

fErrorHandler

protected DOMErrorHandler fErrorHandler
error handler. may be null.

fLocalNSBinder

protected final NamespaceContext fLocalNSBinder
Stores all namespace bindings on the current element

fLocator

protected final DOMLocatorImpl fLocator
DOM Locator - for namespace fixup algorithm

fNamespaceContext

protected final NamespaceContext fNamespaceContext
The namespace context of this document: stores namespaces in scope

fNamespaceValidation

protected boolean fNamespaceValidation

fPSVI

protected boolean fPSVI

fQName

protected final QName fQName

fSymbolTable

protected SymbolTable fSymbolTable
symbol table

fValidationHandler

protected RevalidationHandler fValidationHandler
Validation handler represents validator instance.

PREFIX

protected static final String PREFIX
prefix added by namespace fixup algorithm should follow a pattern "NS" + index

Constructor Detail

DOMNormalizer

public DOMNormalizer()

Method Detail

addNamespaceDecl

protected final 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. In case prefix is empty will add/update default namespace declaration.

Parameters: prefix uri

Throws: IOException

characters

public void characters(XMLString text, Augmentations augs)
Character content.

Parameters: text The content. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

comment

public void comment(XMLString text, Augmentations augs)
A comment.

Parameters: text The text in the comment. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by application to signal an error.

doctypeDecl

public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.

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.

emptyElement

public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.

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.

endCDATA

public void endCDATA(Augmentations augs)
The end of a CDATA section.

Parameters: augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
The end of the document.

Parameters: augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endElement

public void endElement(QName element, Augmentations augs)
The end of an element.

Parameters: element The name of the element. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

endGeneralEntity

public void endGeneralEntity(String name, Augmentations augs)
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. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

expandEntityRef

protected final void expandEntityRef(Node parent, Node reference)

getDocumentSource

public XMLDocumentSource getDocumentSource()
Returns the document source.

ignorableWhitespace

public void ignorableWhitespace(XMLString text, Augmentations augs)
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. augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

isAttrValueWF

public static final void isAttrValueWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, NamedNodeMap attributes, Attr a, String value, boolean xml11Version)
NON-DOM: check if attribute value is well-formed

Parameters: attributes a value

isCDataWF

public static final void isCDataWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
Check if CDATA section is well-formed

Parameters: datavalue isXML11Version = true if XML 1.1

isCommentWF

public static final void isCommentWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
NON-DOM: check if value of the comment is well-formed

Parameters: datavalue isXML11Version = true if XML 1.1

isXMLCharWF

public static final void isXMLCharWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String datavalue, boolean isXML11Version)
NON-DOM: check for valid XML characters as per the XML version

Parameters: datavalue isXML11Version = true if XML 1.1

namespaceFixUp

protected final void namespaceFixUp(ElementImpl element, AttributeMap attributes)

normalizeDocument

protected void normalizeDocument(CoreDocumentImpl document, DOMConfigurationImpl config)
Normalizes document. Note: reset() must be called before this method.

normalizeNode

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. 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 need to normalize again starting on the node returned.

Returns: the normalized Node

processingInstruction

public void processingInstruction(String target, XMLString data, Augmentations augs)
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. 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.

reportDOMError

public static final void reportDOMError(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, String message, short severity, String type)
Reports a DOM error to the user handler. If the error is fatal, the processing will be always aborted.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)
Sets the document source.

startCDATA

public void startCDATA(Augmentations augs)
The start of a CDATA section.

Parameters: augs Additional information that may include infoset augmentations

Throws: XNIException Thrown by handler to signal an error.

startDocument

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 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

Throws: XNIException Thrown by handler to signal an error.

startElement

public void startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element.

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.

startGeneralEntity

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. 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.

textDecl

public void textDecl(String version, String encoding, Augmentations augs)
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. 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.

updateQName

protected final void updateQName(Node node, QName qname)

xmlDecl

public void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
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. 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.

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.