|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xml.dtm.ref.DTMNodeProxy
DTMNodeProxy
presents a DOM Node API front-end to the DTM model.
It does _not_ attempt to address the "node identity" question; no effort is made to prevent the creation of multiple proxies referring to a single DTM node. Users can create a mechanism for managing this, or relinquish the use of "==" and use the .sameNodeAs() mechanism, which is under consideration for future versions of the DOM.
DTMNodeProxy may be subclassed further to present specific DOM node types.
org.w3c.dom
Field Summary | |
DTM |
dtm
The DTM for this node. |
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 | |
DTMNodeProxy(DTM dtm,
int node)
Create a DTMNodeProxy Node representing a specific Node in a DTM |
Method Summary | |
Node |
adoptNode(Node source)
NEEDSDOC Method adoptNode NEEDSDOC @param source |
Node |
appendChild(Node newChild)
Adds the node newChild to the end of the list of children
of this node. |
void |
appendData(java.lang.String arg)
Append the string to the end of the character data of the 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. |
void |
deleteData(int offset,
int count)
Remove a range of 16-bit units from the node. |
boolean |
equals(Node node)
Test for equality based on node number. |
boolean |
equals(java.lang.Object node)
Test for equality based on node number. |
java.lang.String |
getAttribute(java.lang.String name)
Retrieves an attribute value by name. |
Attr |
getAttributeNode(java.lang.String name)
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
Retrieves an Attr node by local name and namespace URI.
|
java.lang.String |
getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Retrieves an attribute value by local name and namespace URI. |
NamedNodeMap |
getAttributes()
A NamedNodeMap containing the attributes of this node (if
it is an Element ) or null otherwise. |
NodeList |
getChildNodes()
A NodeList that contains all children of this node. |
java.lang.String |
getData()
The content of this processing instruction. |
DocumentType |
getDoctype()
The Document Type Declaration (see DocumentType )
associated with this document. |
Element |
getDocumentElement()
This is a bit of a problem in DTM, since a DTM may be a Document Fragment and hence not have a clear-cut Document Element. |
DTM |
getDTM()
NON-DOM: Return the DTM model |
int |
getDTMNodeNumber()
NON-DOM: Return the DTM node number |
Element |
getElementById(java.lang.String elementId)
Returns the Element whose ID is given by
elementId . |
NodeList |
getElementsByTagName(java.lang.String tagname)
Returns a NodeList of all the Elements with a
given tag name in the order in which they are encountered in a
preorder traversal of the Document tree. |
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 are
encountered in a preorder traversal of the Document tree. |
java.lang.String |
getEncoding()
EXPERIMENTAL! |
Node |
getFirstChild()
The first child of this node. |
DOMImplementation |
getImplementation()
The DOMImplementation object that handles this document. |
Node |
getLastChild()
The last child of this node. |
int |
getLength()
The number of 16-bit units that are available through data
and the substringData method below. |
java.lang.String |
getLocalName()
Returns the local part of the qualified name of this node. |
java.lang.String |
getName()
Returns the name of this attribute. |
java.lang.String |
getNamespaceURI()
The namespace URI of this node, or null if it is
unspecified.
|
Node |
getNextSibling()
The node immediately following this node. |
java.lang.String |
getNodeName()
The name of this node, depending on its type; see the table above. |
short |
getNodeType()
A code representing the type of the underlying object, as defined above. |
java.lang.String |
getNodeValue()
The value of this node, depending on its type; see the table above. |
Document |
getOwnerDocument()
The Document object associated with this node. |
Element |
getOwnerElement()
Get the owner element of an attribute. |
Node |
getOwnerNode()
|
Node |
getParentNode()
The parent of this node. |
java.lang.String |
getPrefix()
The namespace prefix of this node, or null if it is
unspecified.
|
Node |
getPreviousSibling()
The node immediately preceding this node. |
boolean |
getSpecified()
If this attribute was explicitly given a value in the original document, this is true ; otherwise, it is
false . |
boolean |
getStandalone()
EXPERIMENTAL! |
boolean |
getStrictErrorChecking()
EXPERIMENTAL! |
java.lang.String |
getStringValue()
|
java.lang.String |
getTagName()
The name of the element. |
java.lang.String |
getTarget()
A PI's "target" states what processor channel the PI's data should be directed to. |
java.lang.String |
getValue()
On retrieval, the value of the attribute is returned as a string. |
java.lang.String |
getVersion()
EXPERIMENTAL! |
boolean |
hasAttribute(java.lang.String name)
Method hasAttribute |
boolean |
hasAttributeNS(java.lang.String name,
java.lang.String x)
Method hasAttributeNS |
boolean |
hasAttributes()
Introduced in DOM Level 2. |
boolean |
hasChildNodes()
Returns whether this node has any children. |
Node |
importNode(Node importedNode,
boolean deep)
Imports a node from another document to this document. |
Node |
insertBefore(Node newChild,
Node refChild)
Inserts the node newChild before the existing child node
refChild . |
void |
insertData(int offset,
java.lang.String arg)
Insert a string at the specified 16-bit unit offset. |
boolean |
isSupported(java.lang.String feature,
java.lang.String version)
Ask whether we support a given DOM feature. |
void |
normalize()
Puts all Text nodes in the full depth of the sub-tree
underneath this Node , including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates Text nodes, i.e., there are neither adjacent
Text nodes nor empty Text nodes. |
void |
removeAttribute(java.lang.String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. |
void |
removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Removes an attribute by local name and namespace URI. |
Node |
removeChild(Node oldChild)
Removes the child node indicated by oldChild from the list
of children, and returns it. |
Node |
replaceChild(Node newChild,
Node oldChild)
Replaces the child node oldChild with newChild
in the list of children, and returns the oldChild node.
|
void |
replaceData(int offset,
int count,
java.lang.String arg)
Replace the characters starting at the specified 16-bit unit offset with the specified string. |
boolean |
sameNodeAs(Node other)
FUTURE DOM: Test node identity, in lieu of Node==Node |
void |
setAttribute(java.lang.String name,
java.lang.String value)
Adds a new attribute. |
Attr |
setAttributeNode(Attr newAttr)
Adds a new attribute node. |
Attr |
setAttributeNodeNS(Attr newAttr)
Adds a new attribute. |
void |
setAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
Adds a new attribute. |
void |
setData(java.lang.String data)
The content of this processing instruction. |
void |
setEncoding(java.lang.String encoding)
EXPERIMENTAL! |
void |
setNodeValue(java.lang.String nodeValue)
The value of this node, depending on its type; see the table above. |
void |
setPrefix(java.lang.String prefix)
The namespace prefix of this node, or null if it is
unspecified.
|
void |
setStandalone(boolean standalone)
EXPERIMENTAL! |
void |
setStrictErrorChecking(boolean strictErrorChecking)
EXPERIMENTAL! |
void |
setValue(java.lang.String value)
On retrieval, the value of the attribute is returned as a string. |
void |
setVersion(java.lang.String version)
EXPERIMENTAL! |
Text |
splitText(int offset)
Breaks this node into two nodes at the specified offset ,
keeping both in the tree as siblings. |
java.lang.String |
substringData(int offset,
int count)
Extracts a range of data from the node. |
boolean |
supports(java.lang.String feature,
java.lang.String version)
Ask whether we support a given DOM feature. |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public DTM dtm
Constructor Detail |
public DTMNodeProxy(DTM dtm, int node)
dtm
- The DTM Reference, must be non-null.node
- The DTM node handle.Method Detail |
public final DTM getDTM()
public final int getDTMNodeNumber()
public final boolean equals(Node node)
node
- A DTM node proxy reference.
public final boolean equals(java.lang.Object node)
node
- A DTM node proxy reference.
public final boolean sameNodeAs(Node other)
other
-
public final java.lang.String getNodeName()
Node
getNodeName
in interface Node
Node
public final java.lang.String getTarget()
In XML, a PI's "target" is the first (whitespace-delimited) token following the "" token that begins the PI.
In HTML, target is always null.
Note that getNodeName is aliased to getTarget.
getTarget
in interface ProcessingInstruction
public final java.lang.String getLocalName()
Node
ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as createElement
from the
Document
interface, this is always null
.
getLocalName
in interface Node
as of DOM Level 2
public final java.lang.String getPrefix()
Node
null
if it is
unspecified.
nodeName
attribute, which holds the qualified name, as
well as the tagName
and name
attributes of
the Element
and Attr
interfaces, when
applicable.
namespaceURI
and localName
do not change.
ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as createElement
from the
Document
interface, this is always null
.
getPrefix
in interface Node
as of DOM Level 2
public final void setPrefix(java.lang.String prefix) throws DOMException
Node
null
if it is
unspecified.
nodeName
attribute, which holds the qualified name, as
well as the tagName
and name
attributes of
the Element
and Attr
interfaces, when
applicable.
namespaceURI
and localName
do not change.
ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as createElement
from the
Document
interface, this is always null
.
setPrefix
in interface Node
prefix
-
DOMException
as of DOM Level 2 -- DTMNodeProxy is read-only
public final java.lang.String getNamespaceURI()
Node
null
if it is
unspecified.
ELEMENT_NODE
and
ATTRIBUTE_NODE
and nodes created with a DOM Level 1
method, such as createElement
from the
Document
interface, this is always null
.Per
the Namespaces in XML Specification an attribute does not inherit
its namespace from the element it is attached to. If an attribute is
not explicitly given a namespace, it simply has no namespace.
getNamespaceURI
in interface Node
as of DOM Level 2
public final boolean supports(java.lang.String feature, java.lang.String version)
feature
- version
-
public final boolean isSupported(java.lang.String feature, java.lang.String version)
isSupported
in interface Node
feature
- version
-
as of DOM Level 2
public final java.lang.String getNodeValue() throws DOMException
Node
null
, setting it has no effect.
getNodeValue
in interface Node
DOMException
Node
public final java.lang.String getStringValue() throws DOMException
DOMException
public final void setNodeValue(java.lang.String nodeValue) throws DOMException
Node
null
, setting it has no effect.
setNodeValue
in interface Node
nodeValue
-
DOMException
-- DTMNodeProxy is read-only
public final short getNodeType()
Node
getNodeType
in interface Node
Node
public final Node getParentNode()
Node
Attr
,
Document
, DocumentFragment
,
Entity
, and Notation
may have a parent.
However, if a node has just been created and not yet added to the
tree, or if it has been removed from the tree, this is
null
.
getParentNode
in interface Node
Node
public final Node getOwnerNode()
Node
public final NodeList getChildNodes()
Node
NodeList
that contains all children of this node. If
there are no children, this is a NodeList
containing no
nodes.
getChildNodes
in interface Node
Node
public final Node getFirstChild()
Node
null
.
getFirstChild
in interface Node
Node
public final Node getLastChild()
Node
null
.
getLastChild
in interface Node
Node
public final Node getPreviousSibling()
Node
null
.
getPreviousSibling
in interface Node
Node
public final Node getNextSibling()
Node
null
.
getNextSibling
in interface Node
Node
public final NamedNodeMap getAttributes()
Node
NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise.
getAttributes
in interface Node
Node
public boolean hasAttribute(java.lang.String name)
hasAttribute
in interface Element
name
-
true
if an attribute with the given name is
specified on this element or has a default value, false
otherwise.public boolean hasAttributeNS(java.lang.String name, java.lang.String x)
hasAttributeNS
in interface Element
name
- x
-
true
if an attribute with the given local name
and namespace URI is specified or has a default value on this
element, false
otherwise.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
Node
public final Node insertBefore(Node newChild, Node refChild) throws DOMException
Node
newChild
before the existing child node
refChild
. If refChild
is null
,
insert newChild
at the end of the list of children.
newChild
is a DocumentFragment
object,
all of its children are inserted, in the same order, before
refChild
. If the newChild
is already in the
tree, it is first removed.
insertBefore
in interface Node
newChild
- refChild
-
DOMException
-- DTMNodeProxy is read-only
public final Node replaceChild(Node newChild, Node oldChild) throws DOMException
Node
oldChild
with newChild
in the list of children, and returns the oldChild
node.
newChild
is a DocumentFragment
object,
oldChild
is replaced by all of the
DocumentFragment
children, which are inserted in the
same order. If the newChild
is already in the tree, it
is first removed.
replaceChild
in interface Node
newChild
- oldChild
-
DOMException
-- DTMNodeProxy is read-only
public final Node removeChild(Node oldChild) throws DOMException
Node
oldChild
from the list
of children, and returns it.
removeChild
in interface Node
oldChild
-
DOMException
-- DTMNodeProxy is read-only
public final Node appendChild(Node newChild) throws DOMException
Node
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
newChild
-
DOMException
-- DTMNodeProxy is read-only
public final boolean hasChildNodes()
Node
hasChildNodes
in interface Node
true
if this node has any children,
false
otherwise.Node
public final Node cloneNode(boolean deep)
Node
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
deep
-
-- DTMNodeProxy is read-only
public final DocumentType getDoctype()
Document
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
Document
public final DOMImplementation getImplementation()
Document
DOMImplementation
object that handles this document. A
DOM application may use objects from multiple implementations.
getImplementation
in interface Document
Document
public final Element getDocumentElement()
getDocumentElement
in interface Document
Document
public final Element createElement(java.lang.String tagName) throws DOMException
Document
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
tagName
-
Element
object with the
nodeName
attribute set to tagName
, and
localName
, prefix
, and
namespaceURI
set to null
.
DOMException
Document
public final DocumentFragment createDocumentFragment()
Document
DocumentFragment
object.
createDocumentFragment
in interface Document
DocumentFragment
.Document
public final Text createTextNode(java.lang.String data)
Document
Text
node given the specified string.
createTextNode
in interface Document
data
-
Text
object.Document
public final Comment createComment(java.lang.String data)
Document
Comment
node given the specified string.
createComment
in interface Document
data
-
Comment
object.Document
public final CDATASection createCDATASection(java.lang.String data) throws DOMException
Document
CDATASection
node whose value is the specified
string.
createCDATASection
in interface Document
data
-
CDATASection
object.
DOMException
Document
public final ProcessingInstruction createProcessingInstruction(java.lang.String target, java.lang.String data) throws DOMException
Document
ProcessingInstruction
node given the specified
name and data strings.
createProcessingInstruction
in interface Document
target
- data
-
ProcessingInstruction
object.
DOMException
Document
public final Attr createAttribute(java.lang.String name) throws DOMException
Document
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
name
-
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
Document
public final EntityReference createEntityReference(java.lang.String name) throws DOMException
Document
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
name
-
EntityReference
object.
DOMException
Document
public final NodeList getElementsByTagName(java.lang.String tagname)
Document
NodeList
of all the Elements
with a
given tag name in the order in which they are encountered in a
preorder traversal of the Document
tree.
getElementsByTagName
in interface Document
tagname
-
NodeList
object containing all the matched
Elements
.Document
public final 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
importedNode
- deep
-
Document
.
DOMException
as of DOM Level 2 -- DTMNodeProxy is read-only
public final Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
Document
createElementNS
in interface Document
namespaceURI
- qualifiedName
-
Element
object with the following
attributes:
Attribute | Value |
---|---|
Node.nodeName |
qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix |
prefix, extracted
from qualifiedName , or null if there is
no prefix |
Node.localName |
local name, extracted from
qualifiedName |
Element.tagName |
qualifiedName |
DOMException
as of DOM Level 2
public final Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
Document
createAttributeNS
in interface Document
namespaceURI
- qualifiedName
-
Attr
object with the following attributes:
Attribute | Value |
---|---|
Node.nodeName |
qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix |
prefix, extracted from
qualifiedName , or null if there is no
prefix |
Node.localName |
local name, extracted from
qualifiedName |
Attr.name |
qualifiedName |
Node.nodeValue |
the empty string |
DOMException
as of DOM Level 2
public final NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.String localName)
Document
NodeList
of all the Elements
with a
given local name and namespace URI in the order in which they are
encountered in a preorder traversal of the Document
tree.
getElementsByTagNameNS
in interface Document
namespaceURI
- localName
-
NodeList
object containing all the matched
Elements
.as of DOM Level 2
public final Element getElementById(java.lang.String elementId)
Document
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
elementId
-
as of DOM Level 2
public final Text splitText(int offset) throws DOMException
Text
offset
,
keeping both in the tree as siblings. After being split, this node
will contain all the content up to the offset
point. A
new node of the same type, which contains all the content at and
after the offset
point, is returned. If the original
node had a parent node, the new node is inserted as the next sibling
of the original node. When the offset
is equal to the
length of this node, the new node has no data.
splitText
in interface Text
offset
-
DOMException
Text
public final java.lang.String getData() throws DOMException
ProcessingInstruction
?>
.
getData
in interface CharacterData
DOMException
CharacterData
public final void setData(java.lang.String data) throws DOMException
ProcessingInstruction
?>
.
setData
in interface CharacterData
data
-
DOMException
CharacterData
public final int getLength()
CharacterData
data
and the substringData
method below. This may have the
value zero, i.e., CharacterData
nodes may be empty.
getLength
in interface CharacterData
CharacterData
public final java.lang.String substringData(int offset, int count) throws DOMException
CharacterData
substringData
in interface CharacterData
offset
- count
-
offset
and
count
exceeds the length
, then all 16-bit
units to the end of the data are returned.
DOMException
CharacterData
public final void appendData(java.lang.String arg) throws DOMException
CharacterData
data
provides access to the concatenation of
data
and the DOMString
specified.
appendData
in interface CharacterData
arg
-
DOMException
CharacterData
public final void insertData(int offset, java.lang.String arg) throws DOMException
CharacterData
insertData
in interface CharacterData
offset
- arg
-
DOMException
CharacterData
public final void deleteData(int offset, int count) throws DOMException
CharacterData
data
and length
reflect the change.
deleteData
in interface CharacterData
offset
- count
-
DOMException
CharacterData
public final void replaceData(int offset, int count, java.lang.String arg) throws DOMException
CharacterData
replaceData
in interface CharacterData
offset
- count
- arg
-
DOMException
CharacterData
public final java.lang.String getTagName()
Element
<elementExample id="demo"> ... </elementExample> ,
tagName
has
the value "elementExample"
. Note that this is
case-preserving in XML, as are all of the operations of the DOM. The
HTML DOM returns the tagName
of an HTML element in the
canonical uppercase form, regardless of the case in the source HTML
document.
getTagName
in interface Element
Element
public final java.lang.String getAttribute(java.lang.String name)
Element
getAttribute
in interface Element
name
-
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.Element
public final void setAttribute(java.lang.String name, java.lang.String value) throws DOMException
Element
Attr
node plus any
Text
and EntityReference
nodes, build the
appropriate subtree, and use setAttributeNode
to assign
it as the value of an attribute.
setAttributeNS
method.
setAttribute
in interface Element
name
- value
-
DOMException
Element
public final void removeAttribute(java.lang.String name) throws DOMException
Element
removeAttributeNS
method.
removeAttribute
in interface Element
name
-
DOMException
Element
public final Attr getAttributeNode(java.lang.String name)
Element
getAttributeNodeNS
method.
getAttributeNode
in interface Element
name
-
Attr
node with the specified name (
nodeName
) or null
if there is no such
attribute.Element
public final Attr setAttributeNode(Attr newAttr) throws DOMException
Element
nodeName
) is already present in the element, it is
replaced by the new one.
setAttributeNodeNS
method.
setAttributeNode
in interface Element
newAttr
-
newAttr
attribute replaces an existing
attribute, the replaced Attr
node is returned,
otherwise null
is returned.
DOMException
Element
public final Attr removeAttributeNode(Attr oldAttr) throws DOMException
Element
Attr
has a default value it is immediately replaced. The replacing
attribute has the same namespace URI and local name, as well as the
original prefix, when applicable.
removeAttributeNode
in interface Element
oldAttr
-
Attr
node that was removed.
DOMException
Element
public boolean hasAttributes()
hasAttributes
in interface Node
true
if this node has any attributes,
false
otherwise.public final void normalize()
Node
Text
nodes in the full depth of the sub-tree
underneath this Node
, including attribute nodes, into a
"normal" form where only structure (e.g., elements, comments,
processing instructions, CDATA sections, and entity references)
separates Text
nodes, i.e., there are neither adjacent
Text
nodes nor empty Text
nodes. This can
be used to ensure that the DOM view of a document is the same as if
it were saved and re-loaded, and is useful when operations (such as
XPointer lookups) that depend on a particular document tree
structure are to be used.In cases where the document contains
CDATASections
, the normalize operation alone may not be
sufficient, since XPointers do not differentiate between
Text
nodes and CDATASection
nodes.
normalize
in interface Node
Element
public final java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Element
getAttributeNS
in interface Element
namespaceURI
- localName
-
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.Element
public final void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) throws DOMException
Element
qualifiedName
, and
its value is changed to be the value
parameter. This
value is a simple string; it is not parsed as it is being set. So any
markup (such as syntax to be recognized as an entity reference) is
treated as literal text, and needs to be appropriately escaped by the
implementation when it is written out. In order to assign an
attribute value that contains entity references, the user must create
an Attr
node plus any Text
and
EntityReference
nodes, build the appropriate subtree,
and use setAttributeNodeNS
or
setAttributeNode
to assign it as the value of an
attribute.
setAttributeNS
in interface Element
namespaceURI
- qualifiedName
- value
-
DOMException
Element
public final void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) throws DOMException
Element
removeAttributeNS
in interface Element
namespaceURI
- localName
-
DOMException
Element
public final Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
Element
Attr
node by local name and namespace URI.
getAttributeNodeNS
in interface Element
namespaceURI
- localName
-
Attr
node with the specified attribute local
name and namespace URI or null
if there is no such
attribute.Element
public final Attr setAttributeNodeNS(Attr newAttr) throws DOMException
Element
setAttributeNodeNS
in interface Element
newAttr
-
newAttr
attribute replaces an existing
attribute with the same local name and namespace URI, the replaced
Attr
node is returned, otherwise null
is
returned.
DOMException
Element
public final java.lang.String getName()
Attr
getName
in interface Attr
Attr
public final boolean getSpecified()
Attr
true
; otherwise, it is
false
. Note that the implementation is in charge of this
attribute, not the user. If the user changes the value of the
attribute (even if it ends up having the same value as the default
value) then the specified
flag is automatically flipped
to true
. To re-specify the attribute as the default
value from the DTD, the user must delete the attribute. The
implementation will then make a new attribute available with
specified
set to false
and the default
value (if one exists).
specified
is true
, and the value is
the assigned value.If the attribute has no assigned value in the
document and has a default value in the DTD, then
specified
is false
, and the value is the
default value in the DTD.If the attribute has no assigned value in
the document and has a value of #IMPLIED in the DTD, then the
attribute does not appear in the structure model of the document.If
the ownerElement
attribute is null
(i.e.
because it was just created or was set to null
by the
various removal and cloning operations) specified
is
true
.
getSpecified
in interface Attr
Attr
public final java.lang.String getValue()
Attr
getAttribute
on the
Element
interface.
Text
node with the unparsed
contents of the string. I.e. any characters that an XML processor
would recognize as markup are instead treated as literal text. See
also the method setAttribute
on the Element
interface.
getValue
in interface Attr
Attr
public final void setValue(java.lang.String value)
Attr
getAttribute
on the
Element
interface.
Text
node with the unparsed
contents of the string. I.e. any characters that an XML processor
would recognize as markup are instead treated as literal text. See
also the method setAttribute
on the Element
interface.
setValue
in interface Attr
value
- Attr
public final Element getOwnerElement()
getOwnerElement
in interface Attr
as of DOM Level 2
public Node adoptNode(Node source) throws DOMException
DOMException
public java.lang.String getEncoding()
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying, as part of the XML declaration, the encoding
of this document. This is null
when unspecified.
public void setEncoding(java.lang.String encoding)
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying, as part of the XML declaration, the encoding
of this document. This is null
when unspecified.
public boolean getStandalone()
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying, as part of the XML declaration, whether this document is standalone.
public void setStandalone(boolean standalone)
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying, as part of the XML declaration, whether this document is standalone.
public boolean getStrictErrorChecking()
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying whether errors checking is enforced or not.
When set to false
, the implementation is free to not
test every possible error case normally defined on DOM operations,
and not raise any DOMException
. In case of error, the
behavior is undefined. This attribute is true
by
defaults.
public void setStrictErrorChecking(boolean strictErrorChecking)
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying whether errors checking is enforced or not.
When set to false
, the implementation is free to not
test every possible error case normally defined on DOM operations,
and not raise any DOMException
. In case of error, the
behavior is undefined. This attribute is true
by
defaults.
public java.lang.String getVersion()
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying, as part of the XML declaration, the version
number of this document. This is null
when unspecified.
public void setVersion(java.lang.String version)
EXPERIMENTAL! Based on the Document Object Model (DOM) Level 3 Core Working Draft of 5 June 2001..
An attribute specifying, as part of the XML declaration, the version
number of this document. This is null
when unspecified.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |