Class DOMAttributePointer
- java.lang.Object
-
- org.apache.commons.jxpath.ri.model.NodePointer
-
- org.apache.commons.jxpath.ri.model.dom.DOMAttributePointer
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable
,Pointer
public class DOMAttributePointer extends NodePointer
A Pointer that points to a DOM node. Because the underlying DOM Attr is not Serializable, neither is this pointer class truly so.- Version:
- $Revision: 670727 $ $Date: 2008-06-23 15:10:38 -0500 (Mon, 23 Jun 2008) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private org.w3c.dom.Attr
attr
private static long
serialVersionUID
-
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
-
-
Constructor Summary
Constructors Constructor Description DOMAttributePointer(NodePointer parent, org.w3c.dom.Attr attr)
Create a new DOMAttributePointer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
asPath()
Returns an XPath that maps to this Pointer.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.boolean
equals(java.lang.Object object)
java.lang.Object
getBaseValue()
Returns the value represented by the pointer before indexing.java.lang.Object
getImmediateNode()
Returns the object the pointer points to; does not convert it to a "canonical" type.int
getLength()
If the pointer represents a collection (or collection element), returns the length of the collection.QName
getName()
Returns the name of this node.java.lang.String
getNamespaceURI()
Returns the namespace URI associated with this Pointer.java.lang.Object
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
isCollection()
Returnstrue
if the value of the pointer is an array or a Collection.boolean
isLeaf()
If true, this node does not have childrenvoid
remove()
Remove the node of the object graph this pointer points to.void
setValue(java.lang.Object value)
Sets the value of this attribute.boolean
testNode(NodeTest nodeTest)
Checks if this Pointer matches the supplied NodeTest.-
Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
attributeIterator, childIterator, clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValuePointer, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setIndex, setNamespaceResolver, toString
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
attr
private org.w3c.dom.Attr attr
-
-
Constructor Detail
-
DOMAttributePointer
public DOMAttributePointer(NodePointer parent, org.w3c.dom.Attr attr)
Create a new DOMAttributePointer.- Parameters:
parent
- pointerattr
- pointed
-
-
Method Detail
-
getName
public QName getName()
Description copied from class:NodePointer
Returns the name of this node. Can be null.- Specified by:
getName
in classNodePointer
- Returns:
- QName
-
getNamespaceURI
public java.lang.String getNamespaceURI()
Description copied from class:NodePointer
Returns the namespace URI associated with this Pointer.- Overrides:
getNamespaceURI
in classNodePointer
- Returns:
- String uri
-
getValue
public java.lang.Object 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
-
getBaseValue
public java.lang.Object 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
-
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
-
getImmediateNode
public java.lang.Object 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
-
isLeaf
public boolean isLeaf()
Description copied from class:NodePointer
If true, this node does not have children- Specified by:
isLeaf
in classNodePointer
- Returns:
- boolean
-
testNode
public boolean testNode(NodeTest nodeTest)
Description copied from class:NodePointer
Checks if this Pointer matches the supplied NodeTest.- Overrides:
testNode
in classNodePointer
- Parameters:
nodeTest
- the NodeTest to execute- Returns:
- true if a match
-
setValue
public void setValue(java.lang.Object value)
Sets the value of this attribute.- Specified by:
setValue
in interfacePointer
- Specified by:
setValue
in classNodePointer
- Parameters:
value
- to set
-
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
public java.lang.String 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
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in classjava.lang.Object
-
compareChildNodePointers
public int compareChildNodePointers(NodePointer pointer1, NodePointer pointer2)
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
-
-