Package 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:
Serializable, Cloneable, 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:

  • Field Details

  • Constructor Details

    • DOMAttributePointer

      public DOMAttributePointer(NodePointer parent, Attr attr)
      Create a new DOMAttributePointer.
      Parameters:
      parent - pointer
      attr - pointed

  • Method Details

    • getName

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

    • getNamespaceURI

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

    • getValue

      public Object getValue()
      Description copied from class: NodePointer
      By default, returns getNode(), can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.
      Specified by:
      getValue in interface Pointer
      Overrides:
      getValue in class NodePointer
      Returns:
      Object value

    • getBaseValue

      public 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
      Returns:
      Object value

    • isCollection

      public boolean isCollection()
      Description copied from class: NodePointer
      Returns true if the value of the pointer is an array or a Collection.
      Specified by:
      isCollection in class NodePointer
      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 class NodePointer
      Returns:
      int

    • getImmediateNode

      public 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 class NodePointer
      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 class NodePointer
      Returns:
      boolean

    • isLeaf

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

    • testNode

      public boolean testNode(NodeTest nodeTest)
      Description copied from class: NodePointer
      Checks if this Pointer matches the supplied NodeTest.
      Overrides:
      testNode in class NodePointer
      Parameters:
      nodeTest - the NodeTest to execute
      Returns:
      true if a match

    • setValue

      public void setValue(Object value)
      Sets the value of this attribute.
      Specified by:
      setValue in interface Pointer
      Specified by:
      setValue in class NodePointer
      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 class NodePointer

    • asPath

      public 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
      Returns:
      String xpath expression

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class 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
      Parameters:
      pointer1 - first pointer to be compared
      pointer2 - second pointer to be compared
      Returns:
      int per Java comparison conventions