|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xpath.domapi.XPathNamespaceImpl
The XPathNamespace
interface is returned by
XPathResult
interfaces to represent the XPath namespace node
type that DOM lacks. There is no public constructor for this node type.
Attempts to place it into a hierarchy or a NamedNodeMap result in a
DOMException
with the code HIERARCHY_REQUEST_ERR
. This node is read only, so methods or setting of attributes that would
mutate the node result in a DOMException with the code
NO_MODIFICATION_ALLOWED_ERR
.
The core specification describes attributes of the Node
interface that are different for different node node types but does not
describe XPATH_NAMESPACE_NODE
, so here is a description of
those attributes for this node type. All attributes of Node
not described in this section have a null
or
false
value.
ownerDocument
matches the ownerDocument
of the
ownerElement
even if the element is later adopted.
prefix
is the prefix of the namespace represented by the
node.
nodeName
is the same as prefix
.
nodeType
is equal to XPATH_NAMESPACE_NODE
.
namespaceURI
is the namespace URI of the namespace
represented by the node.
adoptNode
, cloneNode
, and
importNode
fail on this node type by raising a
DOMException
with the code NOT_SUPPORTED_ERR
.In
future versions of the XPath specification, the definition of a namespace
node may be changed incomatibly, in which case incompatible changes to
field values may be required to implement versions beyond XPath 1.0.
See also the Document Object Model (DOM) Level 3 XPath Specification. This implementation wraps the DOM attribute node that contained the namespace declaration.
Field Summary |
---|
Fields inherited from interface org.w3c.dom.xpath.XPathNamespace |
---|
XPATH_NAMESPACE_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 | |
---|---|
XPathNamespaceImpl(Node node)
Constructor for XPathNamespaceImpl. |
Method Summary | |
---|---|
Node |
appendChild(Node arg0)
Adds the node newChild to the end of the list of children
of this node. |
Node |
cloneNode(boolean arg0)
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. |
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. |
Node |
getFirstChild()
The first child of this node. |
Node |
getLastChild()
The last child of this node. |
java.lang.String |
getLocalName()
Returns the local part of the qualified name of this node. |
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()
The Element on which the namespace was in scope when it
was requested. |
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 |
hasAttributes()
Returns whether this node (if it is an element) has any attributes. |
boolean |
hasChildNodes()
Returns whether this node has any children. |
Node |
insertBefore(Node arg0,
Node arg1)
Inserts the node newChild before the existing child node
refChild . |
boolean |
isSupported(java.lang.String arg0,
java.lang.String arg1)
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. |
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. |
Node |
removeChild(Node arg0)
Removes the child node indicated by oldChild from the list
of children, and returns it. |
Node |
replaceChild(Node arg0,
Node arg1)
Replaces the child node oldChild with newChild
in the list of children, and returns the oldChild node.
|
void |
setNodeValue(java.lang.String arg0)
The value of this node, depending on its type; see the table above. |
void |
setPrefix(java.lang.String arg0)
The namespace prefix of this node, or null if it is
unspecified.
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XPathNamespaceImpl(Node node)
Method Detail |
public Element getOwnerElement()
XPathNamespace
Element
on which the namespace was in scope when it
was requested. This does not change on a returned namespace node even
if the document changes such that the namespace goes out of scope on
that element and this node is no longer found there by XPath.
getOwnerElement
in interface XPathNamespace
org.apache.xalan.dom3.xpath.XPathNamespace#getOwnerElement()
public java.lang.String getNodeName()
Node
getNodeName
in interface Node
Node.getNodeName()
public java.lang.String getNodeValue() throws DOMException
Node
null
, setting it has no effect.
getNodeValue
in interface Node
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.Node.getNodeValue()
public void setNodeValue(java.lang.String arg0) throws DOMException
Node
null
, setting it has no effect.
setNodeValue
in interface Node
DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.Node.setNodeValue(String)
public short getNodeType()
Node
getNodeType
in interface Node
Node.getNodeType()
public 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.getParentNode()
public 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.getChildNodes()
public Node getFirstChild()
Node
null
.
getFirstChild
in interface Node
Node.getFirstChild()
public Node getLastChild()
Node
null
.
getLastChild
in interface Node
Node.getLastChild()
public Node getPreviousSibling()
Node
null
.
getPreviousSibling
in interface Node
Node.getPreviousSibling()
public Node getNextSibling()
Node
null
.
getNextSibling
in interface Node
Node.getNextSibling()
public NamedNodeMap getAttributes()
Node
NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise.
getAttributes
in interface Node
Node.getAttributes()
public 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.getOwnerDocument()
public Node insertBefore(Node arg0, Node arg1) 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
arg0
- The node to insert.arg1
- 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 or this node
itself.
newChild
was created
from a different document than the one that created this node.
refChild
is not a child of
this node.Node.insertBefore(Node, Node)
public Node replaceChild(Node arg0, Node arg1) 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
arg0
- The new node to put in the child list.arg1
- The node being replaced in the list.
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 put in is one of this node's ancestors or this node
itself.
newChild
was created
from a different document than the one that created this node.
oldChild
is not a child of
this node.Node.replaceChild(Node, Node)
public Node removeChild(Node arg0) throws DOMException
Node
oldChild
from the list
of children, and returns it.
removeChild
in interface Node
arg0
- The node being removed.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldChild
is not a child of
this node.Node.removeChild(Node)
public Node appendChild(Node arg0) 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
arg0
- The 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 or this node
itself.
newChild
was created
from a different document than the one that created this node.
Node.appendChild(Node)
public boolean hasChildNodes()
Node
hasChildNodes
in interface Node
true
if this node has any children,
false
otherwise.Node.hasChildNodes()
public Node cloneNode(boolean arg0)
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
arg0
- If true
, recursively clone the subtree under
the specified node; if false
, clone only the node
itself (and its attributes, if it is an Element
).
Node.cloneNode(boolean)
public 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
Node.normalize()
public boolean isSupported(java.lang.String arg0, java.lang.String arg1)
Node
isSupported
in interface Node
arg0
- The name of the feature to test. This is the same name
which can be passed to the method hasFeature
on
DOMImplementation
.arg1
- This is the version number of the feature to test. In
Level 2, version 1, this is the string "2.0". If the version is not
specified, supporting any version of the feature will cause the
method to return true
.
true
if the specified feature is
supported on this node, false
otherwise.Node.isSupported(String, String)
public 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
Node.getNamespaceURI()
public 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
Node.getPrefix()
public void setPrefix(java.lang.String arg0) 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
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified prefix contains an
illegal character, per the XML 1.0 specification .
prefix
is
malformed per the Namespaces in XML specification, if the
namespaceURI
of this node is null
, if the
specified prefix is "xml" and the namespaceURI
of this
node is different from "http://www.w3.org/XML/1998/namespace", if
this node is an attribute and the specified prefix is "xmlns" and
the namespaceURI
of this node is different from "
http://www.w3.org/2000/xmlns/", or if this node is an attribute and
the qualifiedName
of this node is "xmlns" .Node.setPrefix(String)
public 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
Node.getLocalName()
public boolean hasAttributes()
Node
hasAttributes
in interface Node
true
if this node has any attributes,
false
otherwise.Node.hasAttributes()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |