Package org.apache.commons.jxpath.ri.model.dom

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
public class DOMNodePointer extends NodePointer
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 Details

  • Constructor Details

    • DOMNodePointer

      public DOMNodePointer(Node node, Locale locale)
      Create a new DOMNodePointer.
      Parameters:
      node - pointed at
      locale - Locale

    • DOMNodePointer

      public DOMNodePointer(Node node, Locale locale, String id)
      Create a new DOMNodePointer.
      Parameters:
      node - pointed at
      locale - Locale
      id - string id

    • DOMNodePointer

      public DOMNodePointer(NodePointer parent, Node node)
      Create a new DOMNodePointer.
      Parameters:
      parent - pointer
      node - pointed

  • Method Details

    • testNode

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

    • testNode

      public static boolean testNode(Node node, NodeTest test)
      Test a Node.
      Parameters:
      node - to test
      test - to execute
      Returns:
      true if node passes test

    • equalStrings

      private static boolean equalStrings(String s1, String s2)
      Test string equality.
      Parameters:
      s1 - String 1
      s2 - String 2
      Returns:
      true if == or .equals()

    • 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

    • childIterator

      public NodeIterator childIterator(NodeTest test, boolean reverse, NodePointer startWith)
      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 class NodePointer
      Parameters:
      test - NodeTest to filter children
      reverse - specified iteration direction
      startWith - the NodePointer to start with
      Returns:
      NodeIterator

    • attributeIterator

      public NodeIterator attributeIterator(QName name)
      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 class NodePointer
      Parameters:
      name - the attribute name to test
      Returns:
      NodeIterator

    • namespacePointer

      public NodePointer namespacePointer(String prefix)
      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 class NodePointer
      Parameters:
      prefix - incoming namespace
      Returns:
      NodePointer for namespace

    • namespaceIterator

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

    • getNamespaceResolver

      public NamespaceResolver getNamespaceResolver()
      Description copied from class: NodePointer
      Get the NamespaceResolver associated with this NodePointer.
      Overrides:
      getNamespaceResolver in class NodePointer
      Returns:
      NamespaceResolver

    • getNamespaceURI

      public String getNamespaceURI(String prefix)
      Description copied from class: NodePointer
      Decodes a namespace prefix to the corresponding URI.
      Overrides:
      getNamespaceURI in class NodePointer
      Parameters:
      prefix - prefix to decode
      Returns:
      String uri

    • getDefaultNamespaceURI

      public String getDefaultNamespaceURI()
      Description copied from class: NodePointer
      Get the default ns uri
      Overrides:
      getDefaultNamespaceURI in class NodePointer
      Returns:
      String uri

    • 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

    • 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

    • 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

    • 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

    • isLanguage

      public boolean isLanguage(String lang)
      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, calls super.isLanguage(lang).
      Overrides:
      isLanguage in class NodePointer
      Parameters:
      lang - ns to test
      Returns:
      boolean

    • findEnclosingAttribute

      protected static String findEnclosingAttribute(Node n, String attrName)
      Find the nearest occurrence of the specified attribute on the specified and enclosing elements.
      Parameters:
      n - current node
      attrName - attribute name
      Returns:
      attribute value

    • getLanguage

      protected String getLanguage()
      Get the language attribute for this node.
      Returns:
      String language name

    • setValue

      public void setValue(Object value)
      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 interface Pointer
      Specified by:
      setValue in class NodePointer
      Parameters:
      value - to set

    • createChild

      public NodePointer createChild(JXPathContext context, QName name, int index)
      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 class NodePointer
      Parameters:
      context - the owning JXPathCOntext
      name - the QName at which a child should be created
      index - child index.
      Returns:
      created NodePointer

    • createChild

      public NodePointer createChild(JXPathContext context, QName name, int index, Object value)
      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 class NodePointer
      Parameters:
      context - the owning JXPathCOntext
      name - the QName at which a child should be created
      index - child index.
      value - node value to set
      Returns:
      created NodePointer

    • createAttribute

      public NodePointer createAttribute(JXPathContext context, QName name)
      Description copied from class: NodePointer
      Called to create a non-existing attribute
      Overrides:
      createAttribute in class NodePointer
      Parameters:
      context - the owning JXPathCOntext
      name - 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 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

    • 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()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • getPrefix

      public static String getPrefix(Node node)
      Get any prefix from the specified node.
      Parameters:
      node - the node to check
      Returns:
      String xml prefix

    • getLocalName

      public static String getLocalName(Node node)
      Get the local name of the specified node.
      Parameters:
      node - node to check
      Returns:
      String local name

    • getNamespaceURI

      public static String getNamespaceURI(Node node)
      Get the ns uri of the specified node.
      Parameters:
      node - Node to check
      Returns:
      String ns 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

    • stringValue

      private String stringValue(Node node)
      Get the string value of the specified node.
      Parameters:
      node - Node to check
      Returns:
      String

    • getPointerByID

      public Pointer getPointerByID(JXPathContext context, String id)
      Locates a node by ID.
      Overrides:
      getPointerByID in class NodePointer
      Parameters:
      context - starting context
      id - to find
      Returns:
      Pointer

    • 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