net.sf.saxon.functions

Class Document

Implemented Interfaces:
SequenceIterable, Serializable, EvaluableItem, InstructionInfoProvider, SourceLocator, XSLTFunction

public class Document
extends SystemFunction
implements XSLTFunction

Implements the XSLT document() function

Field Summary

Fields inherited from class net.sf.saxon.functions.SystemFunction

operation

Fields inherited from class net.sf.saxon.expr.FunctionCall

argument

Fields inherited from class net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD, locationId, staticProperties

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
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
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: this method suppresses compile-time evaluation by doing nothing
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 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.

Methods inherited from class net.sf.saxon.functions.SystemFunction

addContextDocumentArgument, addDocToPathMap, checkArguments, computeCardinality, computeSpecialProperties, copy, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault

Methods inherited from class net.sf.saxon.expr.FunctionCall

addExternalFunctionCallToPathMap, checkArgumentCount, checkArguments, equals, explain, getArguments, getDisplayName, getFunctionName, getNumberOfArguments, hashCode, iterateSubExpressions, optimize, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionName, simplify, simplifyArguments, toString, typeCheck

Methods inherited from class net.sf.saxon.expr.Expression

addToPathMap, adoptChildExpression, checkPermittedContents, computeCardinality, computeDependencies, computeSpecialProperties, computeStaticProperties, copy, display, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, explain, explain, findParentOf, getCardinality, getColumnNumber, getConstructType, getContainer, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getItemType, getLineNumber, getLocationId, getLocationProvider, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, iterate, iterateEvents, iterateSubExpressions, markTailFunctionCalls, optimize, process, promote, replaceSubExpression, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, simplify, staticTypeCheck, suppressValidation, toString, typeCheck, typeError

Method Details

addToPathMap

public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap,
                                           PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap. The PathMap captures a map of the nodes visited by an expression in a source tree.
Overrides:
addToPathMap in interface Expression
Parameters:
pathMap - the PathMap to which the expression should be added
pathMapNodeSet -
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

checkArguments

public void checkArguments(ExpressionVisitor visitor)
            throws XPathException
Overrides:
checkArguments in interface SystemFunction

computeCardinality

public int computeCardinality()
Determine the static cardinality
Overrides:
computeCardinality in interface SystemFunction

computeSpecialProperties

public int computeSpecialProperties()
Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.
Overrides:
computeSpecialProperties in interface SystemFunction

copy

public Expression copy()
Copy an expression. This makes a deep copy.
Overrides:
copy in interface SystemFunction
Returns:
the copy of the original expression

getStaticBaseURI

public String getStaticBaseURI()
Get the base URI from the static context
Returns:
the base URI

iterate

public SequenceIterator iterate(XPathContext context)
            throws XPathException
iterate() handles evaluation of the function: it returns a sequence of Document nodes
Specified by:
iterate in interface SequenceIterable
Overrides:
iterate in interface Expression

makeDoc

public static NodeInfo makeDoc(String href,
                               String baseURI,
                               XPathContext c,
                               SourceLocator locator)
            throws XPathException
Supporting routine to load one external document given a URI (href) and a baseURI. This is used in the normal case when a document is loaded at run-time (that is, when a Controller is available)
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

preEvaluate

public Expression preEvaluate(ExpressionVisitor visitor)
preEvaluate: this method suppresses compile-time evaluation by doing nothing
Overrides:
preEvaluate in interface FunctionCall
Parameters:
visitor - an expression visitor

preLoadDoc

public static NodeInfo preLoadDoc(String href,
                                  String baseURI,
                                  Configuration config,
                                  SourceLocator locator)
            throws XPathException
Supporting routine to load one external document given a URI (href) and a baseURI. This is used when the document is pre-loaded at compile time.
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
Returns:
the root of the constructed document, or the selected element within the document if a fragment identifier was supplied

sendDoc

public static void sendDoc(String href,
                           String baseURL,
                           XPathContext c,
                           SourceLocator locator,
                           Receiver out)
            throws XPathException
Supporting routine to push one external document given a URI (href) and a baseURI to a given Receiver. This method cannot handle fragment identifiers
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

sendDocuments

public void sendDocuments(XPathContext context,
                          Receiver out)
            throws XPathException
Copy the documents identified by this expression to a given Receiver. This method is used only when it is known that the documents are being copied, because there is then no problem about node identity.
Parameters:
context - the XPath dynamic context
out - the destination to which the documents will be sent