net.sf.saxon.functions
Class CompileTimeFunction

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

All Implemented Interfaces:

Serializable, SourceLocator, Container, EvaluableItem, SequenceIterable, InstructionInfoProvider

Direct Known Subclasses:

AnalyzeStringFunction, Data, DefaultCollation, DynamicFunction, Reverse, StaticBaseURI, Unordered

public abstract class CompileTimeFunction
extends SystemFunction

Abtract class representing a function call that is always rewritten at compile-time: it can never be executed

See Also:

Serialized Form

Field Summary

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

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

CompileTimeFunction()

Method Summary

Item	evaluateItem(XPathContext c) Evaluate as a single item
SequenceIterator	iterate(XPathContext c) Iterate over the results of the function
Expression	preEvaluate(StaticContext env) preEvaluate: this method suppresses compile-time evaluation by doing nothing.

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

checkArguments, computeCardinality, computeSpecialProperties, 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, 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

CompileTimeFunction

public CompileTimeFunction()

Method Detail

preEvaluate

public Expression preEvaluate(StaticContext env)
                       throws XPathException

preEvaluate: this method suppresses compile-time evaluation by doing nothing. (this is because the default implementation of preEvaluate() calls evaluate() which is not available for these functions)

Overrides:

preEvaluate in class FunctionCall

Throws:

XPathException

evaluateItem

public final Item evaluateItem(XPathContext c)
                        throws XPathException

Evaluate as a single item

Specified by:

evaluateItem in interface EvaluableItem

Overrides:

evaluateItem in class Expression

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

public final SequenceIterator iterate(XPathContext c)

Iterate over the results of the function

Specified by:

iterate in interface SequenceIterable

Overrides:

iterate in class Expression

Parameters:

c - supplies the context for evaluation

Returns:

a SequenceIterator that can be used to iterate over the result of the expression