Class PropertyOwnerPointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer
- All Implemented Interfaces:
Serializable,Cloneable,Comparable,Pointer
- Direct Known Subclasses:
BeanPointer,DynaBeanPointer,DynamicPointer,NullPointer
A pointer describing a node that has properties, each of which could be a collection.
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPropertyOwnerPointer(NodePointer parent) Constructs a new PropertyOwnerPointer.protectedPropertyOwnerPointer(NodePointer parent, Locale locale) Constructs a new PropertyOwnerPointer. -
Method Summary
Modifier and TypeMethodDescriptionattributeIterator(QName qName) Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard).childIterator(NodeTest test, boolean reverse, NodePointer startWith) Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.intcompareChildNodePointers(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.createNodeIterator(String property, boolean reverse, NodePointer startWith) Create a NodeIterator.Returns the object the pointer points to; does not convert it to a "canonical" type.abstract QNamegetName()Gets the name of this node.abstract PropertyPointerGets a PropertyPointer for this PropertyOwnerPointer.booleanTests whether dynamic property declaration is supported.booleanisValidProperty(QName qName) Tests whethernameis a valid child name for this PropertyOwnerPointer.voidremove()If this is a root node pointer, throws an exception; otherwise forwards the call to the parent node.voidsetIndex(int index) Sets the index of this NodePointer.voidThrows an exception if you try to change the root element, otherwise forwards the call to the parent pointer.Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
asPath, clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, escape, getAbstractFactory, getBaseValue, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLength, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, handle, handle, isActual, isAttribute, isCollection, isContainer, isDefaultNamespace, isLanguage, isLeaf, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setExceptionHandler, setNamespaceResolver, testNode, toString, verify
-
Constructor Details
-
PropertyOwnerPointer
Constructs a new PropertyOwnerPointer.- Parameters:
parent- pointer
-
PropertyOwnerPointer
Constructs a new PropertyOwnerPointer.- Parameters:
parent- parent pointerlocale- Locale
-
-
Method Details
-
attributeIterator
Description copied from class:NodePointerReturns 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.- Overrides:
attributeIteratorin classNodePointer- Parameters:
qName- the attribute name to test- Returns:
- NodeIterator
-
childIterator
Description copied from class:NodePointerReturns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.- Overrides:
childIteratorin classNodePointer- Parameters:
test- NodeTest to filter childrenreverse- specified iteration directionstartWith- the NodePointer to start with- Returns:
- NodeIterator
-
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
-
createNodeIterator
Create a NodeIterator.- Parameters:
property- property namereverse- whether to iterate in reversestartWith- first pointer to return- Returns:
- NodeIterator
-
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
-
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.
-
getPropertyPointer
Gets a PropertyPointer for this PropertyOwnerPointer.- Returns:
- PropertyPointer
-
isDynamicPropertyDeclarationSupported
Tests whether dynamic property declaration is supported.- Returns:
- true if the property owner can set a property "does not exist". A good example is a Map. You can always assign a value to any key even if it has never been "declared".
-
isValidProperty
Tests whethernameis a valid child name for this PropertyOwnerPointer.- Parameters:
qName- the QName to test- Returns:
trueifQNameis a valid property name.- Since:
- JXPath 1.3
-
remove
If this is a root node pointer, throws an exception; otherwise forwards the call to the parent node.- Overrides:
removein classNodePointer
-
setIndex
Description copied from class:NodePointerSets the index of this NodePointer.- Overrides:
setIndexin classNodePointer- Parameters:
index- int
-
setValue
Throws an exception if you try to change the root element, otherwise forwards the call to the parent pointer.- Specified by:
setValuein interfacePointer- Specified by:
setValuein classNodePointer- Parameters:
value- to set
-