org.apache.commons.jxpath.ri.model.dom
Class DOMAttributePointer

java.lang.Object
  |
  +--org.apache.commons.jxpath.ri.model.NodePointer
        |
        +--org.apache.commons.jxpath.ri.model.dom.DOMAttributePointer
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, Pointer

public class DOMAttributePointer
extends NodePointer

A Pointer that points to a DOM node.

Version:
$Revision: 1.5 $ $Date: 2002/05/08 23:05:05 $
Author:
Dmitri Plotnikov

Field Summary
 
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
 
Constructor Summary
DOMAttributePointer(NodePointer parent, org.w3c.dom.Attr attr)
           
 
Method Summary
 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.
 QName getExpandedName()
          Returns a name that consists of the namespaceURI and the local name of the node.
 QName getName()
          Returns the name of this node.
 java.lang.String getNamespaceURI()
          Returns the namespace URI associated with this Pointer.
 java.lang.Object getNodeValue()
          Returns the object the pointer points to; does not convert it to a "canonical" type.
 int hashCode()
           
 boolean isActual()
          An actual pointer points to an existing part of an object graph, even if it is null.
 boolean isLeaf()
          If true, this node does not have children
 void 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, createChild, createChild, createPath, createPath, getDefaultNamespaceURI, getIndex, getLength, getLocale, getNamespaceURI, getParent, getPointerByID, getPointerByKey, getValue, getValuePointer, isCollection, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setIndex, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DOMAttributePointer

public DOMAttributePointer(NodePointer parent,
                           org.w3c.dom.Attr attr)
Method Detail

getName

public QName getName()
Description copied from class: NodePointer
Returns the name of this node. Can be null.

Specified by:
getName in class NodePointer

getExpandedName

public QName getExpandedName()
Description copied from class: NodePointer
Returns a name that consists of the namespaceURI and the local name of the node. For non-XML pointers, returns the Pointer's qualified name.

Overrides:
getExpandedName in class NodePointer

getNamespaceURI

public java.lang.String getNamespaceURI()
Description copied from class: NodePointer
Returns the namespace URI associated with this Pointer.

Overrides:
getNamespaceURI in class NodePointer

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 class NodePointer

getNodeValue

public java.lang.Object getNodeValue()
Description copied from class: NodePointer
Returns the object the pointer points to; does not convert it to a "canonical" type.

Specified by:
getNodeValue in class NodePointer

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 class NodePointer

isLeaf

public boolean isLeaf()
Description copied from class: NodePointer
If true, this node does not have children

Overrides:
isLeaf in class NodePointer

testNode

public boolean testNode(NodeTest nodeTest)
Description copied from class: NodePointer
Checks if this Pointer matches the supplied NodeTest.

Overrides:
testNode in class NodePointer

setValue

public void setValue(java.lang.Object value)
Sets the value of this attribute.

Specified by:
setValue in interface Pointer
Specified by:
setValue in class NodePointer

remove

public void remove()
Description copied from class: NodePointer
Remove the node of the object graph this pointer points to.

Overrides:
remove in class NodePointer

asPath

public java.lang.String asPath()
Description copied from class: NodePointer
Returns an XPath that maps to this Pointer.

Specified by:
asPath in interface Pointer
Overrides:
asPath in class NodePointer

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.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 class NodePointer


Copyright (c) 2001 - Apache Software Foundation