net.sf.saxon.functions
Class Doc

java.lang.Object
  net.sf.saxon.expr.Expression
      net.sf.saxon.expr.FunctionCall
          net.sf.saxon.functions.SystemFunction
              net.sf.saxon.functions.Doc

All Implemented Interfaces:

Serializable, SourceLocator, Container, EvaluableItem, SequenceIterable, 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 inherited from class net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Doc()

Method Summary

void	checkArguments(StaticContext env) Method called during static type checking
int	computeCardinality() Determine the cardinality of the function.
int	computeSpecialProperties() Get the static properties of this expression (other than its type).
Item	evaluateItem(XPathContext context) Evaluate the expression
String	getStaticBaseURI() Get the static base URI of the expression
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 net.sf.saxon.functions.SystemFunction

display, getDetails, getErrorCodeForTypeErrors, getItemType, main, makeSystemFunction, optimize, setDetails

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Doc

public Doc()

Method Detail

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

getStaticBaseURI

public String getStaticBaseURI()

Get the static base URI of the expression

preEvaluate

public Expression preEvaluate(StaticContext env)

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

Overrides:

preEvaluate in class FunctionCall

computeCardinality

public int computeCardinality()

Description copied from class: SystemFunction

Determine the cardinality of the function.

Overrides:

computeCardinality in class SystemFunction

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Evaluate the expression

Specified by:

evaluateItem in interface EvaluableItem

Overrides:

evaluateItem in class Expression

Parameters:

context -

Returns:

the result of evaluating the expression (a document node)

Throws:

XPathException

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