Package net.sf.saxon.query
Class GlobalVariableDefinition
java.lang.Object
net.sf.saxon.query.GlobalVariableDefinition
- All Implemented Interfaces:
SourceLocator
,VariableDeclaration
,Declaration
- Direct Known Subclasses:
UndeclaredVariable
Class to hold compile-time information about an XQuery global variable
or parameter
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncompile
(Executable exec, int slot) Create a compiled representation of this global variablevoid
Produce diagnostic output showing the compiled and optimized expression tree for a functionvoid
fixupReference
(BindingReference ref, TypeHierarchy th) Notify a reference to this variable of the data typeint
Get column numberGet the compiled variable if the definition has been compiledint
Get the line number where the declaration appearsGet public identifierGet the required type of the variableGet the system ID of the module containing the variable declarationGet the variable nameIterate over the references to this variablevoid
Register a variable reference that refers to this global variablevoid
setIsParameter
(boolean b) Indicate whether this global variable is a "parameter" (an external variable, in XQuery terminology)void
setLineNumber
(int lineNumber) Set the line number where the variable declaration appears in the sourcevoid
setRequiredType
(SequenceType type) Set the required type of the variablevoid
setSystemId
(String systemId) Set the system ID of the module where the variable declaration appearsvoid
Set the expression used to define the value of the variablevoid
setVariableQName
(StructuredQName qName) Set the variable namevoid
typeCheck
(ExpressionVisitor visitor) Type check the compiled representation of this global variable
-
Field Details
-
references
-
-
Constructor Details
-
GlobalVariableDefinition
public GlobalVariableDefinition()
-
-
Method Details
-
setRequiredType
Set the required type of the variable- Parameters:
type
- the declared type, from the "as" clause if present
-
getRequiredType
Get the required type of the variable- Returns:
- the declared type, from the "as" clause if present
-
setVariableQName
Set the variable name- Parameters:
qName
- the variable name
-
getVariableQName
Get the variable name- Specified by:
getVariableQName
in interfaceVariableDeclaration
- Returns:
- the variable name
-
setLineNumber
public void setLineNumber(int lineNumber) Set the line number where the variable declaration appears in the source- Parameters:
lineNumber
- the line number
-
getLineNumber
public int getLineNumber()Get the line number where the declaration appears- Specified by:
getLineNumber
in interfaceSourceLocator
-
getColumnNumber
public int getColumnNumber()Get column number- Specified by:
getColumnNumber
in interfaceSourceLocator
- Returns:
- -1 always
-
getPublicId
Get public identifier- Specified by:
getPublicId
in interfaceSourceLocator
- Returns:
- null always
-
setSystemId
Set the system ID of the module where the variable declaration appears- Parameters:
systemId
- the System ID (base URI)
-
getSystemId
Get the system ID of the module containing the variable declaration- Specified by:
getSystemId
in interfaceSourceLocator
- Returns:
- the System ID (base URI)
-
setValueExpression
Set the expression used to define the value of the variable- Parameters:
val
- the initializing expression
-
setIsParameter
public void setIsParameter(boolean b) Indicate whether this global variable is a "parameter" (an external variable, in XQuery terminology)- Parameters:
b
- true if this variable is external
-
registerReference
Register a variable reference that refers to this global variable- Specified by:
registerReference
in interfaceVariableDeclaration
- Parameters:
ref
- the variable reference
-
iterateReferences
Iterate over the references to this variable- Returns:
- an iterator over the references: returns objects of class
VariableReference
-
compile
Create a compiled representation of this global variable- Parameters:
exec
- the executableslot
- the slot number allocated to this variable- Returns:
- the compiled representation
- Throws:
XPathException
- if compile-time errors are found.
-
fixupReference
Notify a reference to this variable of the data type- Parameters:
ref
- the variable referenceth
- the type hierarchy cache- Throws:
XPathException
-
typeCheck
Type check the compiled representation of this global variable- Parameters:
visitor
- an expression visitor- Throws:
XPathException
- if compile-time errors are found.
-
getCompiledVariable
Get the compiled variable if the definition has been compiled- Returns:
- the compiled global variable
-
explain
Produce diagnostic output showing the compiled and optimized expression tree for a function- Parameters:
out
- the destination to be used
-