Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.expr.Expression
net.sf.saxon.expr.SuppliedParameterReference
public class SuppliedParameterReference
extends Expression
Field Summary |
Fields inherited from class net.sf.saxon.expr.Expression | |
EVALUATE_METHOD , ITERATE_METHOD , PROCESS_METHOD , locationId , staticProperties |
Constructor Summary | |
|
Method Summary | |
int |
|
Expression |
|
boolean |
|
Item |
|
void |
|
ItemType |
|
SequenceIterator |
|
Expression |
|
Expression |
|
public SuppliedParameterReference(int slot)
Constructor
- Parameters:
slot
- identifies this parameter
public int computeCardinality()
Get the static cardinality
- Overrides:
- computeCardinality in interface Expression
- Returns:
- ZERO_OR_MORE, because we don't know the type of the supplied value in advance.
public Expression copy()
Copy an expression. This makes a deep copy.
- Overrides:
- copy in interface Expression
- Returns:
- the copy of the original expression
public boolean equals(Object other)
Test if this expression is the same as another expression. (Note, we only compare expressions that have the same static and dynamic context).
public Item evaluateItem(XPathContext c) throws XPathException
Evaluate an expression as a single item. This always returns either a single Item or null (denoting the empty sequence). No conversion is done. This method should not be used unless the static type of the expression is a subtype of "item" or "item?": that is, it should not be called if the expression may return a sequence. There is no guarantee that this condition will be detected.
- Specified by:
- evaluateItem in interface EvaluableItem
- Overrides:
- evaluateItem in interface Expression
- Parameters:
- 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
public void explain(ExpressionPresenter destination)
Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
- Overrides:
- explain in interface Expression
public ItemType getItemType(TypeHierarchy th)
Determine the data type of the expression, if possible.
- Overrides:
- getItemType in interface Expression
- Parameters:
th
- the type hierarchy cache
- Returns:
- Type.ITEM, because we don't know the type of the supplied value in advance.
public SequenceIterator iterate(XPathContext c) throws XPathException
Get the value of this expression in a given context.
- Specified by:
- iterate in interface SequenceIterable
- Overrides:
- iterate in interface Expression
- Parameters:
c
- the XPathContext which contains the relevant variable bindings
- Returns:
- the value of the variable, if it is defined
- Throws:
XPathException
- if the variable is undefined
public Expression optimize(ExpressionVisitor visitor, ItemType contextItemType) throws XPathException
Perform optimisation of an expression and its subexpressions. This is the third and final phase of static optimization. This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.
- Overrides:
- optimize in interface Expression
- Parameters:
visitor
- an expression visitorcontextItemType
- the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set toType.ITEM_TYPE
- Returns:
- the original expression, rewritten if appropriate to optimize execution
- Throws:
XPathException
- if an error is discovered during this phase (typically a type error)
public Expression typeCheck(ExpressionVisitor visitor, ItemType contextItemType) throws XPathException
Perform type checking of an expression and its subexpressions. This is the second phase of static optimization. This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression. This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables may not be accurately known if they have not been explicitly declared. If the implementation returns a value other than "this", then it is required to ensure that the parent pointer and location information in the returned expression have been set up correctly. It should not rely on the caller to do this, although for historical reasons many callers do so.
- Overrides:
- typeCheck in interface Expression
- Parameters:
visitor
- an expression visitorcontextItemType
- the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set toType.ITEM_TYPE
- Returns:
- the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
- Throws:
XPathException
- if an error is discovered during this phase (typically a type error)