Class Doc

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.Doc

All Implemented Interfaces:

Serializable, SourceLocator, Container, Expression, InstructionInfoProvider

public class Doc
extends SystemFunction

Implement the fn:doc() function - a simplified form of the Document function

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DOC
static final int	DOC_AVAILABLE

Fields inherited from class SystemFunction

operation

Fields inherited from class FunctionCall

argument

Fields inherited from class ComputedExpression

locationId, staticProperties

Fields inherited from interface Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Constructors

Constructor	Description
Doc()

Method Summary

Modifier and Type	Method	Description
void	checkArguments(StaticContext env)	Method called during static type checking
int	computeSpecialProperties()	Get the static properties of this expression (other than its type).
Item	evaluateItem(XPathContext context)	Evaluate an expression as a single item.
Expression	preEvaluate(StaticContext env)	preEvaluate: this method suppresses compile-time evaluation by doing nothing
void	sendDocument(XPathContext context, Receiver out)	Copy the document identified by this expression to a given Receiver.

Methods inherited from class SystemFunction

addContextDocumentArgument, computeCardinality, display, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, main, makeSystemFunction, setDetails, useContextItemAsDefault

Methods inherited from class FunctionCall

checkArgumentCount, getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, optimize, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplify, simplifyArguments, typeCheck

Methods inherited from class ComputedExpression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterate, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError

Methods inherited from class Object

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

Field Details

DOC

public static final int DOC

See Also:

• Constant Field Values

DOC_AVAILABLE

public static final int DOC_AVAILABLE

See Also:

• Constant Field Values

Constructor Details

Doc

public Doc()

Method Details

checkArguments

public void checkArguments(StaticContext env)
                    throws XPathException

Description copied from class: SystemFunction

Method called during static type checking

Overrides:

checkArguments in class SystemFunction

Throws:

XPathException

preEvaluate

public Expression preEvaluate(StaticContext env)

preEvaluate: this method suppresses compile-time evaluation by doing nothing

Overrides:

preEvaluate in class FunctionCall

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Description copied from class: ComputedExpression

Evaluate an expression as a single item. This always returns either a single Item or null (denoting the empty sequence). No conversion is done. This method should not be used unless the static type of the expression is a subtype of "item" or "item?": that is, it should not be called if the expression may return a sequence. There is no guarantee that this condition will be detected.

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

Parameters:

context - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

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 class SystemFunction

sendDocument

public void sendDocument(XPathContext context,
 Receiver out)
                  throws XPathException

Copy the document identified by this expression to a given Receiver. This method is used only when it is known that the document is being copied, because there is then no problem about node identity.

Throws:

XPathException