<!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:10 GMT 2011 -->
<TITLE>
Bindery
</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="Bindery";
}
}
</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/AttributeSet.html" title="class in net.sf.saxon.expr.instruct"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/instruct/Block.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/Bindery.html" target="_top"><B>FRAMES</B></A>
<A HREF="Bindery.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 | FIELD | <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 Bindery</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 "><B>net.sf.saxon.expr.instruct.Bindery</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Bindery</B><DT>extends <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></DL>
</PRE>
<P>
The Bindery class holds information about variables and their values. From Saxon 8.1, it is
used only for global variables: local variables are now held in the XPathContext object.
Variables are identified by a Binding object. Values will always be of class Value.
<P>
<P>
<HR>
<P>
<!-- ======== 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/Bindery.html#Bindery()">Bindery</A></B>()</CODE>
<BR>
</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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/Bindery.html#allocateGlobals(net.sf.saxon.expr.instruct.SlotManager)">allocateGlobals</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> map)</CODE>
<BR>
Define how many slots are needed for global variables</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/Bindery.html#assignGlobalVariable(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.om.ValueRepresentation)">assignGlobalVariable</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</CODE>
<BR>
Assign a new value to a global 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/Bindery.html#defineGlobalParameters(net.sf.saxon.expr.instruct.GlobalParameterSet)">defineGlobalParameters</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalParameterSet.html" title="class in net.sf.saxon.expr.instruct">GlobalParameterSet</A> params)</CODE>
<BR>
Define global parameters</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/Bindery.html#defineGlobalVariable(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.om.ValueRepresentation)">defineGlobalVariable</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</CODE>
<BR>
Provide a value for a global variable</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/Bindery.html#getGlobalVariable(int)">getGlobalVariable</A></B>(int slot)</CODE>
<BR>
Get the value of a global variable whose slot number is known</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/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/Bindery.html#getGlobalVariableMap()">getGlobalVariableMap</A></B>()</CODE>
<BR>
Get the Global Variable Map, containing the mapping of variable names (fingerprints)
to slot numbers.</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/Bindery.html#getGlobalVariables()">getGlobalVariables</A></B>()</CODE>
<BR>
Get all the global variables, as an array.</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/Bindery.html#getGlobalVariableValue(net.sf.saxon.expr.instruct.GlobalVariable)">getGlobalVariableValue</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding)</CODE>
<BR>
Get the value of 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/Bindery.html#isApplyFunctionConversionRulesToExternalVariables()">isApplyFunctionConversionRulesToExternalVariables</A></B>()</CODE>
<BR>
Ask whether the function conversion rules should be applied to supplied
parameter values.</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/Bindery.html#registerDependency(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.expr.instruct.GlobalVariable)">registerDependency</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> one,
<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> two)</CODE>
<BR>
Register the dependency of one variable ("one") upon another ("two"), throwing an exception if this would establish
a cycle of dependencies.</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/Bindery.html#saveGlobalVariableValue(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.om.ValueRepresentation)">saveGlobalVariableValue</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</CODE>
<BR>
Save the value of a global variable, and mark evaluation as complete.</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/Bindery.html#setApplyFunctionConversionRulesToExternalVariables(boolean)">setApplyFunctionConversionRulesToExternalVariables</A></B>(boolean convert)</CODE>
<BR>
Say whether the function conversion rules should be applied to supplied
parameter values.</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/Bindery.html#setExecuting(net.sf.saxon.expr.instruct.GlobalVariable)">setExecuting</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding)</CODE>
<BR>
Set/Unset a flag to indicate that a particular global variable is currently being
evaluated.</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/Bindery.html#setGlobalVariable(int, net.sf.saxon.om.ValueRepresentation)">setGlobalVariable</A></B>(int slot,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</CODE>
<BR>
Set the value of a global variable whose slot number is known</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/Bindery.html#setNotExecuting(net.sf.saxon.expr.instruct.GlobalVariable)">setNotExecuting</A></B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding)</CODE>
<BR>
Indicate that a global variable is not currently being evaluated</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/Bindery.html#useGlobalParameter(net.sf.saxon.om.StructuredQName, int, net.sf.saxon.value.SequenceType, net.sf.saxon.expr.XPathContext)">useGlobalParameter</A></B>(<A HREF="../../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> qName,
int slot,
<A HREF="../../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A> requiredType,
<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Use global parameter.</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>
<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="Bindery()"><!-- --></A><H3>
Bindery</H3>
<PRE>
public <B>Bindery</B>()</PRE>
<DL>
</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="allocateGlobals(net.sf.saxon.expr.instruct.SlotManager)"><!-- --></A><H3>
allocateGlobals</H3>
<PRE>
public void <B>allocateGlobals</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> map)</PRE>
<DL>
<DD>Define how many slots are needed for global variables
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>map</CODE> - the SlotManager that keeps track of slot allocation for global variables.</DL>
</DD>
</DL>
<HR>
<A NAME="setApplyFunctionConversionRulesToExternalVariables(boolean)"><!-- --></A><H3>
setApplyFunctionConversionRulesToExternalVariables</H3>
<PRE>
public void <B>setApplyFunctionConversionRulesToExternalVariables</B>(boolean convert)</PRE>
<DL>
<DD>Say whether the function conversion rules should be applied to supplied
parameter values. For example, this allows an integer to be supplied as the value
for a parameter where the expected type is xs:double. The default is true.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>convert</CODE> - true if function conversion rules are to be applied to supplied
values; if false, the supplied value must match the required type exactly.<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isApplyFunctionConversionRulesToExternalVariables()"><!-- --></A><H3>
isApplyFunctionConversionRulesToExternalVariables</H3>
<PRE>
public boolean <B>isApplyFunctionConversionRulesToExternalVariables</B>()</PRE>
<DL>
<DD>Ask whether the function conversion rules should be applied to supplied
parameter values. For example, this allows an integer to be supplied as the value
for a parameter where the expected type is xs:double. The default is true.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if function conversion rules are to be applied to supplied
values; if false, the supplied value must match the required type exactly.<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="defineGlobalParameters(net.sf.saxon.expr.instruct.GlobalParameterSet)"><!-- --></A><H3>
defineGlobalParameters</H3>
<PRE>
public void <B>defineGlobalParameters</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalParameterSet.html" title="class in net.sf.saxon.expr.instruct">GlobalParameterSet</A> params)</PRE>
<DL>
<DD>Define global parameters
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>params</CODE> - The ParameterSet passed in by the user, eg. from the command line</DL>
</DD>
</DL>
<HR>
<A NAME="useGlobalParameter(net.sf.saxon.om.StructuredQName, int, net.sf.saxon.value.SequenceType, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
useGlobalParameter</H3>
<PRE>
public boolean <B>useGlobalParameter</B>(<A HREF="../../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> qName,
int slot,
<A HREF="../../../../../net/sf/saxon/value/SequenceType.html" title="class in net.sf.saxon.value">SequenceType</A> requiredType,
<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>Use global parameter. This is called when a global xsl:param element is processed.
If a parameter of the relevant name was supplied, it is bound to the xsl:param element.
Otherwise the method returns false, so the xsl:param default will be evaluated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>qName</CODE> - The name of the parameter<DD><CODE>slot</CODE> - The slot number allocated to the parameter<DD><CODE>requiredType</CODE> - The declared type of the parameter<DD><CODE>context</CODE> - the XPath dynamic evaluation context
<DT><B>Returns:</B><DD>true if a parameter of this name was supplied, false if not
<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 a dynamic error occurs, for example if the supplied parameter value
does not match the required type</DL>
</DD>
</DL>
<HR>
<A NAME="defineGlobalVariable(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.om.ValueRepresentation)"><!-- --></A><H3>
defineGlobalVariable</H3>
<PRE>
public void <B>defineGlobalVariable</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</PRE>
<DL>
<DD>Provide a value for a global variable
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>binding</CODE> - identifies the variable<DD><CODE>value</CODE> - the value of the variable</DL>
</DD>
</DL>
<HR>
<A NAME="setExecuting(net.sf.saxon.expr.instruct.GlobalVariable)"><!-- --></A><H3>
setExecuting</H3>
<PRE>
public boolean <B>setExecuting</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Set/Unset a flag to indicate that a particular global variable is currently being
evaluated. Note that this code is not synchronized, so there is no absolute guarantee that
two threads will not both evaluate the same global variable; however, apart from wasted time,
it is harmless if they do.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>binding</CODE> - the global variable in question
<DT><B>Returns:</B><DD>true if evaluation of the variable should proceed; false if it is found that the variable has now been
evaluated in another thread.
<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 attempt is made to set the flag when it is already set, this means
the definition of the variable is circular.</DL>
</DD>
</DL>
<HR>
<A NAME="setNotExecuting(net.sf.saxon.expr.instruct.GlobalVariable)"><!-- --></A><H3>
setNotExecuting</H3>
<PRE>
public void <B>setNotExecuting</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding)</PRE>
<DL>
<DD>Indicate that a global variable is not currently being evaluated
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>binding</CODE> - the global variable</DL>
</DD>
</DL>
<HR>
<A NAME="saveGlobalVariableValue(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.om.ValueRepresentation)"><!-- --></A><H3>
saveGlobalVariableValue</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> <B>saveGlobalVariableValue</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</PRE>
<DL>
<DD>Save the value of a global variable, and mark evaluation as complete.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>binding</CODE> - the global variable in question<DD><CODE>value</CODE> - the value that this thread has obtained by evaluating the variable
<DT><B>Returns:</B><DD>the value actually given to the variable. Exceptionally this will be different from the supplied
value if another thread has evaluated the same global variable concurrently. The returned value should be
used in preference, to ensure that all threads agree on the value. They could be different if for example
the variable is initialized using the collection() function.</DL>
</DD>
</DL>
<HR>
<A NAME="getGlobalVariableValue(net.sf.saxon.expr.instruct.GlobalVariable)"><!-- --></A><H3>
getGlobalVariableValue</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> <B>getGlobalVariableValue</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding)</PRE>
<DL>
<DD>Get the value of a global variable
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>binding</CODE> - the Binding that establishes the unique instance of the variable
<DT><B>Returns:</B><DD>the Value of the variable if defined, null otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="getGlobalVariable(int)"><!-- --></A><H3>
getGlobalVariable</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> <B>getGlobalVariable</B>(int slot)</PRE>
<DL>
<DD>Get the value of a global variable whose slot number is known
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slot</CODE> - the slot number of the required variable
<DT><B>Returns:</B><DD>the Value of the variable if defined, null otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="setGlobalVariable(int, net.sf.saxon.om.ValueRepresentation)"><!-- --></A><H3>
setGlobalVariable</H3>
<PRE>
public void <B>setGlobalVariable</B>(int slot,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</PRE>
<DL>
<DD>Set the value of a global variable whose slot number is known
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>slot</CODE> - the slot number of the required variable<DD><CODE>value</CODE> - the Value of the variable if defined, null otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="assignGlobalVariable(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.om.ValueRepresentation)"><!-- --></A><H3>
assignGlobalVariable</H3>
<PRE>
public void <B>assignGlobalVariable</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> binding,
<A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A> value)</PRE>
<DL>
<DD>Assign a new value to a global variable. Supports saxon:assign.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>binding</CODE> - identifies the global variable or parameter<DD><CODE>value</CODE> - the value to be assigned to the variable</DL>
</DD>
</DL>
<HR>
<A NAME="getGlobalVariableMap()"><!-- --></A><H3>
getGlobalVariableMap</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> <B>getGlobalVariableMap</B>()</PRE>
<DL>
<DD>Get the Global Variable Map, containing the mapping of variable names (fingerprints)
to slot numbers. This is provided for use by debuggers.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the SlotManager containing information about the assignment of slot numbers
to global variables and parameters</DL>
</DD>
</DL>
<HR>
<A NAME="getGlobalVariables()"><!-- --></A><H3>
getGlobalVariables</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A>[] <B>getGlobalVariables</B>()</PRE>
<DL>
<DD>Get all the global variables, as an array. This is provided for use by debuggers
that know the layout of the global variables within the array.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the array of global varaibles.</DL>
</DD>
</DL>
<HR>
<A NAME="registerDependency(net.sf.saxon.expr.instruct.GlobalVariable, net.sf.saxon.expr.instruct.GlobalVariable)"><!-- --></A><H3>
registerDependency</H3>
<PRE>
public void <B>registerDependency</B>(<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> one,
<A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalVariable.html" title="class in net.sf.saxon.expr.instruct">GlobalVariable</A> two)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Register the dependency of one variable ("one") upon another ("two"), throwing an exception if this would establish
a cycle of dependencies.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>one</CODE> - the first (dependent) variable<DD><CODE>two</CODE> - the second (dependee) 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 adding this dependency creates a cycle of dependencies among global variables.</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/AttributeSet.html" title="class in net.sf.saxon.expr.instruct"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/instruct/Block.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/Bindery.html" target="_top"><B>FRAMES</B></A>
<A HREF="Bindery.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 | FIELD | <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>
