|
||||||||||
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.VariablePointer
public class VariablePointer
Pointer to a context variable.
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)
Create a new (non-actual) VariablePointer. |
|
VariablePointer(Variables variables,
QName name)
Create a new VariablePointer. |
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. |
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,
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,
Object value)
Called directly by JXPathContext. |
boolean |
equals(Object object)
|
protected void |
findVariables(JXPathContext context)
Assimilate the Variables instance associated with the specified context. |
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. |
int |
hashCode()
|
boolean |
isActual()
An actual pointer points to an existing part of an object graph, even if it is null. |
boolean |
isCollection()
Returns true if the value of the pointer is an array or
a Collection. |
boolean |
isContainer()
If true, this node is auxiliary and can only be used as an intermediate in the chain of pointers. |
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 name)
Returns a NodePointer for the specified namespace. |
void |
remove()
Remove the node of the object graph this pointer points to. |
void |
setIndex(int index)
Set the index of this NodePointer. |
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, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setNamespaceResolver, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public VariablePointer(Variables variables, QName name)
variables
- Variables instancename
- variable namepublic VariablePointer(QName name)
name
- variable nameMethod Detail |
---|
public boolean isContainer()
NodePointer
isContainer
in class NodePointer
public QName getName()
NodePointer
getName
in class NodePointer
public Object getBaseValue()
NodePointer
getBaseValue
in class NodePointer
public boolean isLeaf()
NodePointer
isLeaf
in class NodePointer
public boolean isCollection()
NodePointer
true
if the value of the pointer is an array or
a Collection.
isCollection
in class NodePointer
public Object getImmediateNode()
NodePointer
getImmediateNode
in class NodePointer
public void setValue(Object value)
NodePointer
setValue
in interface Pointer
setValue
in class NodePointer
value
- the value to setpublic boolean isActual()
NodePointer
isActual
in class NodePointer
public void setIndex(int index)
NodePointer
setIndex
in class NodePointer
index
- intpublic NodePointer getImmediateValuePointer()
getImmediateValuePointer
in class NodePointer
this
or a pointer
for the immediately contained value.NodePointer.getValuePointer()
public int getLength()
NodePointer
getLength
in class NodePointer
public NodePointer createPath(JXPathContext context, Object value)
NodePointer
createPath
in class NodePointer
context
- the owning JXPathContextvalue
- the new value to set
public NodePointer createPath(JXPathContext context)
NodePointer
createPath
in class NodePointer
context
- the owning JXPathContext
public NodePointer createChild(JXPathContext context, QName name, int index)
NodePointer
createChild
in class NodePointer
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.
public NodePointer createChild(JXPathContext context, QName name, int index, Object value)
NodePointer
createChild
in class NodePointer
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.value
- node value to set
public void remove()
NodePointer
remove
in class NodePointer
protected void findVariables(JXPathContext context)
context
- JXPathContext to searchpublic int hashCode()
hashCode
in class Object
public boolean equals(Object object)
equals
in class Object
public String asPath()
NodePointer
asPath
in interface Pointer
asPath
in class NodePointer
public NodeIterator childIterator(NodeTest test, boolean reverse, NodePointer startWith)
NodePointer
childIterator
in class NodePointer
test
- NodeTest to filter childrenreverse
- specified iteration directionstartWith
- the NodePointer to start with
public NodeIterator attributeIterator(QName name)
NodePointer
attributeIterator
in class NodePointer
name
- the attribute name to test
public NodeIterator namespaceIterator()
NodePointer
namespaceIterator
in class NodePointer
public NodePointer namespacePointer(String name)
NodePointer
namespacePointer
in class NodePointer
name
- incoming namespace
namespace
public boolean testNode(NodeTest nodeTest)
NodePointer
testNode
in class NodePointer
nodeTest
- the NodeTest to execute
public int compareChildNodePointers(NodePointer pointer1, NodePointer pointer2)
NodePointer
compareChildNodePointers
in class NodePointer
pointer1
- first pointer to be comparedpointer2
- second pointer to be compared
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |