com.icl.saxon.functions

Class Key


public class Key
extends Function

Field Summary

Fields inherited from class com.icl.saxon.expr.Function

argument

Fields inherited from class com.icl.saxon.expr.Expression

staticContext

Method Summary

NodeEnumeration
enumerate(Context context, boolean sorted)
Enumerate the expression
Value
evaluate(Context context)
Evaluate the expression
int
getDataType()
Determine the data type of the expression
int
getDependencies()
Determine which aspects of the context the expression depends on.
String
getName()
boolean
isContextDocumentNodeSet()
Determine, in the case of an expression whose data type is Value.NODESET, whether all the nodes in the node-set are guaranteed to come from the same document as the context node.
Expression
reduce(int dep, Context context)
Remove specified dependencies.
Expression
simplify()
Simplify and validate

Methods inherited from class com.icl.saxon.expr.Function

addArgument, checkArgumentCount, display, getName, getNumberOfArguments

Methods inherited from class com.icl.saxon.expr.Expression

containsReferences, display, enumerate, evaluate, evaluateAsBoolean, evaluateAsNodeSet, evaluateAsNumber, evaluateAsString, getDataType, getDependencies, getStaticContext, indent, isContextDocumentNodeSet, make, outputStringValue, reduce, setStaticContext, simplify, usesCurrent

Method Details

enumerate

public NodeEnumeration enumerate(Context context,
                                 boolean sorted)
            throws XPathException
Enumerate the expression
Overrides:
enumerate in interface Expression


evaluate

public Value evaluate(Context context)
            throws XPathException
Evaluate the expression
Overrides:
evaluate in interface Expression


getDataType

public int getDataType()
Determine the data type of the expression
Overrides:
getDataType in interface Expression

Returns:
Value.NODESET


getDependencies

public int getDependencies()
Determine which aspects of the context the expression depends on. The result is a bitwise-or'ed value composed from constants such as Context.VARIABLES and Context.CURRENT_NODE
Overrides:
getDependencies in interface Expression


getName

public String getName()
Overrides:
getName in interface Function


isContextDocumentNodeSet

public boolean isContextDocumentNodeSet()
Determine, in the case of an expression whose data type is Value.NODESET, whether all the nodes in the node-set are guaranteed to come from the same document as the context node. Used for optimization.
Overrides:
isContextDocumentNodeSet in interface Expression


reduce

public Expression reduce(int dep,
                         Context context)
            throws XPathException
Remove specified dependencies.
Overrides:
reduce in interface Expression


simplify

public Expression simplify()
            throws XPathException
Simplify and validate
Overrides:
simplify in interface Expression