Class DOMNodePointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.dom.DOMNodePointer
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
,Pointer
A Pointer that points to a DOM node. Because a DOM Node is not guaranteed Serializable,
a DOMNodePointer instance may likewise not be properly Serializable.
- Version:
- $Revision: 668329 $ $Date: 2008-06-16 16:59:48 -0500 (Mon, 16 Jun 2008) $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String
private NamespaceResolver
private Map
private Node
private static final long
static final String
XML namespace URIstatic final String
XMLNS namespace URIFields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
-
Constructor Summary
ConstructorsConstructorDescriptionDOMNodePointer
(NodePointer parent, Node node) Create a new DOMNodePointer.DOMNodePointer
(Node node, Locale locale) Create a new DOMNodePointer.DOMNodePointer
(Node node, Locale locale, String id) Create a new DOMNodePointer. -
Method Summary
Modifier and TypeMethodDescriptionasPath()
Returns an XPath that maps to this Pointer.attributeIterator
(QName name) Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard).childIterator
(NodeTest test, boolean reverse, NodePointer startWith) Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.int
compareChildNodePointers
(NodePointer pointer1, NodePointer pointer2) Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.createAttribute
(JXPathContext context, QName name) Called to create a non-existing attributecreateChild
(JXPathContext context, QName name, int index) Called by a child pointer when it needs to create a parent object for a non-existent collection element.createChild
(JXPathContext context, QName name, int index, Object value) Called by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node.boolean
private static boolean
equalStrings
(String s1, String s2) Test string equality.protected static String
findEnclosingAttribute
(Node n, String attrName) Find the nearest occurrence of the specified attribute on the specified and enclosing elements.Returns the value represented by the pointer before indexing.Get the default ns uriReturns the object the pointer points to; does not convert it to a "canonical" type.protected String
Get the language attribute for this node.int
If the pointer represents a collection (or collection element), returns the length of the collection.static String
getLocalName
(Node node) Get the local name of the specified node.getName()
Returns the name of this node.Get the NamespaceResolver associated with this NodePointer.Returns the namespace URI associated with this Pointer.getNamespaceURI
(String prefix) Decodes a namespace prefix to the corresponding URI.static String
getNamespaceURI
(Node node) Get the ns uri of the specified node.getPointerByID
(JXPathContext context, String id) Locates a node by ID.static String
Get any prefix from the specified node.private int
Get relative position of this among like-named siblings.private int
Get relative position of this among all siblings.private int
Get the relative position of this among same-target processing instruction siblings.private int
Get the relative position of this among sibling text nodes.getValue()
By default, returnsgetNode()
, can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.int
hashCode()
boolean
isActual()
An actual pointer points to an existing part of an object graph, even if it is null.boolean
Returnstrue
if the value of the pointer is an array or a Collection.boolean
isLanguage
(String lang) Returns true if the xml:lang attribute for the current node or its parent has the specified prefix lang.boolean
isLeaf()
If true, this node does not have childrenReturns a NodeIterator that iterates over all namespaces of the value currently pointed at.namespacePointer
(String prefix) Returns a NodePointer for the specified namespace.void
remove()
Remove the node of the object graph this pointer points to.void
Sets contents of the node to the specified value.private String
stringValue
(Node node) Get the string value of the specified node.boolean
Checks if this Pointer matches the supplied NodeTest.static boolean
Test a Node.Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
clone, compareTo, createPath, createPath, escape, getAbstractFactory, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByKey, getRootNode, getValuePointer, isAttribute, isContainer, isDefaultNamespace, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setIndex, setNamespaceResolver, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
node
-
namespaces
-
defaultNamespace
-
id
-
localNamespaceResolver
-
XML_NAMESPACE_URI
XML namespace URI- See Also:
-
XMLNS_NAMESPACE_URI
XMLNS namespace URI- See Also:
-
-
Constructor Details
-
DOMNodePointer
Create a new DOMNodePointer.- Parameters:
node
- pointed atlocale
- Locale
-
DOMNodePointer
Create a new DOMNodePointer.- Parameters:
node
- pointed atlocale
- Localeid
- string id
-
DOMNodePointer
Create a new DOMNodePointer.- Parameters:
parent
- pointernode
- pointed
-
-
Method Details
-
testNode
Description copied from class:NodePointer
Checks if this Pointer matches the supplied NodeTest.- Overrides:
testNode
in classNodePointer
- Parameters:
test
- the NodeTest to execute- Returns:
- true if a match
-
testNode
Test a Node.- Parameters:
node
- to testtest
- to execute- Returns:
- true if node passes test
-
equalStrings
Test string equality.- Parameters:
s1
- String 1s2
- String 2- Returns:
- true if == or .equals()
-
getName
Description copied from class:NodePointer
Returns the name of this node. Can be null.- Specified by:
getName
in classNodePointer
- Returns:
- QName
-
getNamespaceURI
Description copied from class:NodePointer
Returns the namespace URI associated with this Pointer.- Overrides:
getNamespaceURI
in classNodePointer
- Returns:
- String uri
-
childIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.- Overrides:
childIterator
in classNodePointer
- Parameters:
test
- NodeTest to filter childrenreverse
- specified iteration directionstartWith
- the NodePointer to start with- Returns:
- NodeIterator
-
attributeIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard). May return null if the object does not support the attributes.- Overrides:
attributeIterator
in classNodePointer
- Parameters:
name
- the attribute name to test- Returns:
- NodeIterator
-
namespacePointer
Description copied from class:NodePointer
Returns a NodePointer for the specified namespace. Will return null if namespaces are not supported. Will return UNKNOWN_NAMESPACE if there is no such namespace.- Overrides:
namespacePointer
in classNodePointer
- Parameters:
prefix
- incoming namespace- Returns:
- NodePointer for
namespace
-
namespaceIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all namespaces of the value currently pointed at. May return null if the object does not support the namespaces.- Overrides:
namespaceIterator
in classNodePointer
- Returns:
- NodeIterator
-
getNamespaceResolver
Description copied from class:NodePointer
Get the NamespaceResolver associated with this NodePointer.- Overrides:
getNamespaceResolver
in classNodePointer
- Returns:
- NamespaceResolver
-
getNamespaceURI
Description copied from class:NodePointer
Decodes a namespace prefix to the corresponding URI.- Overrides:
getNamespaceURI
in classNodePointer
- Parameters:
prefix
- prefix to decode- Returns:
- String uri
-
getDefaultNamespaceURI
Description copied from class:NodePointer
Get the default ns uri- Overrides:
getDefaultNamespaceURI
in classNodePointer
- Returns:
- String uri
-
getBaseValue
Description copied from class:NodePointer
Returns the value represented by the pointer before indexing. So, if the node represents an element of a collection, this method returns the collection itself.- Specified by:
getBaseValue
in classNodePointer
- Returns:
- Object value
-
getImmediateNode
Description copied from class:NodePointer
Returns the object the pointer points to; does not convert it to a "canonical" type.- Specified by:
getImmediateNode
in classNodePointer
- Returns:
- Object node
-
isActual
public boolean isActual()Description copied from class:NodePointer
An actual pointer points to an existing part of an object graph, even if it is null. A non-actual pointer represents a part that does not exist at all. For instance consider the pointer "/address/street". If both address and street are not null, the pointer is actual. If address is not null, but street is null, the pointer is still actual. If address is null, the pointer is not actual. (In JavaBeans) if address is not a property of the root bean, a Pointer for this path cannot be obtained at all - actual or otherwise.- Overrides:
isActual
in classNodePointer
- Returns:
- boolean
-
isCollection
public boolean isCollection()Description copied from class:NodePointer
Returnstrue
if the value of the pointer is an array or a Collection.- Specified by:
isCollection
in classNodePointer
- Returns:
- boolean
-
getLength
public int getLength()Description copied from class:NodePointer
If the pointer represents a collection (or collection element), returns the length of the collection. Otherwise returns 1 (even if the value is null).- Specified by:
getLength
in classNodePointer
- Returns:
- int
-
isLeaf
public boolean isLeaf()Description copied from class:NodePointer
If true, this node does not have children- Specified by:
isLeaf
in classNodePointer
- Returns:
- boolean
-
isLanguage
Returns true if the xml:lang attribute for the current node or its parent has the specified prefix lang. If no node has this prefix, callssuper.isLanguage(lang)
.- Overrides:
isLanguage
in classNodePointer
- Parameters:
lang
- ns to test- Returns:
- boolean
-
findEnclosingAttribute
Find the nearest occurrence of the specified attribute on the specified and enclosing elements.- Parameters:
n
- current nodeattrName
- attribute name- Returns:
- attribute value
-
getLanguage
Get the language attribute for this node.- Returns:
- String language name
-
setValue
Sets contents of the node to the specified value. If the value is a String, the contents of the node are replaced with this text. If the value is an Element or Document, the children of the node are replaced with the children of the passed node.- Specified by:
setValue
in interfacePointer
- Specified by:
setValue
in classNodePointer
- Parameters:
value
- to set
-
createChild
Description copied from class:NodePointer
Called by a child pointer when it needs to create a parent object for a non-existent collection element. It may have to expand the collection, then create an element object and return a new pointer describing the newly created element.- Overrides:
createChild
in classNodePointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.- Returns:
- created NodePointer
-
createChild
Description copied from class:NodePointer
Called by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node. This method may have to expand the collection in order to assign the element.- Overrides:
createChild
in classNodePointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.value
- node value to set- Returns:
- created NodePointer
-
createAttribute
Description copied from class:NodePointer
Called to create a non-existing attribute- Overrides:
createAttribute
in classNodePointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which an attribute should be created- Returns:
- created NodePointer
-
remove
public void remove()Description copied from class:NodePointer
Remove the node of the object graph this pointer points to.- Overrides:
remove
in classNodePointer
-
asPath
Description copied from class:NodePointer
Returns an XPath that maps to this Pointer.- Specified by:
asPath
in interfacePointer
- Overrides:
asPath
in classNodePointer
- Returns:
- String xpath expression
-
getRelativePositionByName
private int getRelativePositionByName()Get relative position of this among like-named siblings.- Returns:
- 1..n
-
getRelativePositionOfElement
private int getRelativePositionOfElement()Get relative position of this among all siblings.- Returns:
- 1..n
-
getRelativePositionOfTextNode
private int getRelativePositionOfTextNode()Get the relative position of this among sibling text nodes.- Returns:
- 1..n
-
getRelativePositionOfPI
private int getRelativePositionOfPI()Get the relative position of this among same-target processing instruction siblings.- Returns:
- 1..n
-
hashCode
public int hashCode() -
equals
-
getPrefix
Get any prefix from the specified node.- Parameters:
node
- the node to check- Returns:
- String xml prefix
-
getLocalName
Get the local name of the specified node.- Parameters:
node
- node to check- Returns:
- String local name
-
getNamespaceURI
Get the ns uri of the specified node.- Parameters:
node
- Node to check- Returns:
- String ns uri
-
getValue
Description copied from class:NodePointer
By default, returnsgetNode()
, can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.- Specified by:
getValue
in interfacePointer
- Overrides:
getValue
in classNodePointer
- Returns:
- Object value
-
stringValue
Get the string value of the specified node.- Parameters:
node
- Node to check- Returns:
- String
-
getPointerByID
Locates a node by ID.- Overrides:
getPointerByID
in classNodePointer
- Parameters:
context
- starting contextid
- to find- Returns:
- Pointer
-
compareChildNodePointers
Description copied from class:NodePointer
Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.- Specified by:
compareChildNodePointers
in classNodePointer
- Parameters:
pointer1
- first pointer to be comparedpointer2
- second pointer to be compared- Returns:
- int per Java comparison conventions
-