net.sf.saxon.xpath
Class XPathFunctionCall
- EvaluableItem, InstructionInfoProvider, SequenceIterable, Serializable, SourceLocator
public class XPathFunctionCall
This class is an expression that calls an external function supplied using the
JAXP XPathFunction interface
addExternalFunctionCallToPathMap , checkArgumentCount , checkArguments , equals , explain , getArguments , getDisplayName , getFunctionName , getNumberOfArguments , hashCode , iterateSubExpressions , optimize , preEvaluate , promote , replaceSubExpression , setArguments , setFunctionName , simplify , simplifyArguments , toString , typeCheck |
addToPathMap , adoptChildExpression , checkPermittedContents , computeCardinality , computeDependencies , computeSpecialProperties , computeStaticProperties , copy , display , doPromotion , dynamicError , effectiveBooleanValue , evaluateAsString , evaluateItem , explain , explain , findParentOf , getCardinality , getColumnNumber , getConstructType , getContainer , getDependencies , getExecutable , getHostLanguage , getImplementationMethod , getInstructionInfo , getIntrinsicDependencies , getItemType , getLineNumber , getLocationId , getLocationProvider , getPublicId , getSlotsUsed , getSpecialProperties , getSystemId , hasLoopingSubexpression , implementsStaticTypeCheck , iterate , iterateEvents , iterateSubExpressions , markTailFunctionCalls , optimize , process , promote , replaceSubExpression , resetLocalStaticProperties , setContainer , setFiltered , setFlattened , setLocationId , simplify , staticTypeCheck , suppressValidation , toString , typeCheck , typeError |
XPathFunctionCall
public XPathFunctionCall(XPathFunction function)
Default constructor
addToPathMap
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap. The PathMap captures a map of the nodes visited
by an expression in a source tree.
The default implementation of this method assumes that an expression does no navigation other than
the navigation done by evaluating its subexpressions, and that the subexpressions are evaluated in the
same context as the containing expression. The method must be overridden for any expression
where these assumptions do not hold. For example, implementations exist for AxisExpression, ParentExpression,
and RootExpression (because they perform navigation), and for the doc(), document(), and collection()
functions because they create a new navigation root. Implementations also exist for PathExpression and
FilterExpression because they have subexpressions that are evaluated in a different context from the
calling expression.
- addToPathMap in interface Expression
pathMap
- the PathMap to which the expression should be addedpathMapNodeSet
-
- the pathMapNode representing the focus established by this expression, in the case where this
expression is the first operand of a path expression or filter expression. For an expression that does
navigation, it represents the end of the arc in the path map that describes the navigation route. For other
expressions, it is the same as the input pathMapNode.
computeCardinality
public int computeCardinality()
Determine the cardinality of the result
- computeCardinality in interface Expression
- ZERO_OR_MORE (we don't know)
copy
public Expression copy()
Copy an expression. This makes a deep copy.
- copy in interface Expression
- the copy of the original expression
getIntrinsicDependencies
public int getIntrinsicDependencies()
Determine which aspects of the context the expression depends on. XPath external
functions are given no access to context information so they cannot have any
dependencies on it.
- getIntrinsicDependencies in interface Expression
getItemType
public ItemType getItemType(TypeHierarchy th)
Determine the data type of the expression, if possible. All expressions return
sequences, in general; this method determines the type of the items within the
sequence, assuming that (a) this is known in advance, and (b) it is the same for
all items in the sequence.
This method will always return a result, though it may be the best approximation
that is available at the time.
- getItemType in interface Expression
th
- the type hierarchy cache
preEvaluate
public Expression preEvaluate(ExpressionVisitor visitor)
preEvaluate: this method suppresses compile-time evaluation by doing nothing
(because the external function might have side-effects and might use the context)
- preEvaluate in interface FunctionCall
visitor
- an expression visitor