|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.beans.PropertyPointer
public abstract class PropertyPointer
A pointer allocated by a PropertyOwnerPointer to represent the value of a property of the parent object.
| Field Summary | |
|---|---|
protected Object |
bean
owning object |
protected int |
propertyIndex
property index |
static int |
UNSPECIFIED_PROPERTY
|
| Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer |
|---|
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION |
| Constructor Summary | |
|---|---|
PropertyPointer(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(NodePointer pointer1,
NodePointer pointer2)
Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers. |
NodePointer |
createChild(JXPathContext context,
QName name,
int index)
Called by a child pointer when it needs to create a parent object for a non-existent collection element. |
NodePointer |
createChild(JXPathContext context,
QName name,
int index,
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. |
NodePointer |
createPath(JXPathContext context)
Called by a child pointer when it needs to create a parent object. |
NodePointer |
createPath(JXPathContext context,
Object value)
Called directly by JXPathContext. |
boolean |
equals(Object object)
|
Object |
getBean()
Get the parent bean. |
Object |
getImmediateNode()
Returns the object the pointer points to; does not convert it to a "canonical" type. |
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. |
QName |
getName()
Returns the name of this node. |
abstract int |
getPropertyCount()
Count the number of properties represented. |
int |
getPropertyIndex()
Get the property index. |
abstract String |
getPropertyName()
Get the property name. |
abstract String[] |
getPropertyNames()
Get the names of the included properties. |
int |
hashCode()
|
boolean |
isActual()
An actual pointer points to an existing part of an object graph, even if it is null. |
protected abstract boolean |
isActualProperty()
Learn whether this pointer references an actual property. |
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)
Set the property index. |
abstract void |
setPropertyName(String propertyName)
Set the property name. |
| Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer |
|---|
asPath, attributeIterator, childIterator, clone, compareTo, createAttribute, escape, getAbstractFactory, getBaseValue, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, 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 |
|---|
public static final int UNSPECIFIED_PROPERTY
protected int propertyIndex
protected Object bean
| Constructor Detail |
|---|
public PropertyPointer(NodePointer parent)
parent - parent pointer| Method Detail |
|---|
public int getPropertyIndex()
public void setPropertyIndex(int index)
index - property indexpublic Object getBean()
public QName getName()
NodePointer
getName in class NodePointerpublic abstract String getPropertyName()
public abstract void setPropertyName(String propertyName)
propertyName - property name to set.public abstract int getPropertyCount()
public abstract String[] getPropertyNames()
protected abstract boolean isActualProperty()
public boolean isActual()
NodePointer
isActual in class NodePointerpublic Object getImmediateNode()
NodePointer
getImmediateNode in class NodePointerpublic boolean isCollection()
NodePointertrue if the value of the pointer is an array or
a Collection.
isCollection in class NodePointerpublic boolean isLeaf()
NodePointer
isLeaf in class NodePointerpublic int getLength()
getLength in class NodePointerpublic NodePointer getImmediateValuePointer()
getImmediateValuePointer in class NodePointerNodePointer.getValuePointer()public NodePointer createPath(JXPathContext context)
NodePointer
createPath in class NodePointercontext - the owning JXPathContext
public NodePointer createPath(JXPathContext context,
Object value)
NodePointer
createPath in class NodePointercontext - the owning JXPathContextvalue - the new value to set
public NodePointer createChild(JXPathContext context,
QName name,
int index,
Object value)
NodePointer
createChild in class NodePointercontext - the owning JXPathCOntextname - the QName at which a child should be createdindex - child index.value - node value to set
public NodePointer createChild(JXPathContext context,
QName name,
int index)
NodePointer
createChild in class NodePointercontext - the owning JXPathCOntextname - the QName at which a child should be createdindex - child index.
public int hashCode()
hashCode in class Objectpublic boolean equals(Object object)
equals in class Object
public int compareChildNodePointers(NodePointer pointer1,
NodePointer pointer2)
NodePointer
compareChildNodePointers in class NodePointerpointer1 - first pointer to be comparedpointer2 - second pointer to be compared
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||