Package net.sf.saxon.functions
Class Evaluate
java.lang.Object
net.sf.saxon.expr.ComputedExpression
net.sf.saxon.expr.FunctionCall
net.sf.saxon.functions.SystemFunction
net.sf.saxon.functions.Evaluate
- All Implemented Interfaces:
Serializable
,SourceLocator
,Container
,Expression
,InstructionInfoProvider
This class implements the saxon:evaluate(), saxon:expression(), and saxon:eval() extension functions,
which are specially-recognized by the system because they need access to parts of the static context
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Inner class PreparedExpression represents a compiled XPath expression together with the standard variables $p1 .. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) InstructionDetails
static final int
static final int
static final int
static final int
(package private) IndependentContext
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.ComputedExpression
locationId, staticProperties
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Method supplied by each class of function to check arguments during parsing, when all the argument expressions have been readEvaluate in a general contextint
Determine the dependenciesprotected SequenceType
getRequiredType
(int arg) Get the required type of the nth argumentIterate over the results of the functionpreEvaluate
(StaticContext env) preEvaluate: for saxon:expression, if the expression is known at compile time, then it is compiled at compile time.Methods inherited from class net.sf.saxon.functions.SystemFunction
addContextDocumentArgument, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getItemType, main, makeSystemFunction, setDetails, useContextItemAsDefault
Methods inherited from class net.sf.saxon.expr.FunctionCall
checkArgumentCount, getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, optimize, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplify, simplifyArguments, typeCheck
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
-
Field Details
-
staticContext
IndependentContext staticContext -
details
InstructionDetails details -
EVALUATE
public static final int EVALUATE- See Also:
-
EXPRESSION
public static final int EXPRESSION- See Also:
-
EVAL
public static final int EVAL- See Also:
-
EVALUATE_NODE
public static final int EVALUATE_NODE- See Also:
-
-
Constructor Details
-
Evaluate
public Evaluate()
-
-
Method Details
-
getRequiredType
Get the required type of the nth argument- Overrides:
getRequiredType
in classSystemFunction
-
checkArguments
Method supplied by each class of function to check arguments during parsing, when all the argument expressions have been read- Overrides:
checkArguments
in classSystemFunction
- Throws:
XPathException
-
preEvaluate
preEvaluate: for saxon:expression, if the expression is known at compile time, then it is compiled at compile time. In other cases this method suppresses compile-time evaluation by doing nothing (because the value of the expression depends on the runtime context).- Overrides:
preEvaluate
in classFunctionCall
- Throws:
XPathException
-
evaluateItem
Evaluate in a general context- Specified by:
evaluateItem
in interfaceExpression
- Overrides:
evaluateItem
in classComputedExpression
- Parameters:
c
- 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
-
iterate
Iterate over the results of the function- Specified by:
iterate
in interfaceExpression
- Overrides:
iterate
in classComputedExpression
- Parameters:
c
- supplies the context for evaluation- Returns:
- a SequenceIterator that can be used to iterate over the result of the expression
- Throws:
XPathException
- if any dynamic error occurs evaluating the expression
-
getIntrinsicDependencies
public int getIntrinsicDependencies()Determine the dependencies- Overrides:
getIntrinsicDependencies
in classComputedExpression
- Returns:
- a set of bit-significant flags identifying the "intrinsic" dependencies. The flags are documented in class net.sf.saxon.value.StaticProperty
-