Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> jxpath >> ri >> model >> [ beans overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.jxpath.ri.model.beans.CollectionPointer JAVADOC | Sourc code of org.apache.commons.jxpath.ri.model.beans.CollectionPointer SOURCE | Download org.apache.commons.jxpath.ri.model.beans.CollectionPointer DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.jxpath.ri.model.beans
Class CollectionPointer  view CollectionPointer download CollectionPointer.java

java.lang.Object
  extended byorg.apache.commons.jxpath.ri.model.NodePointer
      extended byorg.apache.commons.jxpath.ri.model.beans.CollectionPointer
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, org.apache.commons.jxpath.Pointer, java.io.Serializable
Direct Known Subclasses:
NullElementPointer
public class CollectionPointer
extends org.apache.commons.jxpath.ri.model.NodePointer

Transparent pointer to a collection (array or Collection).

Version:
$Revision: 1.19 $ $Date: 2004/04/04 22:06:35 $

Field Summary
private  java.lang.Object collection
           
private  org.apache.commons.jxpath.ri.model.NodePointer valuePointer
           
 
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
 
Constructor Summary
CollectionPointer(org.apache.commons.jxpath.ri.model.NodePointer parent, java.lang.Object collection)
           
CollectionPointer(java.lang.Object collection, java.util.Locale locale)
           
 
Method Summary
 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 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.
 org.apache.commons.jxpath.ri.model.NodePointer createPath(org.apache.commons.jxpath.JXPathContext context)
          Called by a child pointer when it needs to create a parent object.
 org.apache.commons.jxpath.ri.model.NodePointer createPath(org.apache.commons.jxpath.JXPathContext context, java.lang.Object value)
          Called directly by JXPathContext.
 boolean equals(java.lang.Object object)
          Determine whether this Object is semantically equal to another 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.
 org.apache.commons.jxpath.ri.QName getName()
          Returns the name of this node.
 org.apache.commons.jxpath.ri.model.NodePointer getValuePointer()
          If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents.
 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 isContainer()
          If true, this node is axiliary and can only be used as an intermediate in the chain of pointers.
 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 namespace)
          Returns a NodePointer for the specified namespace.
 void setIndex(int index)
           
 void setValue(java.lang.Object value)
          Converts the value to the required type and changes the corresponding object to that value.
 boolean testNode(org.apache.commons.jxpath.ri.compiler.NodeTest nodeTest)
          Checks if this Pointer matches the supplied NodeTest.
 
Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
clone, compareTo, createAttribute, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, isActual, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setNamespaceResolver, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

collection

private java.lang.Object collection

valuePointer

private org.apache.commons.jxpath.ri.model.NodePointer valuePointer
Constructor Detail

CollectionPointer

public CollectionPointer(java.lang.Object collection,
                         java.util.Locale locale)

CollectionPointer

public CollectionPointer(org.apache.commons.jxpath.ri.model.NodePointer parent,
                         java.lang.Object collection)
Method Detail

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.

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

isContainer

public boolean isContainer()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
If true, this node is axiliary and can only be used as an intermediate in the chain of pointers.

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.

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.

setIndex

public void setIndex(int index)

getValuePointer

public org.apache.commons.jxpath.ri.model.NodePointer getValuePointer()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents. Only an auxiliary (non-node) pointer can (and should) return a value pointer other than itself. Note that you probably don't want to override getValuePointer() directly. Override the getImmediateValuePointer() method instead. The getValuePointer() method is calls getImmediateValuePointer() and, if the result is not this, invokes getValuePointer() recursively. The idea here is to open all nested containers. Let's say we have a container within a container within a container. The getValuePointer() method should then open all those containers and return the pointer to the ultimate contents. It does so with the above recursion.

createPath

public org.apache.commons.jxpath.ri.model.NodePointer createPath(org.apache.commons.jxpath.JXPathContext context)
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Called by a child pointer when it needs to create a parent object. Must create an object described by this pointer and return a new pointer that properly describes the new object.

createPath

public org.apache.commons.jxpath.ri.model.NodePointer createPath(org.apache.commons.jxpath.JXPathContext context,
                                                                 java.lang.Object value)
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Called directly by JXPathContext. Must create path and set value.

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.

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.

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.

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 namespace)
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.

testNode

public boolean testNode(org.apache.commons.jxpath.ri.compiler.NodeTest nodeTest)
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Checks if this Pointer matches the supplied NodeTest.

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.

asPath

public java.lang.String asPath()
Returns an XPath that maps to this Pointer.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> apache >> commons >> jxpath >> ri >> model >> [ beans overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.apache.commons.jxpath.ri.model.beans.CollectionPointer JAVADOC | Sourc code of org.apache.commons.jxpath.ri.model.beans.CollectionPointer SOURCE | Download org.apache.commons.jxpath.ri.model.beans.CollectionPointer DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD