GlobalVariableDefinition

java.lang.Object
- net.sf.saxon.query.GlobalVariableDefinition

All Implemented Interfaces:

javax.xml.transform.SourceLocator, VariableDeclaration, Declaration

Direct Known Subclasses:

UndeclaredVariable
```
public class GlobalVariableDefinition
extends java.lang.Object
implements VariableDeclaration, Declaration
```
Class to hold compile-time information about an XQuery global variable or parameter

Field Summary

Fields
Modifier and Type Field Description

protected java.util.List references

Fields
Modifier and Type	Field	Description
`protected java.util.List`	`references`

Constructor Summary

Constructors
Constructor Description

GlobalVariableDefinition()

Constructors
Constructor	Description
`GlobalVariableDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GlobalVariable`	`compile(Executable exec, int slot)`	Create a compiled representation of this global variable
`void`	`explain(ExpressionPresenter out)`	Produce diagnostic output showing the compiled and optimized expression tree for a function
`void`	`fixupReference(BindingReference ref, TypeHierarchy th)`	Notify a reference to this variable of the data type
`int`	`getColumnNumber()`	Get column number
`GlobalVariable`	`getCompiledVariable()`	Get the compiled variable if the definition has been compiled
`int`	`getLineNumber()`	Get the line number where the declaration appears
`java.lang.String`	`getPublicId()`	Get public identifier
`SequenceType`	`getRequiredType()`	Get the required type of the variable
`java.lang.String`	`getSystemId()`	Get the system ID of the module containing the variable declaration
`StructuredQName`	`getVariableQName()`	Get the variable name
`java.util.Iterator`	`iterateReferences()`	Iterate over the references to this variable
`void`	`registerReference(BindingReference ref)`	Register a variable reference that refers to this global variable
`void`	`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 source
`void`	`setRequiredType(SequenceType type)`	Set the required type of the variable
`void`	`setSystemId(java.lang.String systemId)`	Set the system ID of the module where the variable declaration appears
`void`	`setValueExpression(Expression val)`	Set the expression used to define the value of the variable
`void`	`setVariableQName(StructuredQName qName)`	Set the variable name
`void`	`typeCheck(ExpressionVisitor visitor)`	Type check the compiled representation of this global variable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - references
```
protected java.util.List references
```
- Constructor Detail
  - GlobalVariableDefinition
```
public GlobalVariableDefinition()
```
- Method Detail
  - setRequiredType
```
public void setRequiredType(SequenceType type)
```
    Set the required type of the variable
    
    Parameters:
    
    type - the declared type, from the "as" clause if present
  - getRequiredType
```
public SequenceType getRequiredType()
```
    Get the required type of the variable
    
    Returns:
    
    the declared type, from the "as" clause if present
  - setVariableQName
```
public void setVariableQName(StructuredQName qName)
```
    Set the variable name
    
    Parameters:
    
    qName - the variable name
  - getVariableQName
```
public StructuredQName getVariableQName()
```
    Get the variable name
    
    Specified by:
    
    getVariableQName in interface VariableDeclaration
    
    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 interface javax.xml.transform.SourceLocator
  - getColumnNumber
```
public int getColumnNumber()
```
    Get column number
    
    Specified by:
    
    getColumnNumber in interface javax.xml.transform.SourceLocator
    
    Returns:
    
    -1 always
  - getPublicId
```
public java.lang.String getPublicId()
```
    Get public identifier
    
    Specified by:
    
    getPublicId in interface javax.xml.transform.SourceLocator
    
    Returns:
    
    null always
  - setSystemId
```
public void setSystemId(java.lang.String systemId)
```
    Set the system ID of the module where the variable declaration appears
    
    Parameters:
    
    systemId - the System ID (base URI)
  - getSystemId
```
public java.lang.String getSystemId()
```
    Get the system ID of the module containing the variable declaration
    
    Specified by:
    
    getSystemId in interface javax.xml.transform.SourceLocator
    
    Returns:
    
    the System ID (base URI)
  - setValueExpression
```
public void setValueExpression(Expression val)
```
    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
```
public void registerReference(BindingReference ref)
```
    Register a variable reference that refers to this global variable
    
    Specified by:
    
    registerReference in interface VariableDeclaration
    
    Parameters:
    
    ref - the variable reference
  - iterateReferences
```
public java.util.Iterator iterateReferences()
```
    Iterate over the references to this variable
    
    Returns:
    
    an iterator over the references: returns objects of class VariableReference
  - compile
```
public GlobalVariable compile(Executable exec,
                              int slot)
                       throws XPathException
```
    Create a compiled representation of this global variable
    
    Parameters:
    
    exec - the executable
    
    slot - the slot number allocated to this variable
    
    Returns:
    
    the compiled representation
    
    Throws:
    
    XPathException - if compile-time errors are found.
  - fixupReference
```
public void fixupReference(BindingReference ref,
                           TypeHierarchy th)
                    throws XPathException
```
    Notify a reference to this variable of the data type
    
    Parameters:
    
    ref - the variable reference
    
    th - the type hierarchy cache
    
    Throws:
    
    XPathException
  - typeCheck
```
public void typeCheck(ExpressionVisitor visitor)
               throws XPathException
```
    Type check the compiled representation of this global variable
    
    Parameters:
    
    visitor - an expression visitor
    
    Throws:
    
    XPathException - if compile-time errors are found.
  - getCompiledVariable
```
public GlobalVariable getCompiledVariable()
```
    Get the compiled variable if the definition has been compiled
    
    Returns:
    
    the compiled global variable
  - explain
```
public void explain(ExpressionPresenter out)
```
    Produce diagnostic output showing the compiled and optimized expression tree for a function
    
    Parameters:
    
    out - the destination to be used

Class GlobalVariableDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

references

Constructor Detail

GlobalVariableDefinition

Method Detail

setRequiredType

getRequiredType

setVariableQName

getVariableQName

setLineNumber

getLineNumber

getColumnNumber

getPublicId

setSystemId

getSystemId

setValueExpression

setIsParameter

registerReference

iterateReferences

compile

fixupReference

typeCheck

getCompiledVariable

explain