Class ContainerPointer
- java.lang.Object
-
- org.apache.commons.jxpath.ri.model.NodePointer
-
- org.apache.commons.jxpath.ri.model.container.ContainerPointer
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable
,Pointer
public class ContainerPointer extends NodePointer
Transparent pointer to a Container. TheNodePointer.getValue()
method returns the contents of the container, rather than the container itself.- Version:
- $Revision: 652884 $ $Date: 2008-05-02 15:02:00 -0500 (Fri, 02 May 2008) $
- Author:
- Dmitri Plotnikov
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private Container
container
private static long
serialVersionUID
private NodePointer
valuePointer
-
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
-
-
Constructor Summary
Constructors Constructor Description ContainerPointer(Container container, java.util.Locale locale)
Create a new ContainerPointer.ContainerPointer(NodePointer parent, Container container)
Create a new ContainerPointer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.java.lang.String
getNamespaceURI(java.lang.String prefix)
Decodes a namespace prefix to the corresponding URI.int
hashCode()
boolean
isCollection()
Returnstrue
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 childrenNodeIterator
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, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isActual, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setIndex, setNamespaceResolver, toString
-
-
-
-
Field Detail
-
container
private Container container
-
valuePointer
private NodePointer valuePointer
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContainerPointer
public ContainerPointer(Container container, java.util.Locale locale)
Create a new ContainerPointer.- Parameters:
container
- Container objectlocale
- Locale
-
ContainerPointer
public ContainerPointer(NodePointer parent, Container container)
Create a new ContainerPointer.- Parameters:
parent
- parent pointercontainer
- Container object
-
-
Method Detail
-
isContainer
public boolean isContainer()
This type of node is auxiliary.- Overrides:
isContainer
in classNodePointer
- Returns:
true
.
-
getName
public QName getName()
Description copied from class:NodePointer
Returns the name of this node. Can be null.- Specified by:
getName
in classNodePointer
- Returns:
- QName
-
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 classNodePointer
- Returns:
- Object value
-
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
-
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
-
isLeaf
public boolean isLeaf()
Description copied from class:NodePointer
If true, this node does not have children- Specified by:
isLeaf
in classNodePointer
- Returns:
- boolean
-
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 classNodePointer
- Returns:
- Object node
-
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 interfacePointer
- Specified by:
setValue
in classNodePointer
- Parameters:
value
- the value to set
-
getImmediateValuePointer
public NodePointer getImmediateValuePointer()
- Overrides:
getImmediateValuePointer
in classNodePointer
- Returns:
- NodePointer is either
this
or a pointer for the immediately contained value. - See Also:
NodePointer.getValuePointer()
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in classjava.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 classNodePointer
- Parameters:
test
- NodeTest to filter childrenreverse
- specified iteration directionstartWith
- the NodePointer to start with- Returns:
- NodeIterator
-
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 classNodePointer
- Parameters:
name
- the attribute name to test- Returns:
- NodeIterator
-
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 classNodePointer
- Returns:
- NodeIterator
-
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 classNodePointer
- Parameters:
namespace
- incoming namespace- Returns:
- NodePointer for
namespace
-
testNode
public boolean testNode(NodeTest nodeTest)
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
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 classNodePointer
- Parameters:
pointer1
- first pointer to be comparedpointer2
- second pointer to be compared- Returns:
- int per Java comparison conventions
-
getNamespaceURI
public java.lang.String getNamespaceURI(java.lang.String prefix)
Description copied from class:NodePointer
Decodes a namespace prefix to the corresponding URI.- Overrides:
getNamespaceURI
in classNodePointer
- Parameters:
prefix
- prefix to decode- Returns:
- String uri
-
asPath
public java.lang.String 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
-
-