<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:11 GMT 2011 -->
<TITLE>
GlobalVariable
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GlobalVariable";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalParameterSet.html" title="class in net.sf.saxon.expr.instruct"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/instruct/Instruction.html" title="class in net.sf.saxon.expr.instruct"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/expr/instruct/GlobalVariable.html" target="_top"><B>FRAMES</B></A>
<A HREF="GlobalVariable.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_net.sf.saxon.expr.instruct.GeneralVariable">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.expr.instruct</FONT>
<BR>
Class GlobalVariable</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">net.sf.saxon.expr.instruct.GeneralVariable</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.expr.instruct.GlobalVariable</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true" title="class or interface in javax.xml.transform">SourceLocator</A>, <A HREF="../../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A>, <A HREF="../../../../../net/sf/saxon/event/SaxonLocator.html" title="interface in net.sf.saxon.event">SaxonLocator</A>, <A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A>, <A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A>, <A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalParam.html" title="class in net.sf.saxon.expr.instruct">GlobalParam</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>GlobalVariable</B><DT>extends <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A><DT>implements <A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A>, <A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></DL>
</PRE>
<P>
A compiled global variable in a stylesheet or query. <br>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#net.sf.saxon.expr.instruct.GlobalVariable">Serialized Form</A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_net.sf.saxon.expr.instruct.GeneralVariable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.expr.instruct.<A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#evaluationMode">evaluationMode</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#referenceCount">referenceCount</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#slotNumber">slotNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#variableQName">variableQName</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#GlobalVariable()">GlobalVariable</A></B>()</CODE>
<BR>
Create a global variable</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#actuallyEvaluate(net.sf.saxon.expr.XPathContext)">actuallyEvaluate</A></B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Evaluate the global variable, and save its value for use in subsequent references.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#evaluateVariable(net.sf.saxon.expr.XPathContext)">evaluateVariable</A></B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Evaluate the variable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getColumnNumber(long)">getColumnNumber</A></B>(long locationId)</CODE>
<BR>
Get the column number within the document, entity, or module containing a particular location</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getConstructType()">getConstructType</A></B>()</CODE>
<BR>
Get the type of construct.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getContainer()">getContainer</A></B>()</CODE>
<BR>
Get the container in which this expression is located.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getContainerGranularity()">getContainerGranularity</A></B>()</CODE>
<BR>
Get the granularity of the container.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/instruct/Executable.html" title="class in net.sf.saxon.expr.instruct">Executable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getExecutable()">getExecutable</A></B>()</CODE>
<BR>
Get the executable containing this global variable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getHostLanguage()">getHostLanguage</A></B>()</CODE>
<BR>
Get the host language (XSLT, XQuery, XPath) used to implement the code in this container</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getLineNumber(long)">getLineNumber</A></B>(long locationId)</CODE>
<BR>
Get the line number within the document, entity or module containing a particular location</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getObjectName()">getObjectName</A></B>()</CODE>
<BR>
Get a name identifying the object of the expression, for example a function name, template name,
variable name, key name, element name, etc.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getProperties()">getProperties</A></B>()</CODE>
<BR>
Get an iterator over all the properties available.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getProperty(java.lang.String)">getProperty</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Get the value of a particular property of the instruction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#getSelectValue(net.sf.saxon.expr.XPathContext)">getSelectValue</A></B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Evaluate the variable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#isGlobal()">isGlobal</A></B>()</CODE>
<BR>
Is this a global variable?</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#isIndexedVariable()">isIndexedVariable</A></B>()</CODE>
<BR>
Ask whether this is an indexed variable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#lookForCycles(java.util.Stack, net.sf.saxon.query.XQueryFunctionLibrary)">lookForCycles</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</A><<A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A>> referees,
<A HREF="../../../../../net/sf/saxon/query/XQueryFunctionLibrary.html" title="class in net.sf.saxon.query">XQueryFunctionLibrary</A> globalFunctionLibrary)</CODE>
<BR>
Check for cycles in this variable definition</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#setContainsLocals(net.sf.saxon.expr.instruct.SlotManager)">setContainsLocals</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> map)</CODE>
<BR>
The expression that initializes a global variable may itself use local variables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#setDependencies(net.sf.saxon.expr.instruct.Bindery, net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.expr.XPathContext)">setDependencies</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/Bindery.html" title="class in net.sf.saxon.expr.instruct">Bindery</A> bindery,
<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> var,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Get the variable that is immediately dependent on this one, and register the dependency, so
that circularities can be detected across threads.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#setExecutable(net.sf.saxon.expr.instruct.Executable)">setExecutable</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/Executable.html" title="class in net.sf.saxon.expr.instruct">Executable</A> executable)</CODE>
<BR>
Set the containing executable</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html#setIndexedVariable()">setIndexedVariable</A></B>()</CODE>
<BR>
Mark this as an indexed variable, to allow fast searching</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.expr.instruct.GeneralVariable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.expr.instruct.<A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#addReference(boolean)">addReference</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#checkAgainstRequiredType(net.sf.saxon.expr.parser.ExpressionVisitor)">checkAgainstRequiredType</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#computeEvaluationMode()">computeEvaluationMode</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#copy()">copy</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#explain(net.sf.saxon.trace.ExpressionPresenter)">explain</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getCardinality()">getCardinality</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getColumnNumber()">getColumnNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getEvaluationMode()">getEvaluationMode</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getInstructionNameCode()">getInstructionNameCode</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getIntegerBoundsForVariable()">getIntegerBoundsForVariable</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getLineNumber()">getLineNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getLocalSlotNumber()">getLocalSlotNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getLocationId()">getLocationId</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getLocationProvider()">getLocationProvider</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getPublicId()">getPublicId</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getRequiredType()">getRequiredType</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getSelectExpression()">getSelectExpression</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getSlotNumber()">getSlotNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getSystemId()">getSystemId</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getSystemId(long)">getSystemId</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getVariableQName()">getVariableQName</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#init(net.sf.saxon.expr.Expression, net.sf.saxon.om.StructuredQName)">init</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#isAssignable()">isAssignable</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#isImplicitlyRequiredParam()">isImplicitlyRequiredParam</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#isRequiredParam()">isRequiredParam</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#isTunnelParam()">isTunnelParam</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#iterateSubExpressions()">iterateSubExpressions</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#optimize(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)">optimize</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#replaceSubExpression(net.sf.saxon.expr.Expression, net.sf.saxon.expr.Expression)">replaceSubExpression</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setAssignable(boolean)">setAssignable</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setContainer(net.sf.saxon.expr.Container)">setContainer</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setImplicitlyRequiredParam(boolean)">setImplicitlyRequiredParam</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setLocationId(int)">setLocationId</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setReferenceCount(int)">setReferenceCount</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setRequiredParam(boolean)">setRequiredParam</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setRequiredType(net.sf.saxon.value.SequenceType)">setRequiredType</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setSelectExpression(net.sf.saxon.expr.Expression)">setSelectExpression</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setSlotNumber(int)">setSlotNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setTunnel(boolean)">setTunnel</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#setVariableQName(net.sf.saxon.om.StructuredQName)">setVariableQName</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#simplify(net.sf.saxon.expr.parser.ExpressionVisitor)">simplify</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)">typeCheck</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.expr.Container"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.expr.<A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html#getLocationProvider()">getLocationProvider</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.trace.InstructionInfo"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.trace.<A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html#getLineNumber()">getLineNumber</A>, <A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html#getSystemId()">getSystemId</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.xml.sax.Locator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.xml.sax.<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true" title="class or interface in org.xml.sax">Locator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true#getColumnNumber()" title="class or interface in org.xml.sax">getColumnNumber</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/Locator.html?is-external=true#getPublicId()" title="class or interface in org.xml.sax">getPublicId</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.xml.transform.SourceLocator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.xml.transform.<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true" title="class or interface in javax.xml.transform">SourceLocator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true#getColumnNumber()" title="class or interface in javax.xml.transform">getColumnNumber</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/SourceLocator.html?is-external=true#getPublicId()" title="class or interface in javax.xml.transform">getPublicId</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.event.LocationProvider"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.event.<A HREF="../../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../net/sf/saxon/event/LocationProvider.html#getSystemId(long)">getSystemId</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="GlobalVariable()"><!-- --></A><H3>
GlobalVariable</H3>
<PRE>
public <B>GlobalVariable</B>()</PRE>
<DL>
<DD>Create a global variable
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getExecutable()"><!-- --></A><H3>
getExecutable</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/instruct/Executable.html" title="class in net.sf.saxon.expr.instruct">Executable</A> <B>getExecutable</B>()</PRE>
<DL>
<DD>Get the executable containing this global variable
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html#getExecutable()">getExecutable</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getExecutable()">getExecutable</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the containing executable</DL>
</DD>
</DL>
<HR>
<A NAME="setExecutable(net.sf.saxon.expr.instruct.Executable)"><!-- --></A><H3>
setExecutable</H3>
<PRE>
public void <B>setExecutable</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/Executable.html" title="class in net.sf.saxon.expr.instruct">Executable</A> executable)</PRE>
<DL>
<DD>Set the containing executable
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>executable</CODE> - the executable that contains this global variable</DL>
</DD>
</DL>
<HR>
<A NAME="getLineNumber(long)"><!-- --></A><H3>
getLineNumber</H3>
<PRE>
public int <B>getLineNumber</B>(long locationId)</PRE>
<DL>
<DD>Get the line number within the document, entity or module containing a particular location
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/event/LocationProvider.html#getLineNumber(long)">getLineNumber</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locationId</CODE> - identifier of the location in question (as passed down the Receiver pipeline)
<DT><B>Returns:</B><DD>the line number within the document, entity or module, or -1 if no information is available.</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnNumber(long)"><!-- --></A><H3>
getColumnNumber</H3>
<PRE>
public int <B>getColumnNumber</B>(long locationId)</PRE>
<DL>
<DD>Get the column number within the document, entity, or module containing a particular location
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/event/LocationProvider.html#getColumnNumber(long)">getColumnNumber</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/event/LocationProvider.html" title="interface in net.sf.saxon.event">LocationProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locationId</CODE> - identifier of the location in question (as passed down the Receiver pipeline)
<DT><B>Returns:</B><DD>the column number within the document, entity, or module, or -1 if this is not available</DL>
</DD>
</DL>
<HR>
<A NAME="getConstructType()"><!-- --></A><H3>
getConstructType</H3>
<PRE>
public int <B>getConstructType</B>()</PRE>
<DL>
<DD>Get the type of construct. This will either be the fingerprint of a standard XSLT instruction name
(values in <A HREF="../../../../../net/sf/saxon/om/StandardNames.html" title="class in net.sf.saxon.om"><CODE>StandardNames</CODE></A>: all less than 1024)
or it will be a constant in class <A HREF="../../../../../net/sf/saxon/trace/Location.html" title="class in net.sf.saxon.trace"><CODE>Location</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html#getConstructType()">getConstructType</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an integer identifying the kind of construct</DL>
</DD>
</DL>
<HR>
<A NAME="getObjectName()"><!-- --></A><H3>
getObjectName</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> <B>getObjectName</B>()</PRE>
<DL>
<DD>Get a name identifying the object of the expression, for example a function name, template name,
variable name, key name, element name, etc. This is used only where the name is known statically.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html#getObjectName()">getObjectName</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the QName of the object declared or manipulated by this instruction or expression</DL>
</DD>
</DL>
<HR>
<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getProperty</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
<DD>Get the value of a particular property of the instruction. Properties
of XSLT instructions are generally known by the name of the stylesheet attribute
that defines them.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html#getProperty(java.lang.String)">getProperty</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the required property
<DT><B>Returns:</B><DD>The value of the requested property, or null if the property is not available</DL>
</DD>
</DL>
<HR>
<A NAME="getProperties()"><!-- --></A><H3>
getProperties</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getProperties</B>()</PRE>
<DL>
<DD>Get an iterator over all the properties available. The values returned by the iterator
will be of type String, and each string can be supplied as input to the getProperty()
method to retrieve the value of the property. The iterator may return properties whose
value is null.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html#getProperties()">getProperties</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/trace/InstructionInfo.html" title="interface in net.sf.saxon.trace">InstructionInfo</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an iterator over the properties.</DL>
</DD>
</DL>
<HR>
<A NAME="getContainer()"><!-- --></A><H3>
getContainer</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A> <B>getContainer</B>()</PRE>
<DL>
<DD>Get the container in which this expression is located. This will usually be a top-level construct
such as a function or global variable, and XSLT template, or an XQueryExpression. In the case of
free-standing XPath expressions it will be the StaticContext object
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getContainer()">getContainer</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the expression's container</DL>
</DD>
</DL>
<HR>
<A NAME="getHostLanguage()"><!-- --></A><H3>
getHostLanguage</H3>
<PRE>
public int <B>getHostLanguage</B>()</PRE>
<DL>
<DD>Get the host language (XSLT, XQuery, XPath) used to implement the code in this container
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html#getHostLanguage()">getHostLanguage</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>typically <A HREF="../../../../../net/sf/saxon/Configuration.html#XSLT"><CODE>Configuration.XSLT</CODE></A> or <A HREF="../../../../../net/sf/saxon/Configuration.html#XQUERY"><CODE>Configuration.XQUERY</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setIndexedVariable()"><!-- --></A><H3>
setIndexedVariable</H3>
<PRE>
public void <B>setIndexedVariable</B>()</PRE>
<DL>
<DD>Mark this as an indexed variable, to allow fast searching
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isIndexedVariable()"><!-- --></A><H3>
isIndexedVariable</H3>
<PRE>
public boolean <B>isIndexedVariable</B>()</PRE>
<DL>
<DD>Ask whether this is an indexed variable
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this variable is indexed</DL>
</DD>
</DL>
<HR>
<A NAME="getContainerGranularity()"><!-- --></A><H3>
getContainerGranularity</H3>
<PRE>
public int <B>getContainerGranularity</B>()</PRE>
<DL>
<DD>Get the granularity of the container.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html#getContainerGranularity()">getContainerGranularity</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>0 for a temporary container created during parsing; 1 for a container
that operates at the level of an XPath expression; 2 for a container at the level
of a global function or template</DL>
</DD>
</DL>
<HR>
<A NAME="setContainsLocals(net.sf.saxon.expr.instruct.SlotManager)"><!-- --></A><H3>
setContainsLocals</H3>
<PRE>
public void <B>setContainsLocals</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> map)</PRE>
<DL>
<DD>The expression that initializes a global variable may itself use local variables.
In this case a stack frame needs to be allocated while evaluating the global variable
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>map</CODE> - The stack frame map for local variables used while evaluating this global
variable.</DL>
</DD>
</DL>
<HR>
<A NAME="isGlobal()"><!-- --></A><H3>
isGlobal</H3>
<PRE>
public boolean <B>isGlobal</B>()</PRE>
<DL>
<DD>Is this a global variable?
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/Binding.html#isGlobal()">isGlobal</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#isGlobal()">isGlobal</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true (yes, it is a global variable)</DL>
</DD>
</DL>
<HR>
<A NAME="lookForCycles(java.util.Stack, net.sf.saxon.query.XQueryFunctionLibrary)"><!-- --></A><H3>
lookForCycles</H3>
<PRE>
public void <B>lookForCycles</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</A><<A HREF="../../../../../net/sf/saxon/expr/Container.html" title="interface in net.sf.saxon.expr">Container</A>> referees,
<A HREF="../../../../../net/sf/saxon/query/XQueryFunctionLibrary.html" title="class in net.sf.saxon.query">XQueryFunctionLibrary</A> globalFunctionLibrary)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Check for cycles in this variable definition
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>referees</CODE> - the calls leading up to this one; it's an error if this variable is on the
stack, because that means it calls itself directly or indirectly. The stack may contain
variable definitions (GlobalVariable objects) and user-defined functions (UserFunction objects).
It will never contain the same object more than once.<DD><CODE>globalFunctionLibrary</CODE> - the library containing all global functions
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if cycles are found</DL>
</DD>
</DL>
<HR>
<A NAME="getSelectValue(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
getSelectValue</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> <B>getSelectValue</B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Evaluate the variable. That is,
get the value of the select expression if present or the content
of the element otherwise, either as a tree or as a sequence
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getSelectValue(net.sf.saxon.expr.XPathContext)">getSelectValue</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the XPath dynamic context
<DT><B>Returns:</B><DD>the result of evaluating the variable
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if evaluation of the select expression fails
with a dynamic error</DL>
</DD>
</DL>
<HR>
<A NAME="evaluateVariable(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
evaluateVariable</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> <B>evaluateVariable</B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Evaluate the variable
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/Binding.html#evaluateVariable(net.sf.saxon.expr.XPathContext)">evaluateVariable</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the XPath dynamic evaluation context
<DT><B>Returns:</B><DD>the result of evaluating the variable
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an error occurs while evaluating
the variable</DL>
</DD>
</DL>
<HR>
<A NAME="actuallyEvaluate(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
actuallyEvaluate</H3>
<PRE>
protected <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> <B>actuallyEvaluate</B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Evaluate the global variable, and save its value for use in subsequent references.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the XPath dynamic context
<DT><B>Returns:</B><DD>the value of the variable
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if evaluation fails</DL>
</DD>
</DL>
<HR>
<A NAME="setDependencies(net.sf.saxon.expr.instruct.Bindery, net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
setDependencies</H3>
<PRE>
protected static void <B>setDependencies</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/Bindery.html" title="class in net.sf.saxon.expr.instruct">Bindery</A> bindery,
<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> var,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Get the variable that is immediately dependent on this one, and register the dependency, so
that circularities can be detected across threads. This relies on the fact that when the initialiser
for variable X contains a reference to variable Y, then when Y is evaluated, a stack frame will be found
on the context stack representing the evaluation of X. We don't set a dependency from X to Y if the value
of Y was already available in the Bindery; it's not needed, because in this case we know that evaluation
of Y is unproblematic, and can't lead to any circularities.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bindery</CODE> - the Bindery<DD><CODE>var</CODE> - the global variable or parameter being evaluated<DD><CODE>context</CODE> - the dynamic evaluation context
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalParameterSet.html" title="class in net.sf.saxon.expr.instruct"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/instruct/Instruction.html" title="class in net.sf.saxon.expr.instruct"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/expr/instruct/GlobalVariable.html" target="_top"><B>FRAMES</B></A>
<A HREF="GlobalVariable.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_net.sf.saxon.expr.instruct.GeneralVariable">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
