Class VariablePointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.VariablePointer
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
,Pointer
Pointer to a context variable.
- Version:
- $Revision: 652884 $ $Date: 2008-05-02 15:02:00 -0500 (Fri, 02 May 2008) $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private QName
private static final long
private NodePointer
private Variables
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
-
Constructor Summary
ConstructorsConstructorDescriptionVariablePointer
(QName name) Create a new (non-actual) VariablePointer.VariablePointer
(Variables variables, QName name) Create a new VariablePointer. -
Method Summary
Modifier and TypeMethodDescriptionasPath()
Returns an XPath that maps to this Pointer.attributeIterator
(QName name) 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.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.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.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.private Object
createCollection
(JXPathContext context, int index) Create a collection.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.boolean
protected void
findVariables
(JXPathContext context) Assimilate the Variables instance associated with the specified context.Returns the value represented by the pointer before indexing.Returns the object the pointer points to; does not convert it to a "canonical" type.int
If the pointer represents a collection (or collection element), returns the length of the collection.getName()
Returns the name of this node.int
hashCode()
boolean
isActual()
An actual pointer points to an existing part of an object graph, even if it is null.boolean
Returnstrue
if the value of the pointer is an array or a Collection.boolean
If true, this node is auxiliary and can only be used as an intermediate in the chain of pointers.boolean
isLeaf()
If true, this node does not have childrenReturns a NodeIterator that iterates over all namespaces of the value currently pointed at.namespacePointer
(String name) Returns a NodePointer for the specified namespace.void
remove()
Remove the node of the object graph this pointer points to.void
setIndex
(int index) Set the index of this NodePointer.void
Converts the value to the required type and changes the corresponding object to that value.boolean
Checks if this Pointer matches the supplied NodeTest.Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
clone, compareTo, createAttribute, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setNamespaceResolver, toString
-
Field Details
-
variables
-
name
-
valuePointer
-
actual
private boolean actual -
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
VariablePointer
Create a new VariablePointer.- Parameters:
variables
- Variables instancename
- variable name
-
VariablePointer
Create a new (non-actual) VariablePointer.- Parameters:
name
- variable name
-
-
Method Details
-
isContainer
public boolean isContainer()Description copied from class:NodePointer
If true, this node is auxiliary and can only be used as an intermediate in the chain of pointers.- Overrides:
isContainer
in classNodePointer
- Returns:
- boolean
-
getName
Description copied from class:NodePointer
Returns the name of this node. Can be null.- Specified by:
getName
in classNodePointer
- Returns:
- QName
-
getBaseValue
Description copied from class: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.- Specified by:
getBaseValue
in classNodePointer
- Returns:
- Object value
-
isLeaf
public boolean isLeaf()Description copied from class:NodePointer
If true, this node does not have children- Specified by:
isLeaf
in classNodePointer
- Returns:
- boolean
-
isCollection
public boolean isCollection()Description copied from class:NodePointer
Returnstrue
if the value of the pointer is an array or a Collection.- Specified by:
isCollection
in classNodePointer
- Returns:
- boolean
-
getImmediateNode
Description copied from class:NodePointer
Returns the object the pointer points to; does not convert it to a "canonical" type.- Specified by:
getImmediateNode
in classNodePointer
- Returns:
- Object node
-
setValue
Description copied from class:NodePointer
Converts the value to the required type and changes the corresponding object to that value.- Specified by:
setValue
in interfacePointer
- Specified by:
setValue
in classNodePointer
- Parameters:
value
- the value to set
-
isActual
public boolean isActual()Description copied from class: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.- Overrides:
isActual
in classNodePointer
- Returns:
- boolean
-
setIndex
public void setIndex(int index) Description copied from class:NodePointer
Set the index of this NodePointer.- Overrides:
setIndex
in classNodePointer
- Parameters:
index
- int
-
getImmediateValuePointer
- Overrides:
getImmediateValuePointer
in classNodePointer
- Returns:
- NodePointer is either
this
or a pointer for the immediately contained value. - See Also:
-
getLength
public int getLength()Description copied from class: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).- Specified by:
getLength
in classNodePointer
- Returns:
- int
-
createPath
Description copied from class:NodePointer
Called directly by JXPathContext. Must create path and set value.- Overrides:
createPath
in classNodePointer
- Parameters:
context
- the owning JXPathContextvalue
- the new value to set- Returns:
- created NodePointer
-
createPath
Description copied from class: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.- Overrides:
createPath
in classNodePointer
- Parameters:
context
- the owning JXPathContext- Returns:
- created NodePointer
-
createChild
Description copied from class: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.- Overrides:
createChild
in classNodePointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.- Returns:
- created NodePointer
-
createChild
Description copied from class: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.- Overrides:
createChild
in classNodePointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.value
- node value to set- Returns:
- created NodePointer
-
createCollection
Create a collection.- Parameters:
context
- JXPathContextindex
- collection index- Returns:
- Object
-
remove
public void remove()Description copied from class:NodePointer
Remove the node of the object graph this pointer points to.- Overrides:
remove
in classNodePointer
-
findVariables
Assimilate the Variables instance associated with the specified context.- Parameters:
context
- JXPathContext to search
-
hashCode
public int hashCode() -
equals
-
asPath
Description copied from class:NodePointer
Returns an XPath that maps to this Pointer.- Specified by:
asPath
in interfacePointer
- Overrides:
asPath
in classNodePointer
- Returns:
- String xpath expression
-
childIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.- Overrides:
childIterator
in classNodePointer
- Parameters:
test
- NodeTest to filter childrenreverse
- specified iteration directionstartWith
- the NodePointer to start with- Returns:
- NodeIterator
-
attributeIterator
Description copied from class: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.- Overrides:
attributeIterator
in classNodePointer
- Parameters:
name
- the attribute name to test- Returns:
- NodeIterator
-
namespaceIterator
Description copied from class: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.- Overrides:
namespaceIterator
in classNodePointer
- Returns:
- NodeIterator
-
namespacePointer
Description copied from class: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.- Overrides:
namespacePointer
in classNodePointer
- Parameters:
name
- incoming namespace- Returns:
- NodePointer for
namespace
-
testNode
Description copied from class:NodePointer
Checks if this Pointer matches the supplied NodeTest.- Overrides:
testNode
in classNodePointer
- Parameters:
nodeTest
- the NodeTest to execute- Returns:
- true if a match
-
compareChildNodePointers
Description copied from class:NodePointer
Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.- Specified by:
compareChildNodePointers
in classNodePointer
- Parameters:
pointer1
- first pointer to be comparedpointer2
- second pointer to be compared- Returns:
- int per Java comparison conventions
-