|
||||||||||
| 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.jdom.JDOMNodePointer
public class JDOMNodePointer
A Pointer that points to a DOM node.
| Field Summary | |
|---|---|
static String |
XML_NAMESPACE_URI
XML ns uri |
static String |
XMLNS_NAMESPACE_URI
XMLNS ns uri |
| Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer |
|---|
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION |
| Constructor Summary | |
|---|---|
JDOMNodePointer(NodePointer parent,
Object node)
Create a new JDOMNodePointer. |
|
JDOMNodePointer(Object node,
Locale locale)
Create a new JDOMNodePointer. |
|
JDOMNodePointer(Object node,
Locale locale,
String id)
Create a new JDOMNodePointer. |
|
| 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 |
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,
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. |
boolean |
equals(Object object)
|
protected static String |
findEnclosingAttribute(Object n,
String attrName,
Namespace ns)
Find the nearest occurrence of the specified attribute on the specified and enclosing elements. |
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. |
protected String |
getLanguage()
Get the language of this element. |
int |
getLength()
If the pointer represents a collection (or collection element), returns the length of the collection. |
static String |
getLocalName(Object node)
Get the local name of the specified node. |
QName |
getName()
Returns the name of this node. |
NamespaceResolver |
getNamespaceResolver()
Get the NamespaceResolver associated with this NodePointer. |
String |
getNamespaceURI()
Returns the namespace URI associated with this Pointer. |
String |
getNamespaceURI(String prefix)
Decodes a namespace prefix to the corresponding URI. |
static String |
getPrefix(Object node)
Get the prefix from a given node. |
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. |
int |
hashCode()
|
boolean |
isCollection()
Returns true if the value of the pointer is an array or
a Collection. |
boolean |
isLanguage(String lang)
Returns true if the xml:lang attribute for the current node or its parent has the specified prefix lang. |
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 prefix)
Returns a NodePointer for the specified namespace. |
void |
remove()
Remove the node of the object graph this pointer points to. |
void |
setValue(Object value)
Converts the value to the required type and changes the corresponding object to that value. |
static boolean |
testNode(NodePointer pointer,
Object node,
NodeTest test)
Execute test against node on behalf of pointer. |
boolean |
testNode(NodeTest test)
Checks if this Pointer matches the supplied NodeTest. |
| Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer |
|---|
clone, compareTo, createPath, createPath, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValuePointer, isActual, isAttribute, isContainer, isDefaultNamespace, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setIndex, setNamespaceResolver, toString |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String XML_NAMESPACE_URI
public static final String XMLNS_NAMESPACE_URI
| Constructor Detail |
|---|
public JDOMNodePointer(Object node,
Locale locale)
node - pointedlocale - Locale
public JDOMNodePointer(Object node,
Locale locale,
String id)
node - pointedlocale - Localeid - String id
public JDOMNodePointer(NodePointer parent,
Object node)
parent - NodePointernode - pointed| Method Detail |
|---|
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 prefix)
NodePointer
namespacePointer in class NodePointerprefix - incoming namespace
namespacepublic String getNamespaceURI()
NodePointer
getNamespaceURI in class NodePointerpublic NamespaceResolver getNamespaceResolver()
NodePointer
getNamespaceResolver in class NodePointerpublic String getNamespaceURI(String prefix)
NodePointer
getNamespaceURI in class NodePointerprefix - prefix to decode
public int compareChildNodePointers(NodePointer pointer1,
NodePointer pointer2)
NodePointer
compareChildNodePointers in class NodePointerpointer1 - first pointer to be comparedpointer2 - second pointer to be compared
public 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 QName getName()
NodePointer
getName in class NodePointerpublic Object getImmediateNode()
NodePointer
getImmediateNode in class NodePointerpublic Object getValue()
NodePointergetNode(), can be overridden to
return a "canonical" value, like for instance a DOM element should
return its string value.
getValue in interface PointergetValue in class NodePointerpublic void setValue(Object value)
NodePointer
setValue in interface PointersetValue in class NodePointervalue - the value to setpublic boolean testNode(NodeTest test)
NodePointer
testNode in class NodePointertest - the NodeTest to execute
public static boolean testNode(NodePointer pointer,
Object node,
NodeTest test)
pointer - Pointernode - to testtest - to execute
public static String getPrefix(Object node)
node - to check
public static String getLocalName(Object node)
node - to check
public boolean isLanguage(String lang)
super.isLanguage(lang).
isLanguage in class NodePointerlang - to compare
protected String getLanguage()
protected static String findEnclosingAttribute(Object n,
String attrName,
Namespace ns)
n - current nodeattrName - attribute namens - Namespace
public NodePointer createChild(JXPathContext context,
QName name,
int index)
NodePointer
createChild in class NodePointercontext - 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 NodePointercontext - the owning JXPathCOntextname - the QName at which a child should be createdindex - child index.value - node value to set
public NodePointer createAttribute(JXPathContext context,
QName name)
NodePointer
createAttribute in class NodePointercontext - the owning JXPathCOntextname - the QName at which an attribute should be created
public void remove()
NodePointer
remove in class NodePointerpublic String asPath()
NodePointer
asPath in interface PointerasPath in class NodePointerpublic int hashCode()
hashCode in class Objectpublic boolean equals(Object object)
equals in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||