Class PropertyPointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.beans.PropertyPointer
- All Implemented Interfaces:
Serializable,Cloneable,Comparable,Pointer
- Direct Known Subclasses:
BeanPropertyPointer,DynaBeanPropertyPointer,DynamicPropertyPointer,NullPropertyPointer
A pointer allocated by a PropertyOwnerPointer to represent the value of a property of the parent object.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ObjectOwning objectprotected intProperty indexstatic final intMarks a property as unspecified.Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION -
Constructor Summary
ConstructorsConstructorDescriptionPropertyPointer(NodePointer parent) Takes a JavaBean, a descriptor of a property of that object and an offset within that property (starting with 0). -
Method Summary
Modifier and TypeMethodDescriptionintcompareChildNodePointers(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.createChild(JXPathContext context, QName qName, int index) Called by a child pointer when it needs to create a parent object for a non-existent collection element.createChild(JXPathContext context, QName qName, 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.createPath(JXPathContext context) Called by a child pointer when it needs to create a parent object.createPath(JXPathContext context, Object value) Called directly by JXPathContext.booleangetBean()Gets the parent bean.Returns the object the pointer points to; does not convert it to a "canonical" type.Returns a NodePointer that can be used to access the currently selected property value.intIf the property contains a collection, then the length of that collection, otherwise - 1.getName()Gets the name of this node.abstract intCount the number of properties represented.intGets the property index.abstract StringGets the property name.abstract String[]Gets the names of the included properties.inthashCode()booleanisActual()An actual pointer points to an existing part of an object graph, even if it is null.protected abstract booleanTests whether this pointer references an actual property.booleanReturnstrueif the value of the pointer is an array or a Collection.booleanisLeaf()If true, this node does not have childrenvoidsetPropertyIndex(int index) Sets the property index.abstract voidsetPropertyName(String propertyName) Sets 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, handle, handle, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setExceptionHandler, setIndex, setNamespaceResolver, setValue, testNode, toString, verify
-
Field Details
-
UNSPECIFIED_PROPERTY
Marks a property as unspecified.- See Also:
-
propertyIndex
Property index -
bean
Owning object
-
-
Constructor Details
-
PropertyPointer
Takes a JavaBean, a descriptor of a property of that object and an offset within that property (starting with 0).- Parameters:
parent- parent pointer
-
-
Method Details
-
compareChildNodePointers
Description copied from class:NodePointerCompares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.- Specified by:
compareChildNodePointersin classNodePointer- Parameters:
pointer1- first pointer to be comparedpointer2- second pointer to be compared- Returns:
- int per Java comparison conventions
-
createChild
Description copied from class:NodePointerCalled 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:
createChildin classNodePointer- Parameters:
context- the owning JXPathCOntextqName- the QName at which a child should be createdindex- child index.- Returns:
- created NodePointer
-
createChild
Description copied from class:NodePointerCalled 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:
createChildin classNodePointer- Parameters:
context- the owning JXPathCOntextqName- the QName at which a child should be createdindex- child index.value- node value to set- Returns:
- created NodePointer
-
createPath
Description copied from class:NodePointerCalled 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.- Overrides:
createPathin classNodePointer- Parameters:
context- the owning JXPathContext- Returns:
- created NodePointer
-
createPath
Description copied from class:NodePointerCalled directly by JXPathContext. Must create path and set value.- Overrides:
createPathin classNodePointer- Parameters:
context- the owning JXPathContextvalue- the new value to set- Returns:
- created NodePointer
-
equals
-
getBean
Gets the parent bean.- Returns:
- Object
-
getImmediateNode
Description copied from class:NodePointerReturns the object the pointer points to; does not convert it to a "canonical" type.- Specified by:
getImmediateNodein classNodePointer- Returns:
- Object node
-
getImmediateValuePointer
Returns a NodePointer that can be used to access the currently selected property value.- Overrides:
getImmediateValuePointerin classNodePointer- Returns:
- NodePointer
- See Also:
-
getLength
If the property contains a collection, then the length of that collection, otherwise - 1.- Specified by:
getLengthin classNodePointer- Returns:
- int length
-
getName
Description copied from class:NodePointerGets the name of this node. Can be null.- Specified by:
getNamein classNodePointer- Returns:
- QName The name of this node. Can be null.
-
getPropertyCount
Count the number of properties represented.- Returns:
- int
-
getPropertyIndex
Gets the property index.- Returns:
- int index
-
getPropertyName
Gets the property name.- Returns:
- String property name.
-
getPropertyNames
Gets the names of the included properties.- Returns:
- String[]
-
hashCode
-
isActual
Description copied from class:NodePointerAn 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:
isActualin classNodePointer- Returns:
- boolean
-
isActualProperty
Tests whether this pointer references an actual property.- Returns:
- true if actual
-
isCollection
Description copied from class:NodePointerReturnstrueif the value of the pointer is an array or a Collection.- Specified by:
isCollectionin classNodePointer- Returns:
- boolean
-
isLeaf
Description copied from class:NodePointerIf true, this node does not have children- Specified by:
isLeafin classNodePointer- Returns:
- boolean
-
setPropertyIndex
Sets the property index.- Parameters:
index- property index
-
setPropertyName
Sets the property name.- Parameters:
propertyName- property name to set.
-