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

---

org.apache.commons.jxpath.ri.model.beans
Class PropertyPointer  

java.lang.Object
  org.apache.commons.jxpath.ri.model.NodePointer
      org.apache.commons.jxpath.ri.model.beans.PropertyPointer

All Implemented Interfaces:

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

Direct Known Subclasses:

BeanPropertyPointer, NullPropertyPointer

---

public abstract class PropertyPointer

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

A pointer allocated by a PropertyOwnerPointer to represent the value of a property of the parent object.

Version:

$Revision: 1.14 $ $Date: 2004/04/04 22:06:36 $

---

Field Summary
protected  java.lang.Object	bean
protected  int	propertyIndex
private static java.lang.Object	UNINITIALIZED
static int	UNSPECIFIED_PROPERTY
private  java.lang.Object	value

 

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

index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION

 

Constructor Summary

PropertyPointer(org.apache.commons.jxpath.ri.model.NodePointer parent)           Takes a javabean, a descriptor of a property of that object and an offset within that property (starting with 0).

 

Method Summary
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.
private  org.apache.commons.jxpath.AbstractFactory	getAbstractFactory(org.apache.commons.jxpath.JXPathContext context)
java.lang.Object	getBean()
java.lang.Object	getImmediateNode()           Returns the object the pointer points to; does not convert it to a "canonical" type.
org.apache.commons.jxpath.ri.model.NodePointer	getImmediateValuePointer()           Returns a NodePointer that can be used to access the currently selected property value.
int	getLength()           If the property contains a collection, then the length of that collection, otherwise - 1.
org.apache.commons.jxpath.ri.QName	getName()           Returns the name of this node.
abstract  int	getPropertyCount()
int	getPropertyIndex()
abstract  java.lang.String	getPropertyName()
abstract  java.lang.String[]	getPropertyNames()
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	isActual()           An actual pointer points to an existing part of an object graph, even if it is null.
protected abstract  boolean	isActualProperty()
boolean	isCollection()           Returns true if the value of the pointer is an array or a Collection.
boolean	isLeaf()           If true, this node does not have children
void	setPropertyIndex(int index)
abstract  void	setPropertyName(java.lang.String propertyName)

 

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

asPath, attributeIterator, childIterator, clone, compareTo, createAttribute, getBaseValue, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setIndex, setNamespaceResolver, setValue, testNode, toString

 

Methods inherited from class java.lang.Object

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

 

Field Detail

UNSPECIFIED_PROPERTY

public static final int UNSPECIFIED_PROPERTY

See Also:

Constant Field Values

---

propertyIndex

protected int propertyIndex

---

bean

protected java.lang.Object bean

---

UNINITIALIZED

private static final java.lang.Object UNINITIALIZED

---

value

private java.lang.Object value

Constructor Detail

PropertyPointer

public PropertyPointer(org.apache.commons.jxpath.ri.model.NodePointer parent)

Takes a javabean, a descriptor of a property of that object and an offset within that property (starting with 0).

Method Detail

getPropertyIndex

public int getPropertyIndex()

---

setPropertyIndex

public void setPropertyIndex(int index)

---

getBean

public java.lang.Object getBean()

---

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.

---

getPropertyName

public abstract java.lang.String getPropertyName()

---

setPropertyName

public abstract void setPropertyName(java.lang.String propertyName)

---

getPropertyCount

public abstract int getPropertyCount()

---

getPropertyNames

public abstract java.lang.String[] getPropertyNames()

---

isActualProperty

protected abstract boolean isActualProperty()

---

isActual

public boolean isActual()

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

---

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.

---

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.

---

isLeaf

public boolean isLeaf()

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

If true, this node does not have children

---

getLength

public int getLength()

If the property contains a collection, then the length of that collection, otherwise - 1.

---

getImmediateValuePointer

public org.apache.commons.jxpath.ri.model.NodePointer getImmediateValuePointer()

Returns a NodePointer that can be used to access the currently selected property value.

---

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.

---

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.

---

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 >> [ beans overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---