|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ercp.xml.dom.NodeImpl
org.eclipse.ercp.xml.dom.NSNodeImpl
org.eclipse.ercp.xml.dom.TreeNode
org.eclipse.ercp.xml.dom.DocumentImpl
public class DocumentImpl
Field Summary | |
---|---|
protected ElementImpl |
documentElement
|
Fields inherited from class org.eclipse.ercp.xml.dom.TreeNode |
---|
firstChild, lastChild, length, nextSibling, parentNode, previousSibling |
Fields inherited from class org.eclipse.ercp.xml.dom.NSNodeImpl |
---|
localName, namespaceURI, prefix, qualifiedName |
Fields inherited from class org.eclipse.ercp.xml.dom.NodeImpl |
---|
ownerDocument |
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()
Constructor for DocumentImpl |
Method Summary | |
---|---|
Node |
appendChild(Node newChild)
Adds the node newChild to the end of the list of children
of this node. |
Node |
cloneNode(boolean deep)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. |
Attr |
createAttribute(java.lang.String name)
Creates an Attr of the given name. |
Attr |
createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Creates an attribute of the given qualified name and namespace URI. |
CDATASection |
createCDATASection(java.lang.String data)
Creates a CDATASection node whose value is the specified
string. |
Comment |
createComment(java.lang.String data)
Creates a Comment node given the specified string. |
DocumentFragment |
createDocumentFragment()
Creates an empty DocumentFragment object. |
Element |
createElement(java.lang.String tagName)
Creates an element of the type specified. |
Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Creates an element of the given qualified name and namespace URI. |
EntityReference |
createEntityReference(java.lang.String name)
Creates an EntityReference object. |
ProcessingInstruction |
createProcessingInstruction(java.lang.String target,
java.lang.String data)
Creates a ProcessingInstruction node given the specified
name and data strings. |
Text |
createTextNode(java.lang.String data)
Creates a Text node given the specified string. |
DocumentType |
getDoctype()
The Document Type Declaration (see DocumentType )
associated with this document. |
Element |
getDocumentElement()
This is a convenience attribute that allows direct access to the child node that is the root element of the document. |
Element |
getElementById(java.lang.String elementId)
Returns the Element whose ID is given by
elementId . |
DOMImplementation |
getImplementation()
The DOMImplementation object that handles this document. |
short |
getNodeType()
A code representing the type of the underlying object, as defined above. |
Node |
importNode(Node importedNode,
boolean deep)
Imports a node from another document to this document. |
Methods inherited from class org.eclipse.ercp.xml.dom.TreeNode |
---|
getElementByTagName, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, getLength, getNextSibling, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, item, normalize, removeChild, replaceChild |
Methods inherited from class org.eclipse.ercp.xml.dom.NSNodeImpl |
---|
getLocalName, getNamespaceURI, getNodeName, getPrefix, setPrefix |
Methods inherited from class org.eclipse.ercp.xml.dom.NodeImpl |
---|
getAttributes, getChildNodes, getNodeValue, getOwnerDocument, hasAttributes, isSupported, setNodeValue, spreadOwnerDocument |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Document |
---|
getElementsByTagName, getElementsByTagNameNS |
Methods inherited from interface org.w3c.dom.Node |
---|
getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
Field Detail |
---|
protected ElementImpl documentElement
Constructor Detail |
---|
public DocumentImpl()
Method Detail |
---|
public DocumentType getDoctype()
DocumentType
)
associated with this document. For HTML documents as well as XML
documents without a document type declaration this returns
null
. The DOM Level 2 does not support editing the
Document Type Declaration. docType
cannot be altered in
any way, including through the use of methods inherited from the
Node
interface, such as insertNode
or
removeNode
.
getDoctype
in interface Document
public DOMImplementation getImplementation()
DOMImplementation
object that handles this document. A
DOM application may use objects from multiple implementations.
getImplementation
in interface Document
public Element getDocumentElement()
getDocumentElement
in interface Document
public Element createElement(java.lang.String tagName) throws DOMException
Element
interface, so attributes
can be specified directly on the returned object.
Attr
nodes representing them are automatically created
and attached to the element.
createElementNS
method.
createElement
in interface Document
tagNameThe
- 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.
Element
object with the
nodeName
attribute set to tagName
, and
localName
, prefix
, and
namespaceURI
set to null
.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.public DocumentFragment createDocumentFragment()
DocumentFragment
object.
createDocumentFragment
in interface Document
DocumentFragment
.public Text createTextNode(java.lang.String data)
Text
node given the specified string.
createTextNode
in interface Document
dataThe
- data for the node.
Text
object.public Comment createComment(java.lang.String data)
Comment
node given the specified string.
createComment
in interface Document
dataThe
- data for the node.
Comment
object.public CDATASection createCDATASection(java.lang.String data) throws DOMException
CDATASection
node whose value is the specified
string.
createCDATASection
in interface Document
dataThe
- data for the CDATASection
contents.
CDATASection
object.
DOMException
- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.public ProcessingInstruction createProcessingInstruction(java.lang.String target, java.lang.String data) throws DOMException
ProcessingInstruction
node given the specified
name and data strings.
createProcessingInstruction
in interface Document
targetThe
- target part of the processing instruction.dataThe
- data for the node.
ProcessingInstruction
object.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified target contains an
illegal character.
public Attr createAttribute(java.lang.String name) throws DOMException
Attr
of the given name. Note that the
Attr
instance can then be set on an Element
using the setAttributeNode
method.
createAttributeNS
method.
createAttribute
in interface Document
nameThe
- name of the attribute.
Attr
object with the nodeName
attribute set to name
, and localName
,
prefix
, and namespaceURI
set to
null
. The value of the attribute is the empty string.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.public EntityReference createEntityReference(java.lang.String name) throws DOMException
EntityReference
object. In addition, if the
referenced entity is known, the child list of the
EntityReference
node is made the same as that of the
corresponding Entity
node.If any descendant of the
Entity
node has an unbound namespace prefix, the
corresponding descendant of the created EntityReference
node is also unbound; (its namespaceURI
is
null
). The DOM Level 2 does not support any mechanism to
resolve namespace prefixes.
createEntityReference
in interface Document
nameThe
- name of the entity to reference.
EntityReference
object.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.
public Node importNode(Node importedNode, boolean deep) throws DOMException
Document
parentNode
is null
).
The source node is not altered or removed from the original document;
this method creates a new copy of the source node.
nodeName
and nodeType
, plus the
attributes related to namespaces (prefix
,
localName
, and namespaceURI
). As in the
cloneNode
operation on a Node
, the source
node is not altered.
nodeType
, attempting to mirror the behavior expected if
a fragment of XML or HTML source was copied from one document to
another, recognizing that the two documents may have different DTDs
in the XML case. The following list describes the specifics for each
type of node.
ownerElement
attribute
is set to null
and the specified
flag is
set to true
on the generated Attr
. The
descendants of the source Attr
are recursively imported
and the resulting nodes reassembled to form the corresponding subtree.
Note that the deep
parameter has no effect on
Attr
nodes; they always carry their children with them
when imported.deep
option
was set to true
, the descendants of the source element
are recursively imported and the resulting nodes reassembled to form
the corresponding subtree. Otherwise, this simply generates an empty
DocumentFragment
.Document
nodes cannot be imported.DocumentType
nodes cannot be imported.Attr
nodes are attached to the generated Element
. Default
attributes are not copied, though if the document being imported into
defines default attributes for this element name, those are assigned.
If the importNode
deep
parameter was set to
true
, the descendants of the source element are
recursively imported and the resulting nodes reassembled to form the
corresponding subtree.Entity
nodes can be
imported, however in the current release of the DOM the
DocumentType
is readonly. Ability to add these imported
nodes to a DocumentType
will be considered for addition
to a future release of the DOM.On import, the publicId
,
systemId
, and notationName
attributes are
copied. If a deep
import is requested, the descendants
of the the source Entity
are recursively imported and
the resulting nodes reassembled to form the corresponding subtree.EntityReference
itself is
copied, even if a deep
import is requested, since the
source and destination documents might have defined the entity
differently. If the document being imported into provides a
definition for this entity name, its value is assigned.Notation
nodes can be imported, however in the current
release of the DOM the DocumentType
is readonly. Ability
to add these imported nodes to a DocumentType
will be
considered for addition to a future release of the DOM.On import, the
publicId
and systemId
attributes are copied.
Note that the deep
parameter has no effect on
Notation
nodes since they never have any children.target
and data
values from those of the
source node.CharacterData
copy their
data
and length
attributes from those of
the source node.
importNode
in interface Document
Document
.
DOMException
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
supported.Document.importNode(Node, boolean)
public Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
createElementNS
in interface Document
namespaceURIThe
- namespace URI of the element to create.qualifiedNameThe
- qualified name of the element type to
instantiate.
Element
object with the following
attributes:AttributeValueNode.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted
from qualifiedName
, or null
if there is
no prefixNode.localName
local name, extracted from
qualifiedName
Element.tagName
qualifiedName
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character.
qualifiedName
is
malformed, if the qualifiedName
has a prefix and the
namespaceURI
is null
, or if the
qualifiedName
has a prefix that is "xml" and the
namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace" .public Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
createAttributeNS
in interface Document
namespaceURIThe
- namespace URI of the attribute to create.qualifiedNameThe
- qualified name of the attribute to instantiate.
Attr
object with the following attributes:
AttributeValueNode.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from
qualifiedName
, or null
if there is no
prefixNode.localName
local name, extracted from
qualifiedName
Attr.name
qualifiedName
Node.nodeValue
the empty
string
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character.
qualifiedName
is
malformed, if the qualifiedName
has a prefix and the
namespaceURI
is null
, if the
qualifiedName
has a prefix that is "xml" and the
namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace", or if the
qualifiedName
is "xmlns" and the
namespaceURI
is different from "
http://www.w3.org/2000/xmlns/".public Element getElementById(java.lang.String elementId)
Element
whose ID
is given by
elementId
. If no such element exists, returns
null
. Behavior is not defined if more than one element
has this ID
. 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
elementIdThe
- unique id
value for an element.
public short getNodeType()
Node
getNodeType
in interface Node
public Node appendChild(Node newChild) throws DOMException
newChild
to the end of the list of children
of this node. If the newChild
is already in the tree, it
is first removed.
appendChild
in interface Node
appendChild
in class TreeNode
newChildThe
- node to add.If it is a DocumentFragment
object, the entire contents of the document fragment are moved
into the child list of this node
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 append is one of this node's ancestors.
newChild
was created
from a different document than the one that created this node.
public Node cloneNode(boolean deep)
parentNode
is null
.).
Element
copies all attributes and their
values, including those generated by the XML processor to represent
defaulted attributes, but this method does not copy any text it
contains unless it is a deep clone, since the text is contained in a
child Text
node. Cloning an Attribute
directly, as opposed to be cloned as part of an Element
cloning operation, returns a specified attribute (
specified
is true
). Cloning any other type
of node simply returns a copy of this node.
EntityReference
clone are readonly
. In addition, clones of unspecified Attr
nodes are
specified. And, cloning Document
,
DocumentType
, Entity
, and
Notation
nodes is implementation dependent.
cloneNode
in interface Node
deepIf
- true
, recursively clone the subtree under
the specified node; if false
, clone only the node
itself (and its attributes, if it is an Element
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |