|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.container.ContainerPointer
public class ContainerPointer
Transparent pointer to a Container. The NodePointer.getValue() method
returns the contents of the container, rather than the container
itself.
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer |
|---|
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION |
| Constructor Summary | |
|---|---|
ContainerPointer(Container container,
Locale locale)
Create a new ContainerPointer. |
|
ContainerPointer(NodePointer parent,
Container container)
Create a new ContainerPointer. |
|
| Method Summary | |
|---|---|
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(Object object)
|
Object |
getBaseValue()
Returns the value represented by the pointer before indexing. |
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. |
String |
getNamespaceURI(String prefix)
Decodes a namespace prefix to the corresponding URI. |
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(String namespace)
Returns a NodePointer for the specified namespace. |
void |
setValue(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 |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ContainerPointer(Container container,
Locale locale)
container - Container objectlocale - Locale
public ContainerPointer(NodePointer parent,
Container container)
parent - parent pointercontainer - Container object| Method Detail |
|---|
public boolean isContainer()
isContainer in class NodePointertrue.public QName getName()
NodePointer
getName in class NodePointerpublic Object getBaseValue()
NodePointer
getBaseValue in class NodePointerpublic boolean isCollection()
NodePointertrue if the value of the pointer is an array or
a Collection.
isCollection in class NodePointerpublic int getLength()
NodePointer
getLength in class NodePointerpublic boolean isLeaf()
NodePointer
isLeaf in class NodePointerpublic Object getImmediateNode()
NodePointer
getImmediateNode in class NodePointerpublic void setValue(Object value)
NodePointer
setValue in interface PointersetValue in class NodePointervalue - the value to setpublic NodePointer getImmediateValuePointer()
getImmediateValuePointer in class NodePointerthis or a pointer
for the immediately contained value.NodePointer.getValuePointer()public int hashCode()
hashCode in class Objectpublic boolean equals(Object object)
equals in class Object
public NodeIterator childIterator(NodeTest test,
boolean reverse,
NodePointer startWith)
NodePointer
childIterator in class NodePointertest - NodeTest to filter childrenreverse - specified iteration directionstartWith - the NodePointer to start with
public NodeIterator attributeIterator(QName name)
NodePointer
attributeIterator in class NodePointername - the attribute name to test
public NodeIterator namespaceIterator()
NodePointer
namespaceIterator in class NodePointerpublic NodePointer namespacePointer(String namespace)
NodePointer
namespacePointer in class NodePointernamespace - incoming namespace
namespacepublic boolean testNode(NodeTest nodeTest)
NodePointer
testNode in class NodePointernodeTest - the NodeTest to execute
public int compareChildNodePointers(NodePointer pointer1,
NodePointer pointer2)
NodePointer
compareChildNodePointers in class NodePointerpointer1 - first pointer to be comparedpointer2 - second pointer to be compared
public String getNamespaceURI(String prefix)
NodePointer
getNamespaceURI in class NodePointerprefix - prefix to decode
public String asPath()
NodePointer
asPath in interface PointerasPath in class NodePointer
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||