|
Xerces 2.0.0.alpha | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.dom.NodeImpl | +--org.apache.xerces.dom.ParentNode | +--org.apache.xerces.dom.DocumentImpl
The Document interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.
The DocumentImpl class also implements the DOM Level 2 DocumentTraversal interface. This interface is comprised of factory methods needed to create NodeIterators and TreeWalkers. The process of creating NodeIterator objects also adds these references to this document. After finishing with an iterator it is important to remove the object using the remove methods in this implementation. This allows the release of the references from the iterator objects to the DOM Nodes.
Note: When any node in the document is serialized, the entire document is serialized along with it.
Field Summary | |
protected boolean |
allowGrammarAccess
Allow grammar access. |
protected ElementImpl |
docElement
Document element. |
protected DocumentTypeImpl |
docType
Document type. |
protected boolean |
errorChecking
Bypass error checking. |
protected java.util.Hashtable |
identifiers
Identifiers. |
protected java.util.Vector |
iterators
Iterators |
protected static int[] |
kidOK
Table for quick check of child insertion. |
protected java.util.Vector |
ranges
Ranges |
protected java.util.Hashtable |
userData
Table for quick check of child insertion. |
Fields inherited from class org.apache.xerces.dom.ParentNode |
changes, firstChild, nodeListIndex, nodeListLength, nodeListNode, ownerDocument |
Fields inherited from class org.apache.xerces.dom.NodeImpl |
ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, IGNORABLEWS, MUTATION_AGGREGATE, MUTATION_ALL, MUTATION_LOCAL, MUTATION_NONE, MUTATIONEVENTS, OWNED, ownerNode, READONLY, SETVALUE, SPECIFIED, SYNCCHILDREN, SYNCDATA |
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Constructor Summary | |
DocumentImpl()
NON-DOM: Actually creating a Document is outside the DOM's spec, since it has to operate in terms of a particular implementation. |
|
DocumentImpl(boolean grammarAccess)
Experimental constructor. |
|
DocumentImpl(DocumentType doctype)
|
|
DocumentImpl(DocumentType doctype,
boolean grammarAccess)
Experimental constructor. |
Method Summary | |
void |
adoptNode(Node source)
NON-DOM: Change the node's ownerDocument, and its subtree, to this Document |
java.lang.Object |
clone()
Clone. |
Node |
cloneNode(boolean deep)
Deep-clone a document, including fixing ownerDoc for the cloned children. |
Attr |
createAttribute(java.lang.String name)
Factory method; creates an Attribute having this Document as its OwnerDoc. |
Attr |
createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Introduced in DOM Level 2. |
CDATASection |
createCDATASection(java.lang.String data)
Factory method; creates a CDATASection having this Document as its OwnerDoc. |
Comment |
createComment(java.lang.String data)
Factory method; creates a Comment having this Document as its OwnerDoc. |
DocumentFragment |
createDocumentFragment()
Factory method; creates a DocumentFragment having this Document as its OwnerDoc. |
DocumentType |
createDocumentType(java.lang.String qualifiedName,
java.lang.String publicID,
java.lang.String systemID)
NON-DOM Factory method; creates a DocumentType having this Document as its OwnerDoc. |
Element |
createElement(java.lang.String tagName)
Factory method; creates an Element having this Document as its OwnerDoc. |
ElementDefinitionImpl |
createElementDefinition(java.lang.String name)
NON-DOM Factory method: creates an element definition. |
Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Introduced in DOM Level 2. |
Entity |
createEntity(java.lang.String name)
NON-DOM Factory method; creates an Entity having this Document as its OwnerDoc. |
EntityReference |
createEntityReference(java.lang.String name)
Factory method; creates an EntityReference having this Document as its OwnerDoc. |
Event |
createEvent(java.lang.String type)
Introduced in DOM Level 2. |
NodeIterator |
createNodeIterator(Node root,
int whatToShow,
NodeFilter filter,
boolean entityReferenceExpansion)
Create and return a NodeIterator. |
NodeIterator |
createNodeIterator(Node root,
short whatToShow,
NodeFilter filter)
NON-DOM extension: Create and return a NodeIterator. |
Notation |
createNotation(java.lang.String name)
NON-DOM Factory method; creates a Notation having this Document as its OwnerDoc. |
ProcessingInstruction |
createProcessingInstruction(java.lang.String target,
java.lang.String data)
Factory method; creates a ProcessingInstruction having this Document as its OwnerDoc. |
Range |
createRange()
|
Text |
createTextNode(java.lang.String data)
Factory method; creates a Text node having this Document as its OwnerDoc. |
TreeWalker |
createTreeWalker(Node root,
int whatToShow,
NodeFilter filter,
boolean entityReferenceExpansion)
Create and return a TreeWalker. |
TreeWalker |
createTreeWalker(Node root,
short whatToShow,
NodeFilter filter)
NON-DOM extension: Create and return a TreeWalker. |
DocumentType |
getDoctype()
For XML, this provides access to the Document Type Definition. |
Element |
getDocumentElement()
Convenience method, allowing direct access to the child node which is considered the root of the actual document content. |
Element |
getElementById(java.lang.String elementId)
Introduced in DOM Level 2 Returns the Element whose ID is given by elementId. |
NodeList |
getElementsByTagName(java.lang.String tagname)
Return a live collection of all descendent Elements (not just immediate children) having the specified tag name. |
NodeList |
getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
boolean |
getErrorChecking()
Returns true if the DOM implementation performs error checking. |
Element |
getIdentifier(java.lang.String idName)
Returns a previously registered element with the specified identifier name, or null if no element is registered. |
java.util.Enumeration |
getIdentifiers()
Returns an enumeration registered of identifier names. |
DOMImplementation |
getImplementation()
Retrieve information describing the abilities of this particular DOM implementation. |
java.util.Enumeration |
getNodeIterators()
Return an Enumeration of all NodeIterators. |
java.lang.String |
getNodeName()
Returns the node name. |
short |
getNodeType()
Returns the node type. |
Document |
getOwnerDocument()
The Document object associated with this node. |
java.util.Enumeration |
getRanges()
Return an Enumeration of all Ranges. |
protected java.lang.Object |
getUserData(NodeImpl n)
Retreive user data related to a given node |
Node |
importNode(Node source,
boolean deep)
Copies data from the source node. |
Node |
insertBefore(Node newChild,
Node refChild)
Since a Document may contain at most one top-level Element child, and at most one DocumentType declaraction, we need to subclass our add-children methods to implement this constraint. |
protected boolean |
isKidOK(Node parent,
Node child)
Uses the kidOK lookup table to check whether the proposed tree structure is legal. |
static boolean |
isXMLName(java.lang.String s)
Check the string against XML's definition of acceptable names for elements and attributes and so on. |
void |
putIdentifier(java.lang.String idName,
Element element)
Registers an identifier name with a specified element node. |
Node |
removeChild(Node oldChild)
Since insertBefore caches the docElement (and, currently, docType), removeChild has to know how to undo the cache |
void |
removeIdentifier(java.lang.String idName)
Removes a previously registered element with the specified identifier name. |
void |
setErrorChecking(boolean check)
Sets whether the DOM implementation performs error checking upon operations. |
protected void |
setUserData(NodeImpl n,
java.lang.Object data)
Store user data related to a given node |
Methods inherited from class org.apache.xerces.dom.ParentNode |
changed, changes, getChildNodes, getFirstChild, getLastChild, getLength, hasChildNodes, item, normalize, replaceChild, setReadOnly, synchronizeChildren |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
addEventListener, appendChild, dispatchEvent, finalize, getAttributes, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getUserData, removeEventListener, setNodeValue, setPrefix, setUserData, supports, synchronizeData, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, normalize, replaceChild, setNodeValue, setPrefix, supports |
Field Detail |
protected DocumentTypeImpl docType
protected ElementImpl docElement
protected java.util.Hashtable identifiers
protected java.util.Vector iterators
protected java.util.Vector ranges
protected static int[] kidOK
protected java.util.Hashtable userData
protected boolean allowGrammarAccess
protected boolean errorChecking
Constructor Detail |
public DocumentImpl()
public DocumentImpl(boolean grammarAccess)
public DocumentImpl(DocumentType doctype)
public DocumentImpl(DocumentType doctype, boolean grammarAccess)
Method Detail |
public final Document getOwnerDocument()
Node
Document
object associated with this node. This is
also the Document
object used to create new nodes. When
this node is a Document
or a DocumentType
which is not used with any Document
yet, this is
null
.getOwnerDocument
in interface Node
getOwnerDocument
in class ParentNode
public short getNodeType()
getNodeType
in interface Node
getNodeType
in class NodeImpl
public java.lang.String getNodeName()
getNodeName
in interface Node
getNodeName
in class NodeImpl
public Node cloneNode(boolean deep)
cloneNode
in interface Node
cloneNode
in class ParentNode
deep
- boolean, iff true replicate childrenpublic Node insertBefore(Node newChild, Node refChild) throws DOMException
While I'm doing so, I've taken advantage of the opportunity to cache documentElement and docType so we don't have to search for them.
insertBefore
in interface Node
insertBefore
in class ParentNode
org.w3c.dom.Node
newChild
- The node to insert.refChild
- The reference node, i.e., the node before which the
new node must be inserted.DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does
not allow children of the type of the newChild
node, or
if the node to insert is one of this node's ancestors.
newChild
was created
from a different document than the one that created this node.
refChild
is not a child
of this node.public Node removeChild(Node oldChild) throws DOMException
removeChild
in interface Node
removeChild
in class ParentNode
org.w3c.dom.Node
oldChild
- The node being removed.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldChild
is not a child
of this node.public Attr createAttribute(java.lang.String name) throws DOMException
createAttribute
in interface Document
name
- The name of the attribute. Note that the attribute's value
is _not_ established at the factory; remember to set it!DOMException(INVALID_NAME_ERR)
- if the attribute name is not
acceptable.public CDATASection createCDATASection(java.lang.String data) throws DOMException
createCDATASection
in interface Document
data
- The initial contents of the CDATADOMException(NOT_SUPPORTED_ERR)
- for HTML documents. (HTML
not yet implemented.)public Comment createComment(java.lang.String data)
createComment
in interface Document
data
- The initial contents of the Comment.public DocumentFragment createDocumentFragment()
createDocumentFragment
in interface Document
org.w3c.dom.Document
DocumentFragment
.public Element createElement(java.lang.String tagName) throws DOMException
createElement
in interface Document
tagName
- The name of the element type to instantiate. For
XML, this is case-sensitive. For HTML, the tagName parameter may
be provided in any case, but it must be mapped to the canonical
uppercase form by the DOM implementation.DOMException(INVALID_NAME_ERR)
- if the tag name is not
acceptable.public EntityReference createEntityReference(java.lang.String name) throws DOMException
createEntityReference
in interface Document
name
- The name of the Entity we wish to refer toDOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
nonstandard entities are not permitted. (HTML not yet
implemented.)public ProcessingInstruction createProcessingInstruction(java.lang.String target, java.lang.String data) throws DOMException
createProcessingInstruction
in interface Document
target
- The target "processor channel"data
- Parameter string to be passed to the target.DOMException(INVALID_NAME_ERR)
- if the target name is not
acceptable.DOMException(NOT_SUPPORTED_ERR)
- for HTML documents. (HTML
not yet implemented.)public Text createTextNode(java.lang.String data)
createTextNode
in interface Document
data
- The initial contents of the Text.public DocumentType getDoctype()
getDoctype
in interface Document
public Element getDocumentElement()
getDocumentElement
in interface Document
public NodeList getElementsByTagName(java.lang.String tagname)
getElementsByTagName
in interface Document
tagname
- The type of Element we want to gather. "*" will be
taken as a wildcard, meaning "all elements in the document."DeepNodeListImpl
public DOMImplementation getImplementation()
getImplementation
in interface Document
public void setErrorChecking(boolean check)
Turning off error checking does not turn off the following checks:
public boolean getErrorChecking()
public DocumentType createDocumentType(java.lang.String qualifiedName, java.lang.String publicID, java.lang.String systemID) throws DOMException
name
- The name of the Entity we wish to provide a value for.DOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
DTDs are not permitted. (HTML not yet implemented.)public Entity createEntity(java.lang.String name) throws DOMException
name
- The name of the Entity we wish to provide a value for.DOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
nonstandard entities are not permitted. (HTML not yet
implemented.)public Notation createNotation(java.lang.String name) throws DOMException
name
- The name of the Notation we wish to describeDOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
notations are not permitted. (HTML not yet
implemented.)public ElementDefinitionImpl createElementDefinition(java.lang.String name) throws DOMException
public Node importNode(Node source, boolean deep) throws DOMException
importNode
in interface Document
org.w3c.dom.Document
importedNode
- The node to import.deep
- If true
, recursively import the subtree
under the specified node; if false
, import only the
node itself, as explained above. This does not apply to
Attr
, EntityReference
, and
Notation
nodes.Document
.DOMException
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
supported.public void adoptNode(Node source)
source
- The node to move in to this document.NOT_SUPPORTED_ERR
- DOMException, raised if the implementation
cannot handle the request, such as when the source node comes from a
different DOMImplementationDocumentImpl.importNode
public Element getElementById(java.lang.String elementId)
Note: The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.
getElementById
in interface Document
getIdentifier(java.lang.String)
public void putIdentifier(java.lang.String idName, Element element)
getIdentifier(java.lang.String)
,
removeIdentifier(java.lang.String)
public Element getIdentifier(java.lang.String idName)
putIdentifier(java.lang.String, org.w3c.dom.Element)
,
removeIdentifier(java.lang.String)
public void removeIdentifier(java.lang.String idName)
putIdentifier(java.lang.String, org.w3c.dom.Element)
,
getIdentifier(java.lang.String)
public java.util.Enumeration getIdentifiers()
public Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
Creates an element of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].
createElementNS
in interface Document
namespaceURI
- The namespace URI of the element to
create.qualifiedName
- The qualified name of the element type to
instantiate.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.public Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
Creates an attribute of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].
createAttributeNS
in interface Document
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.DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
name contains an invalid character.public NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree.
getElementsByTagNameNS
in interface Document
namespaceURI
- The namespace URI of the elements to match
on. The special value "*" matches all
namespaces. When it is null or an empty
string, this method behaves like
getElementsByTagName.localName
- The local name of the elements to match on.
The special value "*" matches all local names.public NodeIterator createNodeIterator(Node root, short whatToShow, NodeFilter filter)
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.#removeNodeIterator
,
#removeNodeIterators
,
getNodeIterators()
public NodeIterator createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
createNodeIterator
in interface DocumentTraversal
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.entityReferenceExpansion
- true to expand the contents of EntityReference nodes#removeNodeIterator
,
#removeNodeIterators
,
getNodeIterators()
public TreeWalker createTreeWalker(Node root, short whatToShow, NodeFilter filter)
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.public TreeWalker createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
createTreeWalker
in interface DocumentTraversal
root
- The root of the iterator.whatToShow
- The whatToShow mask.filter
- The NodeFilter installed. Null means no filter.entityReferenceExpansion
- true to expand the contents of EntityReference nodespublic java.util.Enumeration getNodeIterators()
public Range createRange()
public java.util.Enumeration getRanges()
public Event createEvent(java.lang.String type) throws DOMException
Create and return Event objects.
createEvent
in interface DocumentEvent
type
- The event set name, defined as the interface name
minus package qualifiers. For example, to create a DOMNodeInserted
event you'd call createEvent("MutationEvent")
,
then use its initMutationEvent() method to configure it properly
as DOMNodeInserted. This parameter is case-sensitive.init...Event()
method before dispatching it.DOMException
- UNSUPPORTED_EVENT_TYPE if the requested
event set is not supported in this DOM.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
public static boolean isXMLName(java.lang.String s)
[Definition:] A Name is a token beginning with a letter or one of a few punctuation characters, and continuing with letters, digits, hyphens,underscores, colons, or full stops, together known as name characters.
Unfortunately, that spec goes on to say that after the first character, names may use "combining characters" and "extender characters", which are explicitly listed rather than defined in terms of Java's Unicode character types... and which in fact can't be expressed solely in terms of those types.
I've empirically derived some tests which are partly based on the Java Unicode space (which simplifies them considerably), but they still wind up having to be further qualified. This may not remain valid if future extensions of Java and/or Unicode introduce other characters having these type numbers.
Suggestions for alternative implementations would be welcome.
protected void setUserData(NodeImpl n, java.lang.Object data)
protected java.lang.Object getUserData(NodeImpl n)
protected boolean isKidOK(Node parent, Node child)
|
Xerces 2.0.0.alpha | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |