package client.net.sf.saxon.ce.value;
import client.net.sf.saxon.ce.Configuration;
import client.net.sf.saxon.ce.event.Receiver;
import client.net.sf.saxon.ce.om.*;
import client.net.sf.saxon.ce.pattern.NodeTest;
import client.net.sf.saxon.ce.trans.XPathException;
import client.net.sf.saxon.ce.tree.iter.AxisIterator;
import client.net.sf.saxon.ce.tree.iter.EmptyIterator;
import client.net.sf.saxon.ce.tree.iter.NodeArrayIterator;
import client.net.sf.saxon.ce.tree.iter.SingleNodeIterator;
import client.net.sf.saxon.ce.tree.util.FastStringBuffer;
import client.net.sf.saxon.ce.tree.util.Navigator;
import client.net.sf.saxon.ce.type.Type;
import java.util.HashMap;
/**
* This class represents a temporary tree whose root document node owns a single text node. <BR>
*/
public final class TextFragmentValue implements DocumentInfo, FingerprintedNode {
private CharSequence text;
private String baseURI;
private String documentURI;
private TextFragmentTextNode textNode = null; // created on demand
private Configuration config;
private int documentNumber;
private HashMap<String, Object> 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;
}
/**
* 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();
}
/**
* Get the unique document number
*/
public int 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(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;
}
/**
* 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 "".
*/
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.
*/
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.
*/
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 "".
*/
public String getLocalPart() {
return "";
}
/**
* Determine whether the node has any children.
* @return <code>true</code> if this node has any attributes,
* <code>false</code> 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 client.net.sf.saxon.ce.type.Type
*/
public int getTypeAnnotation() {
return StandardNames.XS_UNTYPED;
}
/**
* 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.
* <p/>
* <p>For a node other than an element, the method returns null.</p>
*/
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer) {
return null;
}
/**
* Get the typed value of the item
*
* @return the typed value of the item. In general this will be a sequence
*/
public AtomicValue getTypedValue() {
return new UntypedAtomicValue(text);
}
/**
* 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 client.net.sf.saxon.ce.om.Axis
*/
public AxisIterator iterateAxis(byte axisNumber) {
switch (axisNumber) {
case Axis.ANCESTOR:
case Axis.ATTRIBUTE:
case Axis.FOLLOWING:
case Axis.FOLLOWING_SIBLING:
case Axis.NAMESPACE:
case Axis.PARENT:
case Axis.PRECEDING:
case Axis.PRECEDING_SIBLING:
case Axis.PRECEDING_OR_ANCESTOR:
return EmptyIterator.getInstance();
case Axis.SELF:
case Axis.ANCESTOR_OR_SELF:
return SingleNodeIterator.makeIterator(this);
case Axis.CHILD:
case Axis.DESCENDANT:
return SingleNodeIterator.makeIterator(getTextNode());
case Axis.DESCENDANT_OR_SELF:
NodeInfo[] nodes = {this, getTextNode()};
return new NodeArrayIterator(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 client.net.sf.saxon.ce.om.Axis
*/
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest) {
switch (axisNumber) {
case Axis.ANCESTOR:
case Axis.ATTRIBUTE:
case Axis.FOLLOWING:
case Axis.FOLLOWING_SIBLING:
case Axis.NAMESPACE:
case Axis.PARENT:
case Axis.PRECEDING:
case Axis.PRECEDING_SIBLING:
case Axis.PRECEDING_OR_ANCESTOR:
return EmptyIterator.getInstance();
case Axis.SELF:
case Axis.ANCESTOR_OR_SELF:
return Navigator.filteredSingleton(this, nodeTest);
case Axis.CHILD:
case Axis.DESCENDANT:
return Navigator.filteredSingleton(getTextNode(), nodeTest);
case Axis.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 NodeArrayIterator(pair);
} else {
return SingleNodeIterator.makeIterator(this);
}
} else {
if (b2) {
return SingleNodeIterator.makeIterator(textNode2);
} else {
return EmptyIterator.getInstance();
}
}
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.
*/
public NodeInfo getParent() {
return null;
}
/**
* Get the root node
* @return the NodeInfo representing the root of this tree
*/
public NodeInfo getRoot() {
return this;
}
/**
* Get the root (document) node
* @return the DocumentInfo representing the containing document
*/
public DocumentInfo getDocumentRoot() {
return this;
}
/**
* Copy the result tree fragment value to a given Outputter
*/
public void copy(Receiver out, int copyOptions)
throws XPathException {
out.characters(text);
}
/**
* Get the element with a given ID.
* @param id The unique ID of the required element
* @return null (this kind of tree contains no elements)
*/
public NodeInfo selectID(String id) {
return null;
}
/**
* Make an instance of the text node
*/
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, FingerprintedNode {
/**
* 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(FastStringBuffer buffer) {
buffer.append("tt");
buffer.append(Long.toString(getDocumentNumber()));
buffer.append("t1");
}
/**
* Get the system ID for the entity containing the node.
*/
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;
}
/**
* 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 "".
*/
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.
*/
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.
*/
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 "".
*/
public String getLocalPart() {
return "";
}
/**
* Determine whether the node has any children.
* @return <code>true</code> if this node has any attributes,
* <code>false</code> otherwise.
*/
public boolean hasChildNodes() {
return false;
}
/**
* 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.
* <p>The result is undefined for nodes other than elements and attributes.</p>
*
* @return the type annotation of the node.
* @see client.net.sf.saxon.ce.type.Type
*/
public int getTypeAnnotation() {
return -1;
}
/**
* Get the document number of the document containing this node. For a free-standing
* orphan node, just return the hashcode.
*/
public int 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.
* <p/>
* <p>For a node other than an element, the method returns null.</p>
*/
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer) {
return null;
}
/**
* Get the typed value of the item
*
* @return the typed value of the item. In general this will be a sequence
* @throws client.net.sf.saxon.ce.trans.XPathException
* where no typed value is available, e.g. for
* an element with complex content
*/
public AtomicValue getTypedValue() {
return new UntypedAtomicValue(text);
}
/**
* 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.
*/
public AxisIterator iterateAxis(byte axisNumber) {
switch (axisNumber) {
case Axis.ANCESTOR:
case Axis.PARENT:
case Axis.PRECEDING_OR_ANCESTOR:
return SingleNodeIterator.makeIterator(TextFragmentValue.this);
case Axis.ANCESTOR_OR_SELF:
NodeInfo[] nodes = {this, TextFragmentValue.this};
return new NodeArrayIterator(nodes);
case Axis.ATTRIBUTE:
case Axis.CHILD:
case Axis.DESCENDANT:
case Axis.FOLLOWING:
case Axis.FOLLOWING_SIBLING:
case Axis.NAMESPACE:
case Axis.PRECEDING:
case Axis.PRECEDING_SIBLING:
return EmptyIterator.getInstance();
case Axis.SELF:
case Axis.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.
*/
public AxisIterator iterateAxis( byte axisNumber, NodeTest nodeTest) {
switch (axisNumber) {
case Axis.ANCESTOR:
case Axis.PARENT:
case Axis.PRECEDING_OR_ANCESTOR:
return Navigator.filteredSingleton(TextFragmentValue.this, nodeTest);
case Axis.ANCESTOR_OR_SELF:
boolean matchesDoc = nodeTest.matches(TextFragmentValue.this);
boolean matchesText = nodeTest.matches(this);
if (matchesDoc && matchesText) {
NodeInfo[] nodes = {this, TextFragmentValue.this};
return new NodeArrayIterator(nodes);
} else if (matchesDoc && !matchesText) {
return SingleNodeIterator.makeIterator(TextFragmentValue.this);
} else if (matchesText && !matchesDoc) {
return SingleNodeIterator.makeIterator(this);
} else {
return EmptyIterator.getInstance();
}
case Axis.ATTRIBUTE:
case Axis.CHILD:
case Axis.DESCENDANT:
case Axis.FOLLOWING:
case Axis.FOLLOWING_SIBLING:
case Axis.NAMESPACE:
case Axis.PRECEDING:
case Axis.PRECEDING_SIBLING:
return EmptyIterator.getInstance();
case Axis.SELF:
case Axis.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.
*/
public NodeInfo getParent() {
return TextFragmentValue.this;
}
/**
* Get the root node
* @return the NodeInfo representing the root of this tree
*/
public NodeInfo getRoot() {
return TextFragmentValue.this;
}
/**
* Get the root (document) node
* @return the DocumentInfo representing the containing document
*/
public DocumentInfo getDocumentRoot() {
return TextFragmentValue.this;
}
/**
* Copy the node to a given Outputter
*/
public void copy(Receiver out, int copyOptions)
throws XPathException {
out.characters(text);
}
}
/**
* 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.
* @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, 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.
*/
public Object getUserData(String key) {
if (userData == null) {
return null;
} else {
return userData.get(key);
}
}
}
// 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.