public class AxiomAttributeWrapper extends java.lang.Object implements NodeInfo, VirtualNode, SiblingCountingNode
This is the implementation of the NodeInfo interface used as a wrapper for Axiom nodes.
Note that in Axiom, an OMAttribute is not an OMNode. Therefore, we need a separate class AttributeWrapper for attribute nodes.
Modifier and Type | Field and Description |
---|---|
protected int |
index |
protected org.apache.axiom.om.OMAttribute |
node |
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Modifier | Constructor and Description |
---|---|
protected |
AxiomAttributeWrapper(org.apache.axiom.om.OMAttribute node,
AxiomParentNodeWrapper parent,
int index)
This constructor is protected: nodes should be created using the wrap
factory method on the DocumentWrapper class
|
Modifier and Type | Method and Description |
---|---|
AtomicSequence |
atomize()
Get the typed value.
|
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in
document order.
|
int |
comparePosition(NodeInfo other)
Determine the relative position of this node and another node, in document order,
distinguishing whether the first node is a preceding, following, descendant, ancestor,
or the same node as the second.
|
void |
copy(Receiver out,
int copyOptions,
Location locationId)
Copy this node to a given outputter (deep copy)
|
boolean |
equals(java.lang.Object other)
The equals() method compares nodes for identity.
|
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
java.lang.String |
getAttributeValue(java.lang.String uri,
java.lang.String local)
Get the string value of a given attribute of this node
|
java.lang.String |
getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a
relative URI contained in the node.
|
int |
getColumnNumber()
Get column number
|
Configuration |
getConfiguration()
Get the configuration
|
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
java.lang.String |
getDisplayName()
Get the display name of this node.
|
int |
getFingerprint()
Get fingerprint.
|
int |
getLineNumber()
Get line number
|
java.lang.String |
getLocalPart()
Get the local part of the name of this node.
|
int |
getNodeKind()
Return the type of node.
|
NodeInfo |
getParent()
Get the NodeInfo object representing the parent of this node
|
java.lang.String |
getPrefix()
Get the prefix of the name of the node.
|
java.lang.String |
getPublicId()
Get the Public ID of the entity containing the node.
|
java.lang.Object |
getRealNode()
Get the node underlying this virtual node.
|
NodeInfo |
getRoot()
Get the root node of the tree containing this node
|
SchemaType |
getSchemaType()
Get the type annotation of this node, if any.
|
int |
getSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
|
java.lang.String |
getStringValue()
Return the string value of the node.
|
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence.
|
java.lang.String |
getSystemId()
Get the System ID for the node.
|
TreeInfo |
getTreeInfo()
Get information about the tree to which this NodeInfo belongs
|
java.lang.Object |
getUnderlyingNode()
Get the underlying Axiom node, to implement the VirtualNode interface
|
java.lang.String |
getURI()
Get the URI part of the name of this node.
|
boolean |
hasChildNodes()
Determine whether the node has any children.
|
boolean |
hasFingerprint()
Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the
node in the NamePool.
|
int |
hashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal
(represent the same node) then they must have the same hashCode()
|
NodeInfo |
head()
To implement
Sequence , this method returns the item itself |
boolean |
isId()
Determine whether this node has the is-id property
|
boolean |
isIdref()
Determine whether this node has the is-idref property
|
boolean |
isNilled()
Determine whether the node has the is-nilled property
|
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
boolean |
isStreamed()
Ask whether this is a node in a streamed document
|
SequenceIterator |
iterate()
To implement
Sequence , this method returns a singleton iterator
that delivers this item in the form of a sequence |
AxisIterator |
iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this
node
|
AxisIterator |
iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this
node
|
Location |
saveLocation()
Get an immutable copy of this Location object.
|
void |
setSystemId(java.lang.String uri) |
protected AxiomAttributeWrapper(org.apache.axiom.om.OMAttribute node, AxiomParentNodeWrapper parent, int index)
node
- The Axiom attribute node to be wrappedparent
- The NodeWrapper that wraps the parent of this attribute nodeindex
- Position of this node among its siblingspublic TreeInfo getTreeInfo()
getTreeInfo
in interface NodeInfo
public SequenceIterator iterate()
Sequence
, this method returns a singleton iterator
that delivers this item in the form of a sequencepublic Configuration getConfiguration()
getConfiguration
in interface NodeInfo
public java.lang.Object getUnderlyingNode()
getUnderlyingNode
in interface VirtualNode
public java.lang.Object getRealNode()
getRealNode
in interface VirtualNode
public int getFingerprint()
getFingerprint
in interface NodeInfo
java.lang.UnsupportedOperationException
- if this kind of node does not hold
namepool fingerprints (specifically, if hasFingerprint()
returns false).public boolean hasFingerprint()
getFingerprint()
method must
return the fingerprint of the node. If the answer is false, then the getFingerprint()
method should throw an UnsupportedOperationException
. In the case of unnamed nodes
such as text nodes, the result can be either true (in which case getFingerprint() should
return -1) or false (in which case getFingerprint may throw an exception).hasFingerprint
in interface NodeInfo
FingerprintedNode
as a marker interface.public int getNodeKind()
getNodeKind
in interface NodeInfo
Type
public AtomicSequence atomize()
atomize
in interface Item
atomize
in interface NodeInfo
public SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType
in interface NodeInfo
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
other
- the node to be compared with this nodepublic boolean equals(java.lang.Object other)
equals
in interface NodeInfo
equals
in class java.lang.Object
other
- the node to be compared with this nodepublic int hashCode()
hashCode
in interface NodeInfo
hashCode
in class java.lang.Object
public java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Source
getSystemId
in interface javax.xml.transform.SourceLocator
getSystemId
in interface Location
getSystemId
in interface NodeInfo
getSystemId
in interface org.xml.sax.Locator
public void setSystemId(java.lang.String uri)
setSystemId
in interface javax.xml.transform.Source
public java.lang.String getPublicId()
getPublicId
in interface javax.xml.transform.SourceLocator
getPublicId
in interface Location
getPublicId
in interface NodeInfo
getPublicId
in interface org.xml.sax.Locator
public java.lang.String getBaseURI()
getBaseURI
in interface NodeInfo
public int getLineNumber()
getLineNumber
in interface javax.xml.transform.SourceLocator
getLineNumber
in interface Location
getLineNumber
in interface NodeInfo
getLineNumber
in interface org.xml.sax.Locator
public int getColumnNumber()
getColumnNumber
in interface javax.xml.transform.SourceLocator
getColumnNumber
in interface Location
getColumnNumber
in interface NodeInfo
getColumnNumber
in interface org.xml.sax.Locator
public Location saveLocation()
saveLocation
in interface Location
public int compareOrder(NodeInfo other)
compareOrder
in interface NodeInfo
other
- The other node, whose position is to be compared with this
nodepublic int comparePosition(NodeInfo other)
comparePosition
in interface NodeInfo
other
- The other node, whose position is to be compared with this
nodeAxisInfo.PRECEDING
if this node is on the preceding axis of the other node;
AxisInfo.FOLLOWING
if it is on the following axis; AxisInfo.ANCESTOR
if the first node is an
ancestor of the second; AxisInfo.DESCENDANT
if the first is a descendant of the second;
AxisInfo.SELF
if they are the same node.java.lang.UnsupportedOperationException
- if either node is an attribute or namespacepublic java.lang.String getStringValue()
getStringValue
in interface Item
getStringValue
in interface NodeInfo
Item.getStringValueCS()
public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
Item.getStringValue()
public java.lang.String getLocalPart()
getLocalPart
in interface NodeInfo
public java.lang.String getPrefix()
public java.lang.String getURI()
public java.lang.String getDisplayName()
getDisplayName
in interface NodeInfo
public NodeInfo getParent()
public int getSiblingPosition()
getSiblingPosition
in interface SiblingCountingNode
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
in interface NodeInfo
axisNumber
- the axis to be usedAxisInfo
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
in interface NodeInfo
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodesAxisInfo
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)
getAttributeValue
in interface NodeInfo
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute
that is in no namespacelocal
- the local part of the attribute name.public NodeInfo getRoot()
public boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
in interface NodeInfo
buffer
- a buffer to contain a string that uniquely identifies this node, across all documentspublic void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
copy
in interface NodeInfo
out
- the Receiver to which the node should be copied. It is the caller's
responsibility to ensure that this Receiver is open before the method is called
(or that it is self-opening), and that it is closed after use.copyOptions
- a selection of the options defined in CopyOptions
locationId
- If non-null, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
is not availableXPathException
- if any downstream error occurspublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
getDeclaredNamespaces
in interface NodeInfo
buffer
- If this is non-null, and the result array fits in this buffer, then the result
may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.For a node other than an element, the method returns null.
public boolean isId()
public boolean isIdref()
public boolean isNilled()
public boolean isStreamed()
isStreamed
in interface NodeInfo
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.