net.sf.saxon.option.axiom.AxiomElementNodeWrapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2023 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.option.axiom;
import net.sf.saxon.om.NamespaceBinding;
import net.sf.saxon.om.NamespaceMap;
import net.sf.saxon.om.NamespaceUri;
import net.sf.saxon.om.NodeInfo;
import net.sf.saxon.pattern.AnyNodeTest;
import net.sf.saxon.pattern.NameTest;
import net.sf.saxon.pattern.NodeKindTest;
import net.sf.saxon.pattern.NodeTest;
import net.sf.saxon.tree.NamespaceNode;
import net.sf.saxon.tree.iter.AxisIterator;
import net.sf.saxon.tree.iter.EmptyIterator;
import net.sf.saxon.tree.iter.SingleNodeIterator;
import net.sf.saxon.tree.util.Navigator;
import net.sf.saxon.tree.wrapper.SiblingCountingNode;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.type.Type;
import net.sf.saxon.type.Untyped;
import org.apache.axiom.om.*;
import javax.xml.namespace.QName;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
* A node in the XDM tree; specifically, a node that wraps an Axiom element node.
*/
public class AxiomElementNodeWrapper extends AxiomParentNodeWrapper {
private AxiomParentNodeWrapper parent; // null means unknown
protected AxiomDocument docWrapper;
protected int index; // -1 means unknown
private NamespaceMap inScopeNamespaces = null;
/**
* This constructor is protected: nodes should be created using the wrap
* factory method on the DocumentWrapper class
*
* @param node The Axiom node to be wrapped
* @param docWrapper The wrapper around the document node at the root of the tree
* @param parent The NodeWrapper that wraps the parent of this node
* @param index Position of this node among its siblings
*/
protected AxiomElementNodeWrapper(OMElement node, AxiomDocument docWrapper, AxiomParentNodeWrapper parent, int index) {
super(node);
this.parent = parent;
this.docWrapper = docWrapper;
this.index = index;
this.treeInfo = docWrapper;
}
/**
* Return the type of node.
*
* @return one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
*/
@Override
public int getNodeKind() {
return Type.ELEMENT;
}
/**
* 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.
*
* @return 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
*/
@Override
public SchemaType getSchemaType() {
return Untyped.getInstance();
}
/**
* Determine the relative position of this node and another node, in
* document order. The other node will always be in the same document.
*
* @param other The other node, whose position is to be compared with this
* node
* @return -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())
*/
@Override
public int compareOrder(NodeInfo other) {
if (other instanceof AxiomDocument) {
return +1;
} else if (other instanceof AxiomAttributeWrapper) {
if (other.getParent() == this) {
return -1;
} else {
return compareOrder(other.getParent());
}
} else if (other instanceof NamespaceNode) {
return -other.compareOrder(this);
} else {
return Navigator.compareOrder(this, (SiblingCountingNode) other);
}
}
/**
* Get the local part of the name of this node. This is the name after the
* ":" if any.
*
* @return the local part of the name. For an unnamed node, returns "".
*/
@Override
public String getLocalPart() {
return ((OMElement) node).getLocalName();
}
/**
* 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.
*
* @return The prefix of the name of the node.
*/
@Override
public String getPrefix() {
String prefix = ((OMElement) node).getPrefix();
return (prefix == null ? "" : prefix);
}
/**
* 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.
*
* @return The URI of the namespace of this node. For an unnamed node, or
* for a node with an empty prefix, return an empty string.
*/
@Override
public NamespaceUri getNamespaceUri() {
String uri = ((OMElement) node).getNamespaceURI();
return NamespaceUri.of(uri);
}
/**
* Get the NodeInfo object representing the parent of this node
*/
@Override
public AxiomParentNodeWrapper getParent() {
if (parent == null) {
OMContainer rawParent = ((OMElement) node).getParent();
if (rawParent instanceof OMDocument) {
parent = (AxiomDocumentNodeWrapper)docWrapper.getRootNode();
} else {
parent = (AxiomElementNodeWrapper) AxiomDocument.makeWrapper(((OMElement) rawParent), docWrapper, null, -1);
}
}
return parent;
}
/**
* Get the index position of this node among its siblings (starting from 0)
*/
@Override
public int getSiblingPosition() {
if (index != -1) {
return index;
}
OMContainer p = getParent().node;
int ix = 0;
for (Iterator kids = p.getChildren(); kids.hasNext(); ) {
if (kids.next() == node) {
return (index = ix);
}
ix++;
}
throw new IllegalStateException("Bad child/parent relationship in Axiom tree");
}
@Override
protected AxisIterator iterateAttributes(NodeTest nodeTest) {
if (!((OMElement) node).getAllAttributes().hasNext()) {
return EmptyIterator.ofNodes();
} else if (nodeTest instanceof NameTest) {
String uri = ((NameTest) nodeTest).getNamespaceURI().toString();
String local = ((NameTest) nodeTest).getLocalPart();
OMAttribute att = ((OMElement) node).getAttribute(new QName(uri, local));
if (att == null) {
return EmptyIterator.ofNodes();
} else {
return SingleNodeIterator.makeIterator(new AxiomAttributeWrapper(att, this, -1));
}
} else {
return new AttributeAxisIterator(this, nodeTest);
}
}
@Override
protected AxisIterator iterateSiblings(NodeTest nodeTest, boolean forwards) {
if (forwards) {
if (nodeTest instanceof AnyNodeTest) {
return new AxiomDocument.FollowingSiblingIterator((OMElement) node, parent, docWrapper);
} else {
return new Navigator.AxisFilter(
new AxiomDocument.FollowingSiblingIterator((OMElement) node, parent, docWrapper), nodeTest);
}
} else {
if (nodeTest instanceof AnyNodeTest) {
return new AxiomDocument.PrecedingSiblingIterator((OMElement) node, parent, docWrapper);
} else {
return new Navigator.AxisFilter(
new AxiomDocument.PrecedingSiblingIterator((OMElement) node, parent, docWrapper), nodeTest);
}
}
}
/**
* Get the string value of a given attribute of this node
*
* @param uri the namespace URI of the attribute name. Supply the empty string for an attribute
* that is in no namespace
* @param local the local part of the attribute name.
* @return the attribute value if it exists, or null if it does not exist. Always returns null
* if this node is not an element.
* @since 9.4
*/
@Override
public String getAttributeValue(/*@NotNull*/ NamespaceUri uri, /*@NotNull*/ String local) {
return ((OMElement) node).getAttributeValue(new javax.xml.namespace.QName(uri.toString(), local, ""));
}
/**
* Get the root node of the tree containing this node
*
* @return the NodeInfo representing the top-level ancestor of this node.
* This will not necessarily be a document node
*/
@Override
public NodeInfo getRoot() {
return docWrapper.getRootNode();
}
/**
* Get all namespace undeclarations and undeclarations defined on this element.
*
* @param 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.
* @return 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.
*/
@Override
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer) {
OMElement elem = (OMElement) node;
List list = new ArrayList<>();
for (Iterator iter = elem.getAllDeclaredNamespaces(); iter.hasNext(); ) {
OMNamespace ns = (OMNamespace) iter.next();
NamespaceBinding nb = new NamespaceBinding(ns.getPrefix(), NamespaceUri.of(ns.getNamespaceURI()));
list.add(nb);
}
NamespaceBinding[] array = new NamespaceBinding[list.size()];
return list.toArray(array);
}
/**
* Get all the namespace bindings that are in-scope for this element.
* For an element return all the prefix-to-uri bindings that are in scope. This may include
* a binding to the default namespace (represented by a prefix of ""). It will never include
* "undeclarations" - that is, the namespace URI will never be empty; the effect of an undeclaration
* is to remove a binding from the in-scope namespaces, not to add anything.
* For a node other than an element, returns null.
*
* @return the in-scope namespaces for an element, or null for any other kind of node.
*/
@Override
public NamespaceMap getAllNamespaces() {
if (getNodeKind() == Type.ELEMENT) {
if (inScopeNamespaces != null) {
return inScopeNamespaces;
} else {
NodeInfo parent = getParent();
NamespaceMap nsMap = parent != null && parent.getNodeKind() == Type.ELEMENT
? parent.getAllNamespaces()
: NamespaceMap.emptyMap();
OMElement elem = (OMElement) node;
for (Iterator iter = elem.getAllDeclaredNamespaces(); iter.hasNext(); ) {
OMNamespace ns = (OMNamespace) iter.next();
nsMap = nsMap.bind(ns.getPrefix(), NamespaceUri.of(ns.getNamespaceURI()));
}
return inScopeNamespaces = nsMap;
}
} else {
// not an element node
return null;
}
}
///////////////////////////////////////////////////////////////////////////////
// Axis enumeration classes
///////////////////////////////////////////////////////////////////////////////
/**
* Handles the attribute axis
*/
private final class AttributeAxisIterator implements AxisIterator {
private final AxiomElementNodeWrapper element;
private final Iterator base;
private NodeInfo current;
private int index;
private final NodeTest nodeTest;
public AttributeAxisIterator(AxiomElementNodeWrapper element, NodeTest test) {
this.element = element;
if (test == AnyNodeTest.getInstance() || test == NodeKindTest.ATTRIBUTE) {
test = null;
}
base = ((OMElement) element.node).getAllAttributes();
nodeTest = test;
index = 0;
}
@Override
public NodeInfo next() {
NodeInfo curr;
do { // until we find a match
curr = advance();
} while (curr != null && nodeTest != null && !nodeTest.test(curr));
current = curr;
return curr;
}
private NodeInfo advance() {
if (base.hasNext()) {
OMAttribute nextAtt = (OMAttribute) base.next();
index++;
return new AxiomAttributeWrapper(nextAtt, element, index);
} else {
return null;
}
}
} // end of class AttributeAxisIterator
}