net.sf.saxon.functions
public class Document extends SystemFunction
Method Summary | |
---|---|
PathMap.PathMapNodeSet | addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap. |
void | checkArguments(ExpressionVisitor visitor) |
int | computeCardinality()
Determine the static cardinality |
protected static String | computeDocumentKey(String href, String baseURI, XPathContext c)
Compute a document key |
int | computeSpecialProperties()
Get the static properties of this expression (other than its type). |
Expression | copy()
Copy an expression. |
String | getStaticBaseURI()
Get the base URI from the static context |
boolean | isReadOnce()
Ask whether this document has been marked as being read once only. |
SequenceIterator | iterate(XPathContext context)
iterate() handles evaluation of the function:
it returns a sequence of Document nodes |
static NodeInfo | makeDoc(String href, String baseURI, XPathContext c, SourceLocator locator)
Supporting routine to load one external document given a URI (href) and a baseURI. |
Expression | preEvaluate(ExpressionVisitor visitor)
preEvaluate: the document() function can be evaluated at compile time if (a) the argument
is a string literal, and (b) the option PRE_EVALUATE_DOC_FUNCTION is set. |
static NodeInfo | preLoadDoc(String href, String baseURI, Configuration config, SourceLocator locator)
Supporting routine to load one external document given a URI (href) and a baseURI. |
static Source | resolveURI(String href, String baseURI, String documentKey, Controller controller)
Call the URIResolver to resolve a URI |
static void | sendDoc(String href, String baseURL, XPathContext c, SourceLocator locator, Receiver out)
Supporting routine to push one external document given a URI (href) and a baseURI to a given Receiver.
|
void | sendDocuments(XPathContext context, Receiver out)
Copy the documents identified by this expression to a given Receiver. |
void | setReadOnce(boolean once)
Indicate that the document(s) will be read once only (or that they should be treated as if they
are read once only. |
Parameters: pathMap the PathMap to which the expression should be added pathMapNodeSet the set of nodes in the path map that are affected
Returns: the pathMapNode representing the focus established by this expression, in the case where this expression is the first operand of a path expression or filter expression
Returns: the copy of the original expression
Returns: the base URI
Returns: true if the document has been marked as being read once only
Parameters: href the relative URI baseURI the base URI c the dynamic XPath context locator used to identify the location of the instruction in event of error
Returns: the root of the constructed document, or the selected element within the document if a fragment identifier was supplied
Parameters: visitor an expression visitor
Parameters: href the relative URI. This must not contain a fragment identifier baseURI the base URI config the Saxon configuration locator used to identify the location of the instruction in event of error. May be null.
Returns: the root of the constructed document, or the selected element within the document if a fragment identifier was supplied
Parameters: href the supplied relative URI, stripped of any fragment identifier baseURI the base URI documentKey the absolute URI if already available, or null otherwise controller the Saxon controller
Returns: a Source representing the document to be read
Throws: XPathException
Parameters: href the relative URI baseURL the base URI c the XPath dynamic context locator used to identify the lcoation of the instruction in case of error out the destination where the document is to be sent
Parameters: context the XPath dynamic context out the destination to which the documents will be sent
Parameters: once true if this document is to be treated as being read once only