|
||||||||||
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
public abstract class NodePointer
Common superclass for Pointers of all kinds. A NodePointer maps to a deterministic XPath that represents the location of a node in an object graph. This XPath uses only simple axes: child, namespace and attribute and only simple, context-independent predicates.
Field Summary | |
---|---|
protected int |
index
Index for this NodePointer |
protected java.util.Locale |
locale
Locale |
protected NodePointer |
parent
Parent pointer |
static java.lang.String |
UNKNOWN_NAMESPACE
Constant to indicate unknown namespace |
static int |
WHOLE_COLLECTION
Whole collection index. |
Constructor Summary | |
---|---|
protected |
NodePointer(NodePointer parent)
Create a new NodePointer. |
protected |
NodePointer(NodePointer parent,
java.util.Locale locale)
Create a new NodePointer. |
Method Summary | |
---|---|
java.lang.String |
asPath()
Returns an XPath that maps to this Pointer. |
NodeIterator |
attributeIterator(QName qname)
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. |
java.lang.Object |
clone()
Clone this NodePointer. |
abstract 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. |
int |
compareTo(java.lang.Object object)
|
NodePointer |
createAttribute(JXPathContext context,
QName name)
Called to create a non-existing attribute |
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,
java.lang.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,
java.lang.Object value)
Called directly by JXPathContext. |
protected java.lang.String |
escape(java.lang.String string)
Return a string escaping single and double quotes. |
protected AbstractFactory |
getAbstractFactory(JXPathContext context)
Get the AbstractFactory associated with the specified JXPathContext. |
abstract java.lang.Object |
getBaseValue()
Returns the value represented by the pointer before indexing. |
protected java.lang.String |
getDefaultNamespaceURI()
Get the default ns uri |
abstract java.lang.Object |
getImmediateNode()
Returns the object the pointer points to; does not convert it to a "canonical" type. |
NodePointer |
getImmediateParentPointer()
Get the immediate parent pointer. |
NodePointer |
getImmediateValuePointer()
|
int |
getIndex()
If the pointer represents a collection, the index identifies an element of that collection. |
abstract int |
getLength()
If the pointer represents a collection (or collection element), returns the length of the collection. |
java.util.Locale |
getLocale()
If the Pointer has a parent, returns the parent's locale; otherwise returns the locale specified when this Pointer was created. |
abstract QName |
getName()
Returns the name of this node. |
NamespaceResolver |
getNamespaceResolver()
Get the NamespaceResolver associated with this NodePointer. |
java.lang.String |
getNamespaceURI()
Returns the namespace URI associated with this Pointer. |
java.lang.String |
getNamespaceURI(java.lang.String prefix)
Decodes a namespace prefix to the corresponding URI. |
java.lang.Object |
getNode()
Returns the object the pointer points to; does not convert it to a "canonical" type. |
NodeSet |
getNodeSetByKey(JXPathContext context,
java.lang.String key,
java.lang.Object value)
Find a NodeSet by key/value. |
java.lang.Object |
getNodeValue()
Deprecated. 1.1 Please use getNode() |
NodePointer |
getParent()
Get the parent pointer. |
Pointer |
getPointerByID(JXPathContext context,
java.lang.String id)
Locates a node by ID. |
Pointer |
getPointerByKey(JXPathContext context,
java.lang.String key,
java.lang.String value)
Locates a node by key and value. |
java.lang.Object |
getRootNode()
Get the root node. |
java.lang.Object |
getValue()
By default, returns getNode() , can be overridden to
return a "canonical" value, like for instance a DOM element should
return its string value. |
NodePointer |
getValuePointer()
If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents. |
boolean |
isActual()
An actual pointer points to an existing part of an object graph, even if it is null. |
boolean |
isAttribute()
Returns true if the pointer represents the "attribute::" axis. |
abstract 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. |
protected boolean |
isDefaultNamespace(java.lang.String prefix)
Returns true if the supplied prefix represents the default namespace in the context of the current node. |
boolean |
isLanguage(java.lang.String lang)
Check whether our locale matches the specified language. |
abstract boolean |
isLeaf()
If true, this node does not have children |
boolean |
isNode()
Deprecated. Please use !isContainer() |
boolean |
isRoot()
Returns true if this Pointer has no parent. |
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. |
static NodePointer |
newChildNodePointer(NodePointer parent,
QName name,
java.lang.Object bean)
Allocates an new child NodePointer by iterating through all installed NodePointerFactories until it finds one that can create a pointer. |
static NodePointer |
newNodePointer(QName name,
java.lang.Object bean,
java.util.Locale locale)
Allocates an entirely new NodePointer by iterating through all installed NodePointerFactories until it finds one that can create a pointer. |
void |
printPointerChain()
Print internal structure of a pointer for debugging |
void |
remove()
Remove the node of the object graph this pointer points to. |
void |
setAttribute(boolean attribute)
Set to true if the pointer represents the "attribute::" axis. |
void |
setIndex(int index)
Set the index of this NodePointer. |
void |
setNamespaceResolver(NamespaceResolver namespaceResolver)
Set the NamespaceResolver for this NodePointer. |
abstract void |
setValue(java.lang.Object value)
Converts the value to the required type and changes the corresponding object to that value. |
boolean |
testNode(NodeTest test)
Checks if this Pointer matches the supplied NodeTest. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int WHOLE_COLLECTION
public static final java.lang.String UNKNOWN_NAMESPACE
protected int index
protected NodePointer parent
protected java.util.Locale locale
Constructor Detail |
---|
protected NodePointer(NodePointer parent)
parent
- Pointerprotected NodePointer(NodePointer parent, java.util.Locale locale)
parent
- Pointerlocale
- LocaleMethod Detail |
---|
public static NodePointer newNodePointer(QName name, java.lang.Object bean, java.util.Locale locale)
name
- QNamebean
- Objectlocale
- Locale
public static NodePointer newChildNodePointer(NodePointer parent, QName name, java.lang.Object bean)
parent
- pointername
- QNamebean
- Object
public NamespaceResolver getNamespaceResolver()
public void setNamespaceResolver(NamespaceResolver namespaceResolver)
namespaceResolver
- NamespaceResolverpublic NodePointer getParent()
public NodePointer getImmediateParentPointer()
public void setAttribute(boolean attribute)
attribute
- booleanpublic boolean isAttribute()
public boolean isRoot()
public abstract boolean isLeaf()
public boolean isNode()
public boolean isContainer()
public int getIndex()
index
is WHOLE_COLLECTION
, which just means that the pointer
is not indexed at all.
Note: the index on NodePointer starts with 0, not 1.
public void setIndex(int index)
index
- intpublic abstract boolean isCollection()
true
if the value of the pointer is an array or
a Collection.
public abstract int getLength()
public java.lang.Object getValue()
getNode()
, can be overridden to
return a "canonical" value, like for instance a DOM element should
return its string value.
getValue
in interface Pointer
public NodePointer getValuePointer()
getValuePointer()
directly. Override the
getImmediateValuePointer()
method instead. The
getValuePointer()
method is calls
getImmediateValuePointer()
and, if the result is not
this
, invokes getValuePointer()
recursively.
The idea here is to open all nested containers. Let's say we have a
container within a container within a container. The
getValuePointer()
method should then open all those
containers and return the pointer to the ultimate contents. It does so
with the above recursion.
public NodePointer getImmediateValuePointer()
this
or a pointer
for the immediately contained value.getValuePointer()
public boolean isActual()
public abstract QName getName()
public abstract java.lang.Object getBaseValue()
public java.lang.Object getNodeValue()
public java.lang.Object getNode()
getNode
in interface Pointer
public java.lang.Object getRootNode()
getRootNode
in interface Pointer
public abstract java.lang.Object getImmediateNode()
public abstract void setValue(java.lang.Object value)
setValue
in interface Pointer
value
- the value to setpublic abstract int compareChildNodePointers(NodePointer pointer1, NodePointer pointer2)
pointer1
- first pointer to be comparedpointer2
- second pointer to be compared
public boolean testNode(NodeTest test)
test
- the NodeTest to execute
public NodePointer createPath(JXPathContext context, java.lang.Object value)
context
- the owning JXPathContextvalue
- the new value to set
public void remove()
public NodePointer createPath(JXPathContext context)
context
- the owning JXPathContext
public NodePointer createChild(JXPathContext context, QName name, int index, java.lang.Object value)
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.value
- node value to set
public NodePointer createChild(JXPathContext context, QName name, int index)
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.
public NodePointer createAttribute(JXPathContext context, QName name)
context
- the owning JXPathCOntextname
- the QName at which an attribute should be created
public java.util.Locale getLocale()
public boolean isLanguage(java.lang.String lang)
lang
- String language to check
public NodeIterator childIterator(NodeTest test, boolean reverse, NodePointer startWith)
test
- NodeTest to filter childrenreverse
- specified iteration directionstartWith
- the NodePointer to start with
public NodeIterator attributeIterator(QName qname)
qname
- the attribute name to test
public NodeIterator namespaceIterator()
public NodePointer namespacePointer(java.lang.String namespace)
namespace
- incoming namespace
namespace
public java.lang.String getNamespaceURI(java.lang.String prefix)
prefix
- prefix to decode
public java.lang.String getNamespaceURI()
protected boolean isDefaultNamespace(java.lang.String prefix)
prefix
- the prefix to check
true
if prefix is defaultprotected java.lang.String getDefaultNamespaceURI()
public Pointer getPointerByID(JXPathContext context, java.lang.String id)
context
- JXPathContext owning contextid
- String id
public Pointer getPointerByKey(JXPathContext context, java.lang.String key, java.lang.String value)
context
- owning JXPathContextkey
- key to search forvalue
- value to match
public NodeSet getNodeSetByKey(JXPathContext context, java.lang.String key, java.lang.Object value)
context
- owning JXPathContextkey
- key to search forvalue
- value to match
public java.lang.String asPath()
asPath
in interface Pointer
public java.lang.Object clone()
clone
in interface Pointer
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public int compareTo(java.lang.Object object)
compareTo
in interface java.lang.Comparable
public void printPointerChain()
protected java.lang.String escape(java.lang.String string)
string
- string to treat
protected AbstractFactory getAbstractFactory(JXPathContext context)
context
- JXPathContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |