Package net.sf.saxon.option.axiom
Class AxiomLeafNodeWrapper
java.lang.Object
net.sf.saxon.tree.wrapper.AbstractNodeWrapper
net.sf.saxon.option.axiom.AxiomLeafNodeWrapper
- All Implemented Interfaces:
Source
,SourceLocator
,ActiveSource
,GroundedValue
,Item
,NodeInfo
,Sequence
,Location
,SiblingCountingNode
,VirtualNode
,Locator
A node in the XDM tree. This is the implementation of the NodeInfo interface used as a wrapper for
Axiom comment, text, and processing instruction nodes.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
protected org.apache.axiom.om.OMNode
protected short
Fields inherited from class net.sf.saxon.tree.wrapper.AbstractNodeWrapper
treeInfo
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AxiomLeafNodeWrapper
(org.apache.axiom.om.OMNode node, AxiomDocument docWrapper, AxiomParentNodeWrapper parent, int index) This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class -
Method Summary
Modifier and TypeMethodDescriptionint
compareOrder
(NodeInfo other) Determine the relative position of this node and another node, in document order.void
generateId
(StringBuilder buffer) Get a character string that uniquely identifies this node.getDeclaredNamespaces
(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.Get the display name of this node.Get the local part of the name of this node.Get the URI part of the name of this node.int
Return the type of node.Get the NodeInfo object representing the parent of this nodeGet the prefix of the name of the node.getRoot()
Get the root node of the tree containing this nodeGet the type annotation of this node, if any.int
Get the index position of this node among its siblings (starting from 0)org.apache.axiom.om.OMNode
Get the underlying XOM node, to implement the VirtualNode interfaceGet the value of the item as a CharSequence.boolean
Determine whether the node has any children.protected AxisIterator
iterateAttributes
(NodeTest nodeTest) Return an iterator over the attributes of this element node.protected AxisIterator
iterateChildren
(NodeTest nodeTest) Return an iterator over the children of this node.protected AxisIterator
iterateDescendants
(NodeTest nodeTest, boolean includeSelf) Return an iterator over the descendants of this node.protected AxisIterator
iterateSiblings
(NodeTest nodeTest, boolean forwards) Return an iterator over the siblings of this node.Methods inherited from class net.sf.saxon.tree.wrapper.AbstractNodeWrapper
atomize, equals, getAllNamespaces, getAttributeValue, getBaseURI, getColumnNumber, getFingerprint, getLineNumber, getNamePool, getRealNode, getSystemId, getTreeInfo, hasFingerprint, hashCode, iterateAxis, iterateAxis, saveLocation, setSystemId
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, getStringValue, head, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.s9api.Location
saveLocation
Methods inherited from interface net.sf.saxon.om.NodeInfo
asActiveSource, atomize, attributes, children, children, copy, deliver, equals, getAllNamespaces, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getFingerprint, getGenre, getLineNumber, getPublicId, getSystemId, getTreeInfo, getURI, hasFingerprint, hashCode, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, iterateAxis, iterateAxis, setSystemId, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Field Details
-
node
protected org.apache.axiom.om.OMNode node -
nodeKind
protected short nodeKind -
index
protected int index
-
-
Constructor Details
-
AxiomLeafNodeWrapper
protected AxiomLeafNodeWrapper(org.apache.axiom.om.OMNode node, AxiomDocument docWrapper, AxiomParentNodeWrapper parent, int index) This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class- Parameters:
node
- The Axiom node to be wrappeddocWrapper
- The wrapper of the containing document node - must not be nullparent
- The NodeWrapper that wraps the parent of this node; null means unknwonindex
- Position of this node among its siblings
-
-
Method Details
-
getUnderlyingNode
public org.apache.axiom.om.OMNode getUnderlyingNode()Get the underlying XOM node, to implement the VirtualNode interface- Specified by:
getUnderlyingNode
in interfaceVirtualNode
- Returns:
- The underlying node.
-
getNodeKind
public int getNodeKind()Return the type of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
- See Also:
-
getSchemaType
Get the type annotation of this node, if any. The type annotation is represented as SchemaType object.Types derived from a DTD are not reflected in the result of this method.
- Specified by:
getSchemaType
in interfaceNodeInfo
- Returns:
- For element and attribute nodes: the type annotation derived from schema validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema validation). For comments, text nodes, processing instructions, and namespaces: null. For document nodes, either xs:untyped if the document has not been validated, or xs:anyType if it has.
- Since:
- 9.4
-
compareOrder
Determine the relative position of this node and another node, in document order. The other node will always be in the same document.- Specified by:
compareOrder
in interfaceNodeInfo
- Parameters:
other
- The other node, whose position is to be compared with this node- Returns:
- -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
-
getUnicodeStringValue
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.- Specified by:
getUnicodeStringValue
in interfaceGroundedValue
- Specified by:
getUnicodeStringValue
in interfaceItem
- Returns:
- the string value of the node
-
getLocalPart
Get the local part of the name of this node. This is the name after the ":" if any.- Specified by:
getLocalPart
in interfaceNodeInfo
- Returns:
- the local part of the name. For an unnamed node, returns "".
-
getPrefix
Get the prefix of the name of the node. This is defined only for elements and attributes. If the node has no prefix, or for other kinds of node, return a zero-length string. -
getNamespaceUri
Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.- Specified by:
getNamespaceUri
in interfaceNodeInfo
- Returns:
- The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.
-
getDisplayName
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.- Specified by:
getDisplayName
in interfaceNodeInfo
- Overrides:
getDisplayName
in classAbstractNodeWrapper
- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getParent
Get the NodeInfo object representing the parent of this node -
getSiblingPosition
public int getSiblingPosition()Get the index position of this node among its siblings (starting from 0)- Specified by:
getSiblingPosition
in interfaceSiblingCountingNode
- Returns:
- 0 for the first child, 1 for the second child, etc.
-
iterateAttributes
Description copied from class:AbstractNodeWrapper
Return an iterator over the attributes of this element node. This method is only called after checking that the node is an element.- Specified by:
iterateAttributes
in classAbstractNodeWrapper
- Parameters:
nodeTest
- a test that the returned attributes must satisfy- Returns:
- an iterator over the attribute nodes. The order of the result, although arbitrary, must be consistent with document order.
-
iterateChildren
Description copied from class:AbstractNodeWrapper
Return an iterator over the children of this node. This method is only called after checking that the node is an element or document.- Specified by:
iterateChildren
in classAbstractNodeWrapper
- Parameters:
nodeTest
- a test that the returned attributes must satisfy- Returns:
- an iterator over the child nodes, in document order.
-
iterateSiblings
Description copied from class:AbstractNodeWrapper
Return an iterator over the siblings of this node. This method is only called after checking that the node is an element, text, comment, or PI node.- Specified by:
iterateSiblings
in classAbstractNodeWrapper
- Parameters:
nodeTest
- a test that the returned siblings must satisfyforwards
- true for following siblings, false for preceding siblings- Returns:
- an iterator over the sibling nodes, in axis order.
-
iterateDescendants
Description copied from class:AbstractNodeWrapper
Return an iterator over the descendants of this node. This method is only called after checking that the node is an element or document node.- Overrides:
iterateDescendants
in classAbstractNodeWrapper
- Parameters:
nodeTest
- a test that the returned descendants must satisfyincludeSelf
- true if this node is to be included in the result- Returns:
- an iterator over the sibling nodes, in axis order.
-
getRoot
Get the root node of the tree containing this node- Specified by:
getRoot
in interfaceNodeInfo
- Overrides:
getRoot
in classAbstractNodeWrapper
- Returns:
- the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node
-
hasChildNodes
public boolean hasChildNodes()Determine whether the node has any children.Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()
- Specified by:
hasChildNodes
in interfaceNodeInfo
- Overrides:
hasChildNodes
in classAbstractNodeWrapper
- Returns:
- True if the node has one or more children
-
generateId
Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)- Specified by:
generateId
in interfaceNodeInfo
- Parameters:
buffer
- a buffer to contain a string that uniquely identifies this node, across all documents
-
getDeclaredNamespaces
Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespaces
in interfaceNodeInfo
- Overrides:
getDeclaredNamespaces
in classAbstractNodeWrapper
- Parameters:
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.- Returns:
- An array of integers representing the namespace declarations and undeclarations present on
this element. For a node other than an element, return null. Otherwise, the returned array is a
sequence of namespace codes, whose meaning may be interpreted by reference to the name pool. The
top half word of each namespace code represents the prefix, the bottom half represents the URI.
If the bottom half is zero, then this is a namespace undeclaration rather than a declaration.
The XML namespace is never included in the list. If the supplied array is larger than required,
then the first unused entry will be set to -1.
For a node other than an element, the method returns null.
-