Class JDOMAttributePointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.jdom.JDOMAttributePointer
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
,Pointer
A Pointer that points to a DOM node.
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
-
Constructor Summary
ConstructorsConstructorDescriptionJDOMAttributePointer
(NodePointer parent, Attribute attribute) Create a JDOMAttributePointer. -
Method Summary
Modifier and TypeMethodDescriptionasPath()
Returns an XPath that maps to this Pointer.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
Gets the value represented by the pointer before indexing.Returns the object the pointer points to; does not convert it to a "canonical" type.int
If the pointer represents a collection (or collection element), returns the length of the collection.getName()
Gets the name of this node.Returns the namespace URI associated with this Pointer.getValue()
By default, returnsgetNode()
, can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.int
hashCode()
boolean
isActual()
An actual pointer points to an existing part of an object graph, even if it is null.boolean
Returnstrue
if the value of the pointer is an array or a Collection.boolean
isLeaf()
If true, this node does not have childrenvoid
remove()
Remove the node of the object graph this pointer points to.void
Converts the value to the required type and changes the corresponding object to that value.Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
attributeIterator, childIterator, clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValuePointer, handle, handle, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setExceptionHandler, setIndex, setNamespaceResolver, testNode, toString, verify
-
Constructor Details
-
JDOMAttributePointer
Create a JDOMAttributePointer.- Parameters:
parent
- NodePointer parent.attribute
- JDOM Attribute.
-
-
Method Details
-
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
-
compareChildNodePointers
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
-
equals
-
getBaseValue
Description copied from class:NodePointer
Gets 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
-
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
-
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:
- the length.
-
getName
Description copied from class:NodePointer
Gets the name of this node. Can be null.- Specified by:
getName
in classNodePointer
- Returns:
- QName The name of this node. Can be null.
-
getNamespaceURI
Description copied from class:NodePointer
Returns the namespace URI associated with this Pointer.- Overrides:
getNamespaceURI
in classNodePointer
- Returns:
- String uri
-
getValue
Description copied from class:NodePointer
By default, returnsgetNode()
, can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.- Specified by:
getValue
in interfacePointer
- Overrides:
getValue
in classNodePointer
- Returns:
- Object value
-
hashCode
-
isActual
Description copied from class:NodePointer
An actual pointer points to an existing part of an object graph, even if it is null. A non-actual pointer represents a part that does not exist at all. For instance consider the pointer "/address/street". If both address and street are not null, the pointer is actual. If address is not null, but street is null, the pointer is still actual. If address is null, the pointer is not actual. (In JavaBeans) if address is not a property of the root bean, a Pointer for this path cannot be obtained at all - actual or otherwise.- Overrides:
isActual
in classNodePointer
- Returns:
- 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
-
isLeaf
Description copied from class:NodePointer
If true, this node does not have children- Specified by:
isLeaf
in classNodePointer
- Returns:
- boolean
-
remove
Description copied from class:NodePointer
Remove the node of the object graph this pointer points to.- Overrides:
remove
in classNodePointer
-
setValue
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
-