Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> commons >> jxpath >> ri >> model >> [ jdom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.commons.jxpath.ri.model.jdom
Class JDOMNodePointer  

java.lang.Object
  org.apache.commons.jxpath.ri.model.NodePointer
      org.apache.commons.jxpath.ri.model.jdom.JDOMNodePointer

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, org.apache.commons.jxpath.Pointer, java.io.Serializable

---

public class JDOMNodePointer

extends org.apache.commons.jxpath.ri.model.NodePointer

A Pointer that points to a DOM node.

Version:

$Revision: 1.17 $ $Date: 2004/06/29 22:58:18 $

---

Field Summary
private  java.lang.String	defaultNamespace
private  java.lang.String	id
private  java.util.Map	namespaces
private  java.lang.Object	node
static java.lang.String	XML_NAMESPACE_URI
static java.lang.String	XMLNS_NAMESPACE_URI

 

Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer

index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION

 

Constructor Summary

JDOMNodePointer(org.apache.commons.jxpath.ri.model.NodePointer parent, java.lang.Object node)

JDOMNodePointer(java.lang.Object node, java.util.Locale locale)

JDOMNodePointer(java.lang.Object node, java.util.Locale locale, java.lang.String id)

 

Method Summary
private  void	addContent(java.util.List content)
java.lang.String	asPath()           Returns an XPath that maps to this Pointer.
org.apache.commons.jxpath.ri.model.NodeIterator	attributeIterator(org.apache.commons.jxpath.ri.QName name)           Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard).
org.apache.commons.jxpath.ri.model.NodeIterator	childIterator(org.apache.commons.jxpath.ri.compiler.NodeTest test, boolean reverse, org.apache.commons.jxpath.ri.model.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(org.apache.commons.jxpath.ri.model.NodePointer pointer1, org.apache.commons.jxpath.ri.model.NodePointer pointer2)           Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.
org.apache.commons.jxpath.ri.model.NodePointer	createAttribute(org.apache.commons.jxpath.JXPathContext context, org.apache.commons.jxpath.ri.QName name)           Called to create a non-existing attribute
org.apache.commons.jxpath.ri.model.NodePointer	createChild(org.apache.commons.jxpath.JXPathContext context, org.apache.commons.jxpath.ri.QName name, int index)           Called by a child pointer when it needs to create a parent object for a non-existent collection element.
org.apache.commons.jxpath.ri.model.NodePointer	createChild(org.apache.commons.jxpath.JXPathContext context, org.apache.commons.jxpath.ri.QName name, int index, java.lang.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	equals(java.lang.Object object)           Determine whether this Object is semantically equal to another Object.
private static boolean	equalStrings(java.lang.String s1, java.lang.String s2)
private  java.lang.String	escape(java.lang.String string)
private  org.apache.commons.jxpath.AbstractFactory	getAbstractFactory(org.apache.commons.jxpath.JXPathContext context)
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.
protected  java.lang.String	getLanguage()
int	getLength()           If the pointer represents a collection (or collection element), returns the length of the collection.
static java.lang.String	getLocalName(java.lang.Object node)
org.apache.commons.jxpath.ri.QName	getName()           Returns the name of this node.
java.lang.String	getNamespaceURI()           Returns the namespace URI associated with this Pointer.
private static java.lang.String	getNamespaceURI(java.lang.Object node)
java.lang.String	getNamespaceURI(java.lang.String prefix)           Decodes a namespace prefix to the corresponding URI.
static java.lang.String	getPrefix(java.lang.Object node)
private  int	getRelativePositionByName()
private  int	getRelativePositionOfElement()
private  int	getRelativePositionOfPI(java.lang.String target)
private  int	getRelativePositionOfTextNode()
java.lang.Object	getValue()           By default, returns getNode(), can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	isCollection()           Returns true if the value of the pointer is an array or a Collection.
boolean	isLanguage(java.lang.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 children
org.apache.commons.jxpath.ri.model.NodeIterator	namespaceIterator()           Returns a NodeIterator that iterates over all namespaces of the value currently pointed at.
org.apache.commons.jxpath.ri.model.NodePointer	namespacePointer(java.lang.String prefix)           Returns a NodePointer for the specified namespace.
private  org.jdom.Element	nodeParent(java.lang.Object node)
void	remove()           Remove the node of the object graph this pointer points to.
void	setValue(java.lang.Object value)           Converts the value to the required type and changes the corresponding object to that value.
static boolean	testNode(org.apache.commons.jxpath.ri.model.NodePointer pointer, java.lang.Object node, org.apache.commons.jxpath.ri.compiler.NodeTest test)
boolean	testNode(org.apache.commons.jxpath.ri.compiler.NodeTest test)           Checks if this Pointer matches the supplied NodeTest.

 

Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer

clone, compareTo, createPath, createPath, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValuePointer, isActual, isAttribute, isContainer, isDefaultNamespace, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setIndex, setNamespaceResolver, toString

 

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

node

private java.lang.Object node

---

namespaces

private java.util.Map namespaces

---

defaultNamespace

private java.lang.String defaultNamespace

---

id

private java.lang.String id

---

XML_NAMESPACE_URI

public static final java.lang.String XML_NAMESPACE_URI

See Also:

Constant Field Values

---

XMLNS_NAMESPACE_URI

public static final java.lang.String XMLNS_NAMESPACE_URI

See Also:

Constant Field Values

Constructor Detail

JDOMNodePointer

public JDOMNodePointer(java.lang.Object node,
                       java.util.Locale locale)

---

JDOMNodePointer

public JDOMNodePointer(java.lang.Object node,
                       java.util.Locale locale,
                       java.lang.String id)

---

JDOMNodePointer

public JDOMNodePointer(org.apache.commons.jxpath.ri.model.NodePointer parent,
                       java.lang.Object node)

Method Detail

childIterator

public org.apache.commons.jxpath.ri.model.NodeIterator childIterator(org.apache.commons.jxpath.ri.compiler.NodeTest test,
                                                                     boolean reverse,
                                                                     org.apache.commons.jxpath.ri.model.NodePointer startWith)

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.

---

attributeIterator

public org.apache.commons.jxpath.ri.model.NodeIterator attributeIterator(org.apache.commons.jxpath.ri.QName name)

Description copied from class: org.apache.commons.jxpath.ri.model.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.

---

namespaceIterator

public org.apache.commons.jxpath.ri.model.NodeIterator namespaceIterator()

Description copied from class: org.apache.commons.jxpath.ri.model.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.

---

namespacePointer

public org.apache.commons.jxpath.ri.model.NodePointer namespacePointer(java.lang.String prefix)

Description copied from class: org.apache.commons.jxpath.ri.model.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.

---

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns the namespace URI associated with this Pointer.

---

getNamespaceURI

private static java.lang.String getNamespaceURI(java.lang.Object node)

---

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Decodes a namespace prefix to the corresponding URI.

---

compareChildNodePointers

public int compareChildNodePointers(org.apache.commons.jxpath.ri.model.NodePointer pointer1,
                                    org.apache.commons.jxpath.ri.model.NodePointer pointer2)

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.

---

getBaseValue

public java.lang.Object getBaseValue()

Description copied from class: org.apache.commons.jxpath.ri.model.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.

---

isCollection

public boolean isCollection()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns true if the value of the pointer is an array or a Collection.

---

getLength

public int getLength()

Description copied from class: org.apache.commons.jxpath.ri.model.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).

---

isLeaf

public boolean isLeaf()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

If true, this node does not have children

---

getName

public org.apache.commons.jxpath.ri.QName getName()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns the name of this node. Can be null.

---

getImmediateNode

public java.lang.Object getImmediateNode()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns the object the pointer points to; does not convert it to a "canonical" type.

---

getValue

public java.lang.Object getValue()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

By default, returns getNode(), can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.

---

setValue

public void setValue(java.lang.Object value)

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Converts the value to the required type and changes the corresponding object to that value.

---

addContent

private void addContent(java.util.List content)

---

testNode

public boolean testNode(org.apache.commons.jxpath.ri.compiler.NodeTest test)

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Checks if this Pointer matches the supplied NodeTest.

---

testNode

public static boolean testNode(org.apache.commons.jxpath.ri.model.NodePointer pointer,
                               java.lang.Object node,
                               org.apache.commons.jxpath.ri.compiler.NodeTest test)

---

equalStrings

private static boolean equalStrings(java.lang.String s1,
                                    java.lang.String s2)

---

getPrefix

public static java.lang.String getPrefix(java.lang.Object node)

---

getLocalName

public static java.lang.String getLocalName(java.lang.Object node)

---

isLanguage

public boolean isLanguage(java.lang.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).

---

getLanguage

protected java.lang.String getLanguage()

---

nodeParent

private org.jdom.Element nodeParent(java.lang.Object node)

---

createChild

public org.apache.commons.jxpath.ri.model.NodePointer createChild(org.apache.commons.jxpath.JXPathContext context,
                                                                  org.apache.commons.jxpath.ri.QName name,
                                                                  int index)

Description copied from class: org.apache.commons.jxpath.ri.model.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.

---

createChild

public org.apache.commons.jxpath.ri.model.NodePointer createChild(org.apache.commons.jxpath.JXPathContext context,
                                                                  org.apache.commons.jxpath.ri.QName name,
                                                                  int index,
                                                                  java.lang.Object value)

Description copied from class: org.apache.commons.jxpath.ri.model.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.

---

createAttribute

public org.apache.commons.jxpath.ri.model.NodePointer createAttribute(org.apache.commons.jxpath.JXPathContext context,
                                                                      org.apache.commons.jxpath.ri.QName name)

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Called to create a non-existing attribute

---

remove

public void remove()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Remove the node of the object graph this pointer points to.

---

asPath

public java.lang.String asPath()

Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns an XPath that maps to this Pointer.

---

escape

private java.lang.String escape(java.lang.String string)

---

getRelativePositionByName

private int getRelativePositionByName()

---

getRelativePositionOfElement

private int getRelativePositionOfElement()

---

getRelativePositionOfTextNode

private int getRelativePositionOfTextNode()

---

getRelativePositionOfPI

private int getRelativePositionOfPI(java.lang.String target)

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

equals

public boolean equals(java.lang.Object object)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

getAbstractFactory

private org.apache.commons.jxpath.AbstractFactory getAbstractFactory(org.apache.commons.jxpath.JXPathContext context)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> commons >> jxpath >> ri >> model >> [ jdom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---