org.apache.commons.jxpath.ri.model
Class VariablePointer

java.lang.Object
  |
  +--org.apache.commons.jxpath.ri.model.NodePointer
        |
        +--org.apache.commons.jxpath.ri.model.VariablePointer

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, Pointer

public class VariablePointer

extends NodePointer

Pointer to a context variable.

Version:

$Revision: 1.5 $ $Date: 2002/05/08 23:05:04 $

Author:

Dmitri Plotnikov

Field Summary

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

index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION

Constructor Summary

VariablePointer(QName name)

VariablePointer(Variables variables, QName name)

Method Summary

java.lang.String	asPath() Returns an XPath that maps to this Pointer.
NodeIterator	attributeIterator(QName name) Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard).
NodeIterator	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.
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, 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.
NodePointer	createPath(JXPathContext context) Called by a child pointer when it needs to create a parent object.
NodePointer	createPath(JXPathContext context, java.lang.Object value) Called directly by JXPathContext.
boolean	equals(java.lang.Object object)
protected void	findVariables(JXPathContext context)
java.lang.Object	getBaseValue() Returns the value represented by the pointer before indexing.
int	getLength() If the pointer represents a collection (or collection element), returns the length of the collection.
QName	getName() Returns the name of this node.
java.lang.Object	getNodeValue() Returns the object the pointer points to; does not convert it to a "canonical" type.
NodePointer	getValuePointer() If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents.
int	hashCode()
boolean	isActual() An actual pointer points to an existing part of an object graph, even if it is null.
boolean	isNode() If false, this node is axiliary and can only be used as an intermediate in the chain of pointers.
NodeIterator	namespaceIterator() Returns a NodeIterator that iterates over all namespaces of the value currently pointed at.
NodePointer	namespacePointer(java.lang.String name) Returns a NodePointer for the specified namespace.
void	remove() Remove the node of the object graph this pointer points to.
void	setValue(java.lang.Object value) Converts the value to the required type and changes the corresponding object to that value.
boolean	testNode(NodeTest nodeTest) Checks if this Pointer matches the supplied NodeTest.

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

clone, compareTo, getDefaultNamespaceURI, getExpandedName, getIndex, getLocale, getNamespaceURI, getNamespaceURI, getParent, getPointerByID, getPointerByKey, getValue, isCollection, isDefaultNamespace, isLanguage, isLeaf, isRoot, newChildNodePointer, newNodePointer, printPointerChain, setIndex, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VariablePointer

public VariablePointer(Variables variables,
                       QName name)

VariablePointer

public VariablePointer(QName name)

Method Detail

isNode

public boolean isNode()

Description copied from class: NodePointer

If false, this node is axiliary and can only be used as an intermediate in the chain of pointers.

Overrides:

isNode in class NodePointer

getName

public QName getName()

Description copied from class: NodePointer

Returns the name of this node. Can be null.

Specified by:

getName in class NodePointer

getBaseValue

public java.lang.Object 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 class NodePointer

getNodeValue

public java.lang.Object getNodeValue()

Description copied from class: NodePointer

Returns the object the pointer points to; does not convert it to a "canonical" type.

Specified by:

getNodeValue in class NodePointer

setValue

public void setValue(java.lang.Object value)

Description copied from class: NodePointer

Converts the value to the required type and changes the corresponding object to that value.

Specified by:

setValue in interface Pointer

Specified by:

setValue in class NodePointer

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 class NodePointer

getValuePointer

public NodePointer getValuePointer()

Description copied from class: NodePointer

If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents. Only an auxiliary (non-node) pointer can (and should) return a value pointer other than itself.

Overrides:

getValuePointer in class NodePointer

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).

Overrides:

getLength in class NodePointer

createPath

public NodePointer createPath(JXPathContext context,
                              java.lang.Object value)

Description copied from class: NodePointer

Called directly by JXPathContext. Must create path and set value.

Overrides:

createPath in class NodePointer

createPath

public NodePointer createPath(JXPathContext context)

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 class NodePointer

createChild

public NodePointer createChild(JXPathContext context,
                               QName name,
                               int index)

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 class NodePointer

createChild

public NodePointer createChild(JXPathContext context,
                               QName name,
                               int index,
                               java.lang.Object value)

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 must may have to expand the collection in order to assign the element.

Overrides:

createChild in class NodePointer

remove

public void remove()

Description copied from class: NodePointer

Remove the node of the object graph this pointer points to.

Overrides:

remove in class NodePointer

findVariables

protected void findVariables(JXPathContext context)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

asPath

public java.lang.String asPath()

Description copied from class: NodePointer

Returns an XPath that maps to this Pointer.

Specified by:

asPath in interface Pointer

Overrides:

asPath in class NodePointer

childIterator

public NodeIterator childIterator(NodeTest test,
                                  boolean reverse,
                                  NodePointer startWith)

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 class NodePointer

attributeIterator

public NodeIterator attributeIterator(QName name)

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 class NodePointer

namespaceIterator

public 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 class NodePointer

namespacePointer

public NodePointer namespacePointer(java.lang.String name)

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 class NodePointer

testNode

public boolean testNode(NodeTest nodeTest)

Description copied from class: NodePointer

Checks if this Pointer matches the supplied NodeTest.

Overrides:

testNode in class NodePointer

compareChildNodePointers

public int compareChildNodePointers(NodePointer pointer1,
                                    NodePointer pointer2)

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 class NodePointer