org.apache.commons.jxpath.ri.model.container
Class ContainerPointer

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

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, Pointer, java.io.Serializable

public class ContainerPointer

extends NodePointer

Transparent pointer to a Container. The getValue() method returns the contents of the container, rather than the container itself.

Version:

$Revision: 1.9 $ $Date: 2003/03/11 00:59:26 $

Author:

Dmitri Plotnikov

See Also:

Serialized Form

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

index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION

Constructor Summary

ContainerPointer(Container container, java.util.Locale locale)

ContainerPointer(NodePointer parent, Container container)

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.
boolean	equals(java.lang.Object object)
java.lang.Object	getBaseValue() Returns the value represented by the pointer before indexing.
java.lang.Object	getImmediateNode() Returns the object the pointer points to; does not convert it to a "canonical" type.
NodePointer	getImmediateValuePointer()
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.
int	hashCode()
boolean	isCollection() Returns true if the value of the pointer is an array or a Collection.
boolean	isContainer() This type of node is auxiliary.
boolean	isLeaf() If true, this node does not have children
NodeIterator	namespaceIterator() Returns a NodeIterator that iterates over all namespaces of the value currently pointed at.
NodePointer	namespacePointer(java.lang.String namespace) Returns a NodePointer for the specified namespace.
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, createAttribute, createChild, createChild, createPath, createPath, getDefaultNamespaceURI, getExpandedName, getIndex, getLocale, getNamespaceURI, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isActual, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setIndex, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerPointer

public ContainerPointer(Container container,
                        java.util.Locale locale)

ContainerPointer

public ContainerPointer(NodePointer parent,
                        Container container)

Method Detail

isContainer

public boolean isContainer()

This type of node is auxiliary.

Overrides:

isContainer in class NodePointer

getName

public QName getName()

Description copied from class: NodePointer

Returns the name of this node. Can be null.

Overrides:

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.

Overrides:

getBaseValue in class NodePointer

isCollection

public boolean isCollection()

Description copied from class: NodePointer

Returns true if the value of the pointer is an array or a Collection.

Overrides:

isCollection 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

isLeaf

public boolean isLeaf()

Description copied from class: NodePointer

If true, this node does not have children

Overrides:

isLeaf in class NodePointer

getImmediateNode

public java.lang.Object getImmediateNode()

Description copied from class: NodePointer

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

Overrides:

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

Overrides:

setValue in class NodePointer

getImmediateValuePointer

public NodePointer getImmediateValuePointer()

Overrides:

getImmediateValuePointer in class NodePointer

Following copied from class: org.apache.commons.jxpath.ri.model.NodePointer

Returns:

NodePointer is either this or a pointer for the immediately contained value.

See Also:

NodePointer.getValuePointer()

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

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

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.

Overrides:

compareChildNodePointers in class NodePointer

asPath

public java.lang.String asPath()

Description copied from class: NodePointer

Returns an XPath that maps to this Pointer.

Overrides:

asPath in class NodePointer