net.sf.saxon.functions

Class DocumentFn

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.DocumentFn

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class DocumentFn
extends SystemFunction
implements Callable

Implements the XSLT document() function

Constructor Summary

Constructors

Constructor and Description
DocumentFn()

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	call(XPathContext context, Sequence[] arguments) Evaluate the expression
static DocumentURI	computeDocumentKey(String href, String baseURI, URIResolver resolver) Compute a document key (an absolute URI that can be used to see if a document is already loaded)
protected static DocumentURI	computeDocumentKey(String href, String baseURI, XPathContext c) Compute a document key
int	getCardinality(Expression[] arguments) Determine the static cardinality
int	getSpecialProperties(Expression[] arguments) Get the static properties of this expression (other than its type).
static NodeInfo	makeDoc(String href, String baseURI, ParseOptions options, XPathContext c, Location locator, boolean silent) Supporting routine to load one external document given a URI (href) and a baseURI.
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, XPathContext context) Call the URIResolver to resolve a URI
static void	sendDoc(String href, String baseURL, XPathContext c, Location locator, Receiver out, ParseOptions parseOptions) Supporting routine to push one external document given a URI (href) and a baseURI to a given Receiver.
void	sendDocuments(XPathContext context, Expression[] args, Receiver out) Copy the documents identified by this expression to a given Receiver.

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

equals, export, exportAttributes, getArity, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getExpressionCompiler, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getStreamingAdjunct, importAttributes, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.Function

iterate

Methods inherited from interface net.sf.saxon.om.Item

head

Methods inherited from interface net.sf.saxon.om.GroundedValue

getLength, head, itemAt, reduce, subsequence

Constructor Detail

DocumentFn

public DocumentFn()

Method Detail

getCardinality

public int getCardinality(Expression[] arguments)

Determine the static cardinality

Overrides:

getCardinality in class SystemFunction

Parameters:

arguments - the actual arguments supplied

Returns:

the most precise available cardinality that the function will return

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

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:

getSpecialProperties in class SystemFunction

Parameters:

arguments -

call

public Sequence call(XPathContext context,
            Sequence[] arguments)
              throws XPathException

Evaluate the expression

Specified by:

call in interface Callable

Specified by:

call in interface Function

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as SequenceIterators

Returns:

the result of the evaluation, in the form of a SequenceIterator

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

makeDoc

public static NodeInfo makeDoc(String href,
               String baseURI,
               ParseOptions options,
               XPathContext c,
               Location locator,
               boolean silent)
                        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

options - parse options to be used. May be null.

c - the dynamic XPath context

locator - used to identify the location of the instruction in event of error

silent - if true, errors should not be notified to the ErrorListener @return the root of the constructed document, or the selected element within the document if a fragment identifier was supplied

Throws:

XPathException - if reading or parsing the document fails

resolveURI

public static Source resolveURI(String href,
                String baseURI,
                String documentKey,
                XPathContext context)
                         throws XPathException

Call the URIResolver to resolve a URI

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

context - the dynamic context

Returns:

a Source representing the document to be read

Throws:

XPathException

computeDocumentKey

protected static DocumentURI computeDocumentKey(String href,
                             String baseURI,
                             XPathContext c)
                                         throws XPathException

Compute a document key

Throws:

XPathException

computeDocumentKey

public static DocumentURI computeDocumentKey(String href,
                             String baseURI,
                             URIResolver resolver)
                                      throws XPathException

Compute a document key (an absolute URI that can be used to see if a document is already loaded)

Parameters:

href - the relative URI

baseURI - the base URI

resolver - the URIResolver

Throws:

XPathException

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. May be null.

Returns:

the root of the constructed document, or the selected element within the document if a fragment identifier was supplied

Throws:

XPathException

sendDocuments

public void sendDocuments(XPathContext context,
                 Expression[] args,
                 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

args - the arguments to the document() function

out - the destination to which the documents will be sent

Throws:

XPathException

sendDoc

public static void sendDoc(String href,
           String baseURL,
           XPathContext c,
           Location locator,
           Receiver out,
           ParseOptions parseOptions)
                    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

Throws:

XPathException