org.apache.commons.jxpath.ri.model.dom
Class NamespacePointer

java.lang.Object
  org.apache.commons.jxpath.ri.model.NodePointer
      org.apache.commons.jxpath.ri.model.dom.NamespacePointer

All Implemented Interfaces:

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

public class NamespacePointer

extends NodePointer

Represents a namespace node.

Version:

$Revision: 1.13 $ $Date: 2004/04/01 02:55:32 $

Author:

Dmitri Plotnikov

See Also:

Serialized Form

Field Summary

private java.lang.String	namespaceURI
private java.lang.String	prefix

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

index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION

Constructor Summary

NamespacePointer(NodePointer parent, java.lang.String prefix)

NamespacePointer(NodePointer parent, java.lang.String prefix, java.lang.String namespaceURI)

Method Summary

java.lang.String	asPath() Returns an XPath that maps to this Pointer.
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.
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.String	getNamespaceURI() Returns the namespace URI associated with this Pointer.
int	hashCode()
boolean	isCollection() Returns true if the value of the pointer is an array or a Collection.
boolean	isLeaf() If true, this node does not have children
void	setValue(java.lang.Object value) Throws UnsupportedOperationException.
boolean	testNode(NodeTest nodeTest) Checks if this Pointer matches the supplied NodeTest.

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

attributeIterator, childIterator, clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isActual, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setIndex, setNamespaceResolver, toString

Methods inherited from class java.lang.Object

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

Field Detail

prefix

private java.lang.String prefix

namespaceURI

private java.lang.String namespaceURI

Constructor Detail

NamespacePointer

public NamespacePointer(NodePointer parent,
                        java.lang.String prefix)

NamespacePointer

public NamespacePointer(NodePointer parent,
                        java.lang.String prefix,
                        java.lang.String namespaceURI)

Method Detail

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

isCollection

public boolean isCollection()

Description copied from class: NodePointer

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

Specified by:

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

Specified by:

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

Specified by:

getImmediateNode in class NodePointer

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from class: NodePointer

Returns the namespace URI associated with this Pointer.

Overrides:

getNamespaceURI in class NodePointer

isLeaf

public boolean isLeaf()

Description copied from class: NodePointer

If true, this node does not have children

Specified by:

isLeaf in class NodePointer

setValue

public void setValue(java.lang.Object value)

Throws UnsupportedOperationException.

Specified by:

setValue in interface Pointer

Specified by:

setValue 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

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

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object object)

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