net.sf.saxon.instruct
public class UserFunctionParameter extends Object implements Binding, Serializable
Constructor Summary | |
---|---|
UserFunctionParameter()
Create a UserFunctionParameter |
Method Summary | |
---|---|
ValueRepresentation | evaluateVariable(XPathContext context)
Evaluate this function parameter |
int | getLocalSlotNumber()
If this is a local variable held on the local stack frame, return the corresponding slot number.
|
int | getReferenceCount()
Get the (nominal) number of references within the function body to this parameter, where a reference
inside a loop is counted as multiple references |
SequenceType | getRequiredType()
Get the required type of this function parameter |
StructuredQName | getVariableQName()
Get the name of this parameter |
boolean | isAssignable()
Test whether it is permitted to assign to the variable using the saxon:assign
extension element. |
boolean | isGlobal()
Indicate whether the binding is local or global. |
boolean | isIndexedVariable()
Ask whether this parameter requires support for indexing |
void | setIndexedVariable(boolean indexed)
Indicate that this parameter requires (or does not require) support for indexing |
void | setReferenceCount(int count)
Set the (nominal) number of references within the function body to this parameter, where a reference
inside a loop is counted as multiple references |
void | setRequiredType(SequenceType type)
Set the required type of this function parameter |
void | setSlotNumber(int slot)
Set the slot number to be used by this parameter |
void | setVariableQName(StructuredQName name)
Set the name of this parameter |
Parameters: context the XPath dynamic context
Returns: the value of the parameter
Throws: XPathException if an error occurs
Returns: the slot number, indicating the position of the parameter on the local stack frame
Returns: the nominal number of references
Returns: the declared type of the parameter
Returns: the name of this parameter
Returns: false (always)
Returns: false (always)
Returns: true if support for indexing is required. This will be set if the parameter is used in a filter expression such as $param[@a = 17]
Parameters: indexed true if support for indexing is required. This will be set if the parameter is used in a filter expression such as $param[@a = 17]
Parameters: count the nominal number of references
Parameters: type the declared type of the parameter
Parameters: slot the slot number, that is, the position of the parameter value within the local stack frame
Parameters: name the name of the parameter