|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.dom.DOMNormalizer
public class 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).
Field Summary | |
---|---|
static java.lang.RuntimeException |
abort
If the user stops the process, this exception will be thrown. |
static XMLString |
EMPTY_STRING
Empty string to pass to the validator. |
Constructor Summary | |
---|---|
DOMNormalizer()
|
Method Summary | |
---|---|
void |
characters(XMLString text,
Augmentations augs)
Character content. |
void |
comment(XMLString text,
Augmentations augs)
A comment. |
void |
doctypeDecl(java.lang.String rootElement,
java.lang.String publicId,
java.lang.String systemId,
Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document. |
void |
emptyElement(QName element,
XMLAttributes attributes,
Augmentations augs)
An empty element. |
void |
endCDATA(Augmentations augs)
The end of a CDATA section. |
void |
endDocument(Augmentations augs)
The end of the document. |
void |
endElement(QName element,
Augmentations augs)
The end of an element. |
void |
endGeneralEntity(java.lang.String name,
Augmentations augs)
This method notifies the end of a general entity. |
XMLDocumentSource |
getDocumentSource()
Returns the document source. |
void |
ignorableWhitespace(XMLString text,
Augmentations augs)
Ignorable whitespace. |
static void |
isAttrValueWF(DOMErrorHandler errorHandler,
DOMErrorImpl error,
DOMLocatorImpl locator,
NamedNodeMap attributes,
Attr a,
java.lang.String value,
boolean xml11Version)
NON-DOM: check if attribute value is well-formed |
static void |
isCDataWF(DOMErrorHandler errorHandler,
DOMErrorImpl error,
DOMLocatorImpl locator,
java.lang.String datavalue,
boolean isXML11Version)
Check if CDATA section is well-formed |
static void |
isCommentWF(DOMErrorHandler errorHandler,
DOMErrorImpl error,
DOMLocatorImpl locator,
java.lang.String datavalue,
boolean isXML11Version)
NON-DOM: check if value of the comment is well-formed |
static void |
isXMLCharWF(DOMErrorHandler errorHandler,
DOMErrorImpl error,
DOMLocatorImpl locator,
java.lang.String datavalue,
boolean isXML11Version)
NON-DOM: check for valid XML characters as per the XML version |
void |
processingInstruction(java.lang.String target,
XMLString data,
Augmentations augs)
A processing instruction. |
static void |
reportDOMError(DOMErrorHandler errorHandler,
DOMErrorImpl error,
DOMLocatorImpl locator,
java.lang.String message,
short severity,
java.lang.String type)
Reports a DOM error to the user handler. |
void |
setDocumentSource(XMLDocumentSource source)
Sets the document source. |
void |
startCDATA(Augmentations augs)
The start of a CDATA section. |
void |
startDocument(XMLLocator locator,
java.lang.String encoding,
NamespaceContext namespaceContext,
Augmentations augs)
The start of the document. |
void |
startElement(QName element,
XMLAttributes attributes,
Augmentations augs)
The start of an element. |
void |
startGeneralEntity(java.lang.String name,
XMLResourceIdentifier identifier,
java.lang.String encoding,
Augmentations augs)
This method notifies the start of a general entity. |
void |
textDecl(java.lang.String version,
java.lang.String encoding,
Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. |
void |
xmlDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone,
Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.RuntimeException abort
public static final XMLString EMPTY_STRING
Constructor Detail |
---|
public DOMNormalizer()
Method Detail |
---|
public static final void isCDataWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, java.lang.String datavalue, boolean isXML11Version)
datavalue
- isXML11Version
- = true if XML 1.1public static final void isXMLCharWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, java.lang.String datavalue, boolean isXML11Version)
datavalue
- isXML11Version
- = true if XML 1.1public static final void isCommentWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, java.lang.String datavalue, boolean isXML11Version)
datavalue
- isXML11Version
- = true if XML 1.1public static final void isAttrValueWF(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, NamedNodeMap attributes, Attr a, java.lang.String value, boolean xml11Version)
attributes
- a
- value
- public static final void reportDOMError(DOMErrorHandler errorHandler, DOMErrorImpl error, DOMLocatorImpl locator, java.lang.String message, short severity, java.lang.String type)
public void startDocument(XMLLocator locator, java.lang.String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException
startDocument
in interface XMLDocumentHandler
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.public void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, Augmentations augs) throws XNIException
xmlDecl
in interface XMLDocumentHandler
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.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, Augmentations augs) throws XNIException
doctypeDecl
in interface XMLDocumentHandler
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.public void comment(XMLString text, Augmentations augs) throws XNIException
comment
in interface XMLDocumentHandler
text
- The text in the comment.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by application to signal an error.public void processingInstruction(java.lang.String target, XMLString data, Augmentations augs) throws 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.
processingInstruction
in interface XMLDocumentHandler
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.public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
startElement
in interface XMLDocumentHandler
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.public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
emptyElement
in interface XMLDocumentHandler
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.public void startGeneralEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding, Augmentations augs) throws XNIException
Note: This method is not called for entity references appearing as part of attribute values.
startGeneralEntity
in interface XMLDocumentHandler
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.public void textDecl(java.lang.String version, java.lang.String encoding, Augmentations augs) throws 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.
textDecl
in interface XMLDocumentHandler
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.public void endGeneralEntity(java.lang.String name, Augmentations augs) throws XNIException
Note: This method is not called for entity references appearing as part of attribute values.
endGeneralEntity
in interface XMLDocumentHandler
name
- The name of the entity.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void characters(XMLString text, Augmentations augs) throws XNIException
characters
in interface XMLDocumentHandler
text
- The content.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException
ignorableWhitespace
in interface XMLDocumentHandler
text
- The ignorable whitespace.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void endElement(QName element, Augmentations augs) throws XNIException
endElement
in interface XMLDocumentHandler
element
- The name of the element.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void startCDATA(Augmentations augs) throws XNIException
startCDATA
in interface XMLDocumentHandler
augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void endCDATA(Augmentations augs) throws XNIException
endCDATA
in interface XMLDocumentHandler
augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void endDocument(Augmentations augs) throws XNIException
endDocument
in interface XMLDocumentHandler
augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.public void setDocumentSource(XMLDocumentSource source)
setDocumentSource
in interface XMLDocumentHandler
public XMLDocumentSource getDocumentSource()
getDocumentSource
in interface XMLDocumentHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |