Package org.apache.xerces.dom

Class PSVIDocumentImpl

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.CoreDocumentImpl

org.apache.xerces.dom.DocumentImpl

org.apache.xerces.dom.PSVIDocumentImpl

All Implemented Interfaces:

Serializable, Cloneable, Document, DocumentEvent, EventTarget, Node, NodeList, DocumentRange, DocumentTraversal

public class PSVIDocumentImpl
extends DocumentImpl

Our own document implementation, which knows how to create an element with PSVI information.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.

Version:

$Id: PSVIDocumentImpl.java 699892 2008-09-28 21:08:27Z mrglavas $

Author:

Sandy Gao, IBM

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.xerces.dom.DocumentImpl

eventListeners, iteratorReferenceQueue, iterators, mutationEvents, rangeReferenceQueue, ranges

Fields inherited from class org.apache.xerces.dom.CoreDocumentImpl

actualEncoding, allowGrammarAccess, changes, docElement, docType, encoding, errorChecking, fDocumentURI, identifiers, standalone, userData, version, xmlVersionChanged

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor	Description
PSVIDocumentImpl()	Create a document.
PSVIDocumentImpl(DocumentType doctype)	For DOM2 support.

Method Summary

Modifier and Type	Method	Description
Node	cloneNode(boolean deep)	Deep-clone a document, including fixing ownerDoc for the cloned children.
Attr	createAttributeNS(String namespaceURI, String qualifiedName)	Create an attribute with PSVI information
Attr	createAttributeNS(String namespaceURI, String qualifiedName, String localName)	Create an attribute with PSVI information
Element	createElementNS(String namespaceURI, String qualifiedName)	Create an element with PSVI information
Element	createElementNS(String namespaceURI, String qualifiedName, String localpart)	Create an element with PSVI information
DOMConfiguration	getDomConfig()	The configuration used when Document.normalizeDocument is invoked.
DOMImplementation	getImplementation()	Retrieve information describing the abilities of this particular DOM implementation.

Methods inherited from class org.apache.xerces.dom.DocumentImpl

addEventListener, copyEventListeners, createEvent, createNodeIterator, createNodeIterator, createRange, createTreeWalker, createTreeWalker, dispatchAggregateEvents, dispatchAggregateEvents, dispatchEvent, dispatchEventToSubtree, dispatchingEventToSubtree, getEventListeners, removeEventListener, saveEnclosingAttr, setEventListeners

Methods inherited from class org.apache.xerces.dom.CoreDocumentImpl

abort, adoptNode, callUserDataHandlers, canRenameElements, changed, changes, checkDOMNSErr, checkNamespaceWF, checkQName, clearIdentifiers, clone, cloneNode, createAttribute, createCDATASection, createComment, createDocumentFragment, createDocumentType, createElement, createElementDefinition, createEntity, createEntityReference, createNotation, createProcessingInstruction, createTextNode, getAsync, getBaseURI, getDoctype, getDocumentElement, getDocumentURI, getElementById, getElementsByTagName, getElementsByTagNameNS, getEncoding, getErrorChecking, getFeature, getIdentifier, getIdentifiers, getInputEncoding, getNodeName, getNodeNumber, getNodeNumber, getNodeType, getOwnerDocument, getStandalone, getStrictErrorChecking, getTextContent, getUserData, getUserData, getUserDataRecord, getVersion, getXmlEncoding, getXmlStandalone, getXmlVersion, importNode, insertBefore, isKidOK, isValidQName, isXMLName, load, loadXML, normalizeDocument, putIdentifier, removeChild, removeIdentifier, renameNode, replaceChild, saveXML, setAsync, setDocumentURI, setEncoding, setErrorChecking, setInputEncoding, setStandalone, setStrictErrorChecking, setTextContent, setUserData, setUserData, setVersion, setXmlEncoding, setXmlStandalone, setXmlVersion, undeferChildren

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setOwnerDocument, setReadOnly, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getContainer, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, setNodeValue, setPrefix, setUserData

Constructor Details

PSVIDocumentImpl

public PSVIDocumentImpl()

Create a document.

PSVIDocumentImpl

public PSVIDocumentImpl(DocumentType doctype)

For DOM2 support. The createDocument factory method is in DOMImplementation.

Method Details

cloneNode

public Node cloneNode(boolean deep)

Deep-clone a document, including fixing ownerDoc for the cloned children. Note that this requires bypassing the WRONG_DOCUMENT_ERR protection. I've chosen to implement it by calling importNode which is DOM Level 2.

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class DocumentImpl

Parameters:

deep - boolean, iff true replicate children

Returns:

org.w3c.dom.Node

See Also:

• Example: Cloning a Text node will copy both the node and the text it contains.

  Example: Cloning something that has children -- Element or Attr, for example -- will _not_ clone those children unless a "deep clone" has been requested. A shallow clone of an Attr node will yield an empty Attr of the same name.

  NOTE: Clones will always be read/write, even if the node being cloned is read-only, to permit applications using only the DOM API to obtain editable copies of locked portions of the tree.

getImplementation

public DOMImplementation getImplementation()

Retrieve information describing the abilities of this particular DOM implementation. Intended to support applications that may be using DOMs retrieved from several different sources, potentially with different underlying representations.

Specified by:

getImplementation in interface Document

Overrides:

getImplementation in class DocumentImpl

createElementNS

public Element createElementNS(String namespaceURI,
 String qualifiedName)
                        throws DOMException

Create an element with PSVI information

Specified by:

createElementNS in interface Document

Overrides:

createElementNS in class CoreDocumentImpl

Parameters:

namespaceURI - The namespace URI of the element to create.

qualifiedName - The qualified name of the element type to instantiate.

Returns:

Element A new Element object with the following attributes:

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

DOMException - NAMESPACE_ERR: Raised if the qualifiedName has a prefix that is "xml" and the namespaceURI is neither null nor an empty string nor "http://www.w3.org/XML/1998/namespace", or if the qualifiedName has a prefix different from "xml" and the namespaceURI is null or an empty string.

createElementNS

public Element createElementNS(String namespaceURI,
 String qualifiedName,
 String localpart)
                        throws DOMException

Create an element with PSVI information

Overrides:

createElementNS in class CoreDocumentImpl

Parameters:

namespaceURI - The namespace URI of the element to create.

qualifiedName - The qualified name of the element type to instantiate.

localpart - The local name of the attribute to instantiate.

Returns:

Element A new Element object with the following attributes:

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
 String qualifiedName)
                       throws DOMException

Create an attribute with PSVI information

Specified by:

createAttributeNS in interface Document

Overrides:

createAttributeNS in class CoreDocumentImpl

Parameters:

namespaceURI - The namespace URI of the attribute to create. When it is null or an empty string, this method behaves like createAttribute.

qualifiedName - The qualified name of the attribute to instantiate.

Returns:

Attr A new Attr object.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
 String qualifiedName,
 String localName)
                       throws DOMException

Create an attribute with PSVI information

Overrides:

createAttributeNS in class CoreDocumentImpl

Parameters:

namespaceURI - The namespace URI of the attribute to create. When it is null or an empty string, this method behaves like createAttribute.

qualifiedName - The qualified name of the attribute to instantiate.

localName - The local name of the attribute to instantiate.

Returns:

Attr A new Attr object.

Throws:

DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

getDomConfig

public DOMConfiguration getDomConfig()

The configuration used when Document.normalizeDocument is invoked.

Specified by:

getDomConfig in interface Document

Overrides:

getDomConfig in class CoreDocumentImpl

Since:

DOM Level 3