|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.expr.instruct.UserFunctionParameter
public class UserFunctionParameter
Run-time object representing a formal argument to a user-defined function
Constructor Summary | |
---|---|
UserFunctionParameter()
Create a UserFunctionParameter |
Method Summary | |
---|---|
void |
addReference(boolean isLoopingReference)
Register a variable reference that refers to the variable bound in this expression |
ValueRepresentation |
evaluateVariable(XPathContext context)
Evaluate this function parameter |
IntegerValue[] |
getIntegerBoundsForVariable()
If the variable is bound to an integer, get the minimum and maximum possible values. |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserFunctionParameter()
Method Detail |
---|
public final boolean isGlobal()
isGlobal
in interface Binding
public final boolean isAssignable()
isAssignable
in interface Binding
public void setSlotNumber(int slot)
slot
- the slot number, that is, the position of the parameter value within the local stack framepublic int getLocalSlotNumber()
getLocalSlotNumber
in interface Binding
public void setRequiredType(SequenceType type)
type
- the declared type of the parameterpublic SequenceType getRequiredType()
getRequiredType
in interface Binding
public IntegerValue[] getIntegerBoundsForVariable()
getIntegerBoundsForVariable
in interface Binding
public void setVariableQName(StructuredQName name)
name
- the name of the parameterpublic StructuredQName getVariableQName()
getVariableQName
in interface Binding
public void addReference(boolean isLoopingReference)
Binding
addReference
in interface Binding
isLoopingReference
- - true if the reference occurs within a loop, such as the predicate
of a filter expressionpublic void setReferenceCount(int count)
count
- the nominal number of referencespublic int getReferenceCount()
public void setIndexedVariable(boolean indexed)
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]public boolean isIndexedVariable()
public ValueRepresentation evaluateVariable(XPathContext context) throws XPathException
evaluateVariable
in interface Binding
context
- the XPath dynamic context
XPathException
- if an error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |