net.sf.saxon.value.TextFragmentValue 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
An OSGi bundle for Saxon-HE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 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.value;
import net.sf.saxon.Configuration;
import net.sf.saxon.event.Receiver;
import net.sf.saxon.om.*;
import net.sf.saxon.pattern.NodeTest;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.tree.iter.*;
import net.sf.saxon.tree.util.FastStringBuffer;
import net.sf.saxon.tree.util.Navigator;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.type.Type;
import net.sf.saxon.type.Untyped;
import javax.xml.transform.SourceLocator;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
/**
* This class represents a temporary tree whose root document node owns a single text node.
*/
public final class TextFragmentValue implements DocumentInfo, SourceLocator {
private CharSequence text;
private String baseURI;
private String documentURI;
/*@Nullable*/ private TextFragmentTextNode textNode = null; // created on demand
private Configuration config;
private long documentNumber;
private HashMap userData;
/**
* Constructor: create a result tree fragment containing a single text node
* @param value a String containing the value
* @param baseURI the base URI of the document node
*/
public TextFragmentValue(CharSequence value, String baseURI) {
this.text = value;
this.baseURI = baseURI;
}
/**
* To implement {@link Sequence}, this method returns the item itself
* @return this item
*/
public Item head() {
return this;
}
/**
* To implement {@link Sequence}, this method returns a singleton iterator
* that delivers this item in the form of a sequence
* @return a singleton iterator that returns this item
*/
public SequenceIterator iterate() {
return SingletonIterator.makeIterator(this);
}
/**
* Set the configuration (containing the name pool used for all names in this document)
*/
public void setConfiguration(Configuration config) {
this.config = config;
documentNumber = -1; // the document number is allocated lazily because it can cause
// contention on the NamePool and is often not needed.
}
/**
* Get the configuration previously set using setConfiguration
* (or the default configuraton allocated automatically)
*/
public Configuration getConfiguration() {
return config;
}
/**
* Get the name pool used for the names in this document
*/
public NamePool getNamePool() {
return config.getNamePool();
}
/**
* Ask whether the document contains any nodes whose type annotation is anything other than
* UNTYPED
*
* @return true if the document contains elements whose type is other than UNTYPED
*/
public boolean isTyped() {
return false;
}
/**
* Get the unique document number
*/
public long getDocumentNumber() {
if (documentNumber == -1) {
documentNumber = config.getDocumentNumberAllocator().allocateDocumentNumber();
// technically this isn't thread-safe; however, TextFragmentValues are invariably used within
// a single thread
}
return documentNumber;
}
/**
* Return the type of node.
* @return Type.DOCUMENT (always)
*/
public final int getNodeKind() {
return Type.DOCUMENT;
}
/**
* Get the String Value
*/
public String getStringValue() {
return text.toString();
}
/**
* 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.
*/
public CharSequence getStringValueCS() {
return text;
}
/**
* Determine whether this is the same node as another node
* @return true if this Node object and the supplied Node object represent the
* same node in the tree.
*/
public boolean isSameNodeInfo(NodeInfo other) {
return this==other;
}
/**
* Get a character string that uniquely identifies this node
* @param buffer the buffer to contain the generated ID
*/
public void generateId(/*@NotNull*/ FastStringBuffer buffer) {
buffer.append("tt");
buffer.append(Long.toString(getDocumentNumber()));
}
/**
* Set the system ID (that is, the document URI property) for the document node.
* @throws UnsupportedOperationException (always). This kind of tree does not have a document URI.
*/
public void setSystemId(String systemId) {
documentURI = systemId;
}
/**
* Get the system ID (the document URI) of the document node.
*/
public String getSystemId() {
return documentURI;
}
/**
* Get the base URI for the document node.
*/
public String getBaseURI() {
return baseURI;
}
/**
* 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())
*/
public int compareOrder(NodeInfo other) {
if (this==other) return 0;
return -1;
}
/**
* 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.
*
* The other node must always be in the same tree; the effect of calling this method
* when the two nodes are in different trees is undefined. If either node is a namespace
* or attribute node, the method should throw UnsupportedOperationException.
*
* @param other The other node, whose position is to be compared with this
* node
* @return {@link net.sf.saxon.om.AxisInfo#PRECEDING} if this node is on the preceding axis of the other node;
* {@link net.sf.saxon.om.AxisInfo#FOLLOWING} if it is on the following axis; {@link net.sf.saxon.om.AxisInfo#ANCESTOR} if the first node is an
* ancestor of the second; {@link net.sf.saxon.om.AxisInfo#DESCENDANT} if the first is a descendant of the second;
* {@link net.sf.saxon.om.AxisInfo#SELF} if they are the same node.
* @throws UnsupportedOperationException if either node is an attribute or namespace
* @since 9.5
*/
public int comparePosition(NodeInfo other) {
if (this==other) {
return AxisInfo.SELF;
}
if (textNode==other) {
return AxisInfo.ANCESTOR;
}
throw new UnsupportedOperationException();
}
/**
* Get the name code of the node, used for displaying names
*/
public int getNameCode() {
return -1;
}
/**
* Get the fingerprint of the node, used for matching names
*/
public int getFingerprint() {
return -1;
}
/**
* Get the prefix part of the name of this node. This is the name before the ":" if any.
* @return the prefix part of the name. For an unnamed node, return "".
*/
/*@NotNull*/ public String getPrefix() {
return "";
}
/**
* 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
* an element or attribute in the default namespace, return an empty string.
*/
/*@NotNull*/ public String getURI() {
return "";
}
/**
* Get the display name of this node. For elements and attributes this is [prefix:]localname.
* For unnamed nodes, it is an empty string.
* @return The display name of this node.
* For a node with no name, return an empty string.
*/
/*@NotNull*/ public String getDisplayName() {
return "";
}
/**
* Get the local name of this node.
* @return The local name of this node.
* For a node with no name, return "".
*/
/*@NotNull*/ public String getLocalPart() {
return "";
}
/**
* Determine whether the node has any children.
* @return true if this node has any attributes,
* false otherwise.
*/
public boolean hasChildNodes() {
return !("".equals(text));
}
/**
* Get line number
*
* @return the line number of the node in its original source document; or
* -1 if not available
*/
public int getLineNumber() {
return -1;
}
/**
* Get the type annotation of this node, if any.
* Returns XS_UNTYPED for kinds of nodes that have no annotation, and for elements annotated as
* untyped, and attributes annotated as untypedAtomic.
*
* @return the type annotation of the node.
* @see net.sf.saxon.type.Type
*/
public int getTypeAnnotation() {
return StandardNames.XS_UNTYPED;
}
/**
* 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
*/
public SchemaType getSchemaType() {
return Untyped.getInstance();
}
/**
* 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.
*/
/*@Nullable*/ public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer) {
return null;
}
/**
* Get the typed value.
*
* @return the typed value. If requireSingleton is set to true, the result will always be an
* AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic
* values.
* @since 8.5
*/
/*@NotNull*/ public AtomicSequence atomize() {
return new UntypedAtomicValue(text);
}
/**
* Return the public identifier for the current document event.
*
* The return value is the public identifier of the document
* entity or of the external parsed entity in which the markup that
* triggered the event appears.
*
* @return A string containing the public identifier, or
* null if none is available.
* @see #getSystemId
*/
/*@Nullable*/ public String getPublicId() {
return null;
}
/**
* Return the character position where the current document event ends.
*
* Warning: The return value from the method
* is intended only as an approximation for the sake of error
* reporting; it is not intended to provide sufficient information
* to edit the character content of the original XML document.
*
* The return value is an approximation of the column number
* in the document entity or external parsed entity where the
* markup that triggered the event appears.
*
* @return The column number, or -1 if none is available.
* @see #getLineNumber
*/
public int getColumnNumber() {
return -1;
}
/**
* 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
*/
public String getAttributeValue(/*@NotNull*/ String uri, /*@NotNull*/ String local) {
return null;
}
/**
* Return an iteration over the nodes reached by the given axis from this node
* @param axisNumber The axis to be iterated over
* @return a AxisIterator that scans the nodes reached by the axis in turn.
* @see net.sf.saxon.om.AxisInfo
*/
/*@NotNull*/ public AxisIterator iterateAxis(byte axisNumber) {
switch (axisNumber) {
case AxisInfo.ANCESTOR:
case AxisInfo.ATTRIBUTE:
case AxisInfo.FOLLOWING:
case AxisInfo.FOLLOWING_SIBLING:
case AxisInfo.NAMESPACE:
case AxisInfo.PARENT:
case AxisInfo.PRECEDING:
case AxisInfo.PRECEDING_SIBLING:
case AxisInfo.PRECEDING_OR_ANCESTOR:
return EmptyAxisIterator.emptyAxisIterator();
case AxisInfo.SELF:
case AxisInfo.ANCESTOR_OR_SELF:
return SingleNodeIterator.makeIterator(this);
case AxisInfo.CHILD:
case AxisInfo.DESCENDANT:
return SingleNodeIterator.makeIterator(getTextNode());
case AxisInfo.DESCENDANT_OR_SELF:
NodeInfo[] nodes = {this, getTextNode()};
return new AxisIteratorOverSequence(new ArrayIterator(nodes));
default:
throw new IllegalArgumentException("Unknown axis number " + axisNumber);
}
}
/**
* Return an enumeration over the nodes reached by the given axis from this node
* @param axisNumber The axis to be iterated over
* @param nodeTest A pattern to be matched by the returned nodes
* @return a AxisIterator that scans the nodes reached by the axis in turn.
* @see net.sf.saxon.om.AxisInfo
*/
/*@NotNull*/ public AxisIterator iterateAxis(byte axisNumber, /*@NotNull*/ NodeTest nodeTest) {
switch (axisNumber) {
case AxisInfo.ANCESTOR:
case AxisInfo.ATTRIBUTE:
case AxisInfo.FOLLOWING:
case AxisInfo.FOLLOWING_SIBLING:
case AxisInfo.NAMESPACE:
case AxisInfo.PARENT:
case AxisInfo.PRECEDING:
case AxisInfo.PRECEDING_SIBLING:
case AxisInfo.PRECEDING_OR_ANCESTOR:
return EmptyAxisIterator.emptyAxisIterator();
case AxisInfo.SELF:
case AxisInfo.ANCESTOR_OR_SELF:
return Navigator.filteredSingleton(this, nodeTest);
case AxisInfo.CHILD:
case AxisInfo.DESCENDANT:
return Navigator.filteredSingleton(getTextNode(), nodeTest);
case AxisInfo.DESCENDANT_OR_SELF:
boolean b1 = nodeTest.matches(this);
NodeInfo textNode2 = getTextNode();
boolean b2 = nodeTest.matches(textNode2);
if (b1) {
if (b2) {
NodeInfo[] pair = {this, textNode2};
return new AxisIteratorOverSequence(new ArrayIterator(pair));
} else {
return SingleNodeIterator.makeIterator(this);
}
} else {
if (b2) {
return SingleNodeIterator.makeIterator(textNode2);
} else {
return EmptyAxisIterator.emptyAxisIterator();
}
}
default:
throw new IllegalArgumentException("Unknown axis number " + axisNumber);
}
}
/**
* Find the parent node of this node.
* @return The Node object describing the containing element or root node.
*/
/*@Nullable*/ public NodeInfo getParent() {
return null;
}
/**
* Get the root node
* @return the NodeInfo representing the root of this tree
*/
/*@NotNull*/ public NodeInfo getRoot() {
return this;
}
/**
* Get the root (document) node
* @return the DocumentInfo representing the containing document
*/
/*@NotNull*/ public DocumentInfo getDocumentRoot() {
return this;
}
/**
* Copy the result tree fragment value to a given Outputter
*/
public void copy(/*@NotNull*/ Receiver out, int copyOptions, int locationId)
throws XPathException {
out.characters(text, 0, 0);
}
/**
* Get the element with a given ID.
* @param id The unique ID of the required element
* @param getParent
* @return null (this kind of tree contains no elements)
*/
/*@Nullable*/ public NodeInfo selectID(String id, boolean getParent) {
return null;
}
/**
* Get the list of unparsed entities defined in this document
* @return an Iterator, whose items are of type String, containing the names of all
* unparsed entities defined in this document. If there are no unparsed entities or if the
* information is not available then an empty iterator is returned
*/
public Iterator getUnparsedEntityNames() {
return Collections.EMPTY_LIST.iterator();
}
/**
* Get the unparsed entity with a given name
* @param name the name of the entity
* @return the URI and public ID of the entity if there is one, or null if not
*/
/*@Nullable*/ public String[] getUnparsedEntity(String name) {
return null;
}
/**
* Determine whether this node has the is-id property
*
* @return true if the node is an ID
*/
public boolean isId() {
return false;
}
/**
* Determine whether this node has the is-idref property
*
* @return true if the node is an IDREF or IDREFS element or attribute
*/
public boolean isIdref() {
return false;
}
/**
* Determine whether the node has the is-nilled property
*
* @return true if the node has the is-nilled property
*/
public boolean isNilled() {
return false;
}
/**
* Make an instance of the text node
*/
/*@Nullable*/ private TextFragmentTextNode getTextNode() {
if (textNode==null) {
textNode = new TextFragmentTextNode();
}
return textNode;
}
/**
* Inner class representing the text node; this is created on demand
*/
private class TextFragmentTextNode implements NodeInfo, SourceLocator {
/**
* To implement {@link Sequence}, this method returns the item itself
* @return this item
*/
public Item head() {
return this;
}
/**
* To implement {@link Sequence}, this method returns a singleton iterator
* that delivers this item in the form of a sequence
* @return a singleton iterator that returns this item
*/
public SequenceIterator iterate() {
return SingletonIterator.makeIterator(this);
}
/**
* Set the system ID for the entity containing the node.
*/
public void setSystemId(String systemId) {}
/**
* Get the configuration
*/
public Configuration getConfiguration() {
return config;
}
/**
* Get the name pool for this node
* @return the NamePool
*/
public NamePool getNamePool() {
return config.getNamePool();
}
/**
* Return the type of node.
* @return Type.TEXT (always)
*/
public final int getNodeKind() {
return Type.TEXT;
}
/**
* Get the String Value
*/
public String getStringValue() {
return text.toString();
}
/**
* 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.
*/
public CharSequence getStringValueCS() {
return text;
}
/**
* Determine whether this is the same node as another node
* @return true if this Node object and the supplied Node object represent the
* same node in the tree.
*/
public boolean isSameNodeInfo(NodeInfo other) {
return this==other;
}
/**
* Get a character string that uniquely identifies this node
*/
public void generateId(/*@NotNull*/ FastStringBuffer buffer) {
buffer.append("tt");
buffer.append(Long.toString(getDocumentNumber()));
buffer.append("t1");
}
/**
* Get the system ID for the entity containing the node.
*/
/*@Nullable*/ public String getSystemId() {
return null;
}
/**
* Get the base URI for the node. Default implementation for child nodes gets
* the base URI of the parent node.
*/
public String getBaseURI() {
return baseURI;
}
/**
* 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())
*/
public int compareOrder(NodeInfo other) {
if (this==other) return 0;
return +1;
}
/**
* 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.
*
* The other node must always be in the same tree; the effect of calling this method
* when the two nodes are in different trees is undefined. If either node is a namespace
* or attribute node, the method should throw UnsupportedOperationException.
*
* @param other The other node, whose position is to be compared with this
* node
* @return {@link net.sf.saxon.om.AxisInfo#PRECEDING} if this node is on the preceding axis of the other node;
* {@link net.sf.saxon.om.AxisInfo#FOLLOWING} if it is on the following axis; {@link net.sf.saxon.om.AxisInfo#ANCESTOR} if the first node is an
* ancestor of the second; {@link net.sf.saxon.om.AxisInfo#DESCENDANT} if the first is a descendant of the second;
* {@link net.sf.saxon.om.AxisInfo#SELF} if they are the same node.
* @throws UnsupportedOperationException if either node is an attribute or namespace
* @since 9.5
*/
public int comparePosition(NodeInfo other) {
if (this == other) {
return AxisInfo.SELF;
}
if (TextFragmentValue.this == other) {
return AxisInfo.DESCENDANT;
}
throw new UnsupportedOperationException();
}
/**
* Get the name code of the node, used for displaying names
*/
public int getNameCode() {
return -1;
}
/**
* Get the fingerprint of the node, used for matching names
*/
public int getFingerprint() {
return -1;
}
/**
* Get the prefix part of the name of this node. This is the name before the ":" if any.
* @return the prefix part of the name. For an unnamed node, return "".
*/
/*@NotNull*/ public String getPrefix() {
return "";
}
/**
* 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
* an element or attribute in the default namespace, return an empty string.
*/
/*@NotNull*/ public String getURI() {
return "";
}
/**
* Get the display name of this node. For elements and attributes this is [prefix:]localname.
* For unnamed nodes, it is an empty string.
* @return The display name of this node.
* For a node with no name, return an empty string.
*/
/*@NotNull*/ public String getDisplayName() {
return "";
}
/**
* Get the local name of this node.
* @return The local name of this node.
* For a node with no name, return "".
*/
/*@NotNull*/ public String getLocalPart() {
return "";
}
/**
* Determine whether the node has any children.
* @return true if this node has any attributes,
* false otherwise.
*/
public boolean hasChildNodes() {
return false;
}
/**
* 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
*/
public String getAttributeValue(/*@NotNull*/ String uri, /*@NotNull*/ String local) {
return null;
}
/**
* Get line number
*
* @return the line number of the node in its original source document; or
* -1 if not available
*/
public int getLineNumber() {
return -1;
}
/**
* Get the type annotation of this node, if any.
* The result is undefined for nodes other than elements and attributes.
*
* @return the type annotation of the node.
* @see net.sf.saxon.type.Type
*/
public int getTypeAnnotation() {
return -1;
}
/**
* 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
*/
public SchemaType getSchemaType() {
return null;
}
/**
* Get the document number of the document containing this node. For a free-standing
* orphan node, just return the hashcode.
*/
public long getDocumentNumber() {
return getDocumentRoot().getDocumentNumber();
}
/**
* 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.
*/
/*@Nullable*/ public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer) {
return null;
}
/**
* Get the typed value.
* @return the typed value. If requireSingleton is set to true, the result will always be an
* AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic
* values.
* @since 8.5
*/
/*@NotNull*/ public AtomicSequence atomize() throws XPathException {
return new UntypedAtomicValue(text);
}
/**
* Return the public identifier for the current document event.
*
* The return value is the public identifier of the document
* entity or of the external parsed entity in which the markup that
* triggered the event appears.
*
* @return A string containing the public identifier, or
* null if none is available.
* @see #getSystemId
*/
/*@Nullable*/ public String getPublicId() {
return null;
}
/**
* Return the character position where the current document event ends.
*
* Warning: The return value from the method
* is intended only as an approximation for the sake of error
* reporting; it is not intended to provide sufficient information
* to edit the character content of the original XML document.
*
* The return value is an approximation of the column number
* in the document entity or external parsed entity where the
* markup that triggered the event appears.
*
* @return The column number, or -1 if none is available.
* @see #getLineNumber
*/
public int getColumnNumber() {
return -1;
}
/**
* Return an enumeration over the nodes reached by the given axis from this node
* @param axisNumber the axis to be iterated over
* @return a AxisIterator that scans the nodes reached by the axis in turn.
*/
/*@NotNull*/ public AxisIterator iterateAxis(byte axisNumber) {
switch (axisNumber) {
case AxisInfo.ANCESTOR:
case AxisInfo.PARENT:
case AxisInfo.PRECEDING_OR_ANCESTOR:
return SingleNodeIterator.makeIterator(TextFragmentValue.this);
case AxisInfo.ANCESTOR_OR_SELF:
NodeInfo[] nodes = {this, TextFragmentValue.this};
return new AxisIteratorOverSequence(new ArrayIterator(nodes));
case AxisInfo.ATTRIBUTE:
case AxisInfo.CHILD:
case AxisInfo.DESCENDANT:
case AxisInfo.FOLLOWING:
case AxisInfo.FOLLOWING_SIBLING:
case AxisInfo.NAMESPACE:
case AxisInfo.PRECEDING:
case AxisInfo.PRECEDING_SIBLING:
return EmptyAxisIterator.emptyAxisIterator();
case AxisInfo.SELF:
case AxisInfo.DESCENDANT_OR_SELF:
return SingleNodeIterator.makeIterator(this);
default:
throw new IllegalArgumentException("Unknown axis number " + axisNumber);
}
}
/**
* Return an enumeration over the nodes reached by the given axis from this node
* @param axisNumber the axis to be iterated over
* @param nodeTest A pattern to be matched by the returned nodes
* @return a AxisIterator that scans the nodes reached by the axis in turn.
*/
/*@NotNull*/ public AxisIterator iterateAxis( byte axisNumber, /*@NotNull*/ NodeTest nodeTest) {
switch (axisNumber) {
case AxisInfo.ANCESTOR:
case AxisInfo.PARENT:
case AxisInfo.PRECEDING_OR_ANCESTOR:
return Navigator.filteredSingleton(TextFragmentValue.this, nodeTest);
case AxisInfo.ANCESTOR_OR_SELF:
boolean matchesDoc = nodeTest.matches(TextFragmentValue.this);
boolean matchesText = nodeTest.matches(this);
if (matchesDoc && matchesText) {
NodeInfo[] nodes = {this, TextFragmentValue.this};
return new AxisIteratorOverSequence(new ArrayIterator(nodes));
} else if (matchesDoc && !matchesText) {
return SingleNodeIterator.makeIterator(TextFragmentValue.this);
} else if (matchesText && !matchesDoc) {
return SingleNodeIterator.makeIterator(this);
} else {
return EmptyAxisIterator.emptyAxisIterator();
}
case AxisInfo.ATTRIBUTE:
case AxisInfo.CHILD:
case AxisInfo.DESCENDANT:
case AxisInfo.FOLLOWING:
case AxisInfo.FOLLOWING_SIBLING:
case AxisInfo.NAMESPACE:
case AxisInfo.PRECEDING:
case AxisInfo.PRECEDING_SIBLING:
return EmptyAxisIterator.emptyAxisIterator();
case AxisInfo.SELF:
case AxisInfo.DESCENDANT_OR_SELF:
return Navigator.filteredSingleton(this, nodeTest);
default:
throw new IllegalArgumentException("Unknown axis number " + axisNumber);
}
}
/**
* Find the parent node of this node.
* @return The Node object describing the containing element or root node.
*/
/*@NotNull*/ public NodeInfo getParent() {
return TextFragmentValue.this;
}
/**
* Get the root node
* @return the NodeInfo representing the root of this tree
*/
/*@NotNull*/ public NodeInfo getRoot() {
return TextFragmentValue.this;
}
/**
* Get the root (document) node
* @return the DocumentInfo representing the containing document
*/
/*@NotNull*/ public DocumentInfo getDocumentRoot() {
return TextFragmentValue.this;
}
/**
* Copy the node to a given Outputter
*/
public void copy(/*@NotNull*/ Receiver out, int copyOptions, int locationId)
throws XPathException {
out.characters(text, 0, 0);
}
/**
* Determine whether this node has the is-id property
*
* @return true if the node is an ID
*/
public boolean isId() {
return false;
}
/**
* Determine whether this node has the is-idref property
*
* @return true if the node is an IDREF or IDREFS element or attribute
*/
public boolean isIdref() {
return false;
}
/**
* Determine whether the node has the is-nilled property
*
* @return true if the node has the is-nilled property
*/
public boolean isNilled() {
return false;
}
}
/**
* Set user data on the document node. The user data can be retrieved subsequently
* using {@link #getUserData}
* @param key A string giving the name of the property to be set. Clients are responsible
* for choosing a key that is likely to be unique. Must not be null. Keys used internally
* by Saxon are prefixed "saxon:".
* @param value The value to be set for the property. May be null, which effectively
* removes the existing value for the property.
*/
public void setUserData(String key, /*@Nullable*/ Object value) {
if (userData == null) {
userData = new HashMap(4);
}
if (value == null) {
userData.remove(key);
} else {
userData.put(key, value);
}
}
/**
* Get user data held in the document node. This retrieves properties previously set using
* {@link #setUserData}
* @param key A string giving the name of the property to be retrieved.
* @return the value of the property, or null if the property has not been defined.
*/
/*@Nullable*/ public Object getUserData(String key) {
if (userData == null) {
return null;
} else {
return userData.get(key);
}
}
}