<!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:12 GMT 2011 -->
<TITLE>
LocalParam
</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="LocalParam";
}
}
</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/ITemplateCall.html" title="interface in net.sf.saxon.expr.instruct"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/instruct/LocalParamBlock.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/LocalParam.html" target="_top"><B>FRAMES</B></A>
<A HREF="LocalParam.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 LocalParam</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.LocalParam</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><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/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public final class <B>LocalParam</B><DT>extends <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html" title="class in net.sf.saxon.expr.instruct">GeneralVariable</A></DL>
</PRE>
<P>
The compiled form of an xsl:param element within a template in an XSLT stylesheet.
<p>The xsl:param element in XSLT has mandatory attribute name and optional attribute select. It can also
be specified as required="yes" or required="no".</p>
<p>This is used only for parameters to XSLT templates. For function calls, the caller of the function
places supplied arguments onto the callee's stackframe and the callee does not need to do anything.
Global parameters (XQuery external variables) are handled using <A HREF="../../../../../net/sf/saxon/expr/instruct/GlobalParam.html" title="class in net.sf.saxon.expr.instruct"><CODE>GlobalParam</CODE></A>.</p>
<p>The LocalParam class is also used to represent parameters with the saxon:iterate instruction</p>
<P>
<P>
<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/LocalParam.html#LocalParam()">LocalParam</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> <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/LocalParam.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> c)</CODE>
<BR>
Evaluate the 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/LocalParam.html#explain(net.sf.saxon.trace.ExpressionPresenter)">explain</A></B>(<A HREF="../../../../../net/sf/saxon/trace/ExpressionPresenter.html" title="class in net.sf.saxon.trace">ExpressionPresenter</A> out)</CODE>
<BR>
Diagnostic print of expression structure.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/LocalParam.html#getConversion()">getConversion</A></B>()</CODE>
<BR>
Get the conversion expression</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/LocalParam.html#getConversionEvaluationMode()">getConversionEvaluationMode</A></B>()</CODE>
<BR>
</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/LocalParam.html#getInstructionNameCode()">getInstructionNameCode</A></B>()</CODE>
<BR>
Get the name of this instruction for diagnostic and tracing purposes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/value/IntegerValue.html" title="class in net.sf.saxon.value">IntegerValue</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/LocalParam.html#getIntegerBoundsForVariable()">getIntegerBoundsForVariable</A></B>()</CODE>
<BR>
If the variable is bound to an integer, get the minimum and maximum possible values.</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/LocalParam.html#getParameterId()">getParameterId</A></B>()</CODE>
<BR>
Get the parameter id, which is essentially an alias for the parameter name,
unique within a stylesheet</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="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/LocalParam.html#iterateSubExpressions()">iterateSubExpressions</A></B>()</CODE>
<BR>
Get all the XPath expressions associated with this instruction
(in XSLT terms, the expression present on attributes of the instruction,
as distinct from the child instructions in a sequence construction)</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/TailCall.html" title="interface in net.sf.saxon.expr.instruct">TailCall</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/instruct/LocalParam.html#processLeavingTail(net.sf.saxon.expr.XPathContext)">processLeavingTail</A></B>(<A HREF="../../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Process the local parameter declaration</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/LocalParam.html#replaceSubExpression(net.sf.saxon.expr.Expression, net.sf.saxon.expr.Expression)">replaceSubExpression</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> original,
<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> replacement)</CODE>
<BR>
Replace one subexpression by a replacement subexpression</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/LocalParam.html#setConversion(net.sf.saxon.expr.Expression)">setConversion</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> convertor)</CODE>
<BR>
Define a conversion that is to be applied to the supplied parameter value.</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/LocalParam.html#setParameterId(int)">setParameterId</A></B>(int id)</CODE>
<BR>
Allocate a number which is essentially an alias for the parameter name,
unique within a stylesheet</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#getCardinality()">getCardinality</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getColumnNumber()">getColumnNumber</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getContainer()">getContainer</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getEvaluationMode()">getEvaluationMode</A>, <A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getExecutable()">getExecutable</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#getSelectValue(net.sf.saxon.expr.XPathContext)">getSelectValue</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#isGlobal()">isGlobal</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#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#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>
<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="LocalParam()"><!-- --></A><H3>
LocalParam</H3>
<PRE>
public <B>LocalParam</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="setParameterId(int)"><!-- --></A><H3>
setParameterId</H3>
<PRE>
public void <B>setParameterId</B>(int id)</PRE>
<DL>
<DD>Allocate a number which is essentially an alias for the parameter name,
unique within a stylesheet
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - the parameter id</DL>
</DD>
</DL>
<HR>
<A NAME="getParameterId()"><!-- --></A><H3>
getParameterId</H3>
<PRE>
public int <B>getParameterId</B>()</PRE>
<DL>
<DD>Get the parameter id, which is essentially an alias for the parameter name,
unique within a stylesheet
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the parameter id</DL>
</DD>
</DL>
<HR>
<A NAME="setConversion(net.sf.saxon.expr.Expression)"><!-- --></A><H3>
setConversion</H3>
<PRE>
public void <B>setConversion</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> convertor)</PRE>
<DL>
<DD>Define a conversion that is to be applied to the supplied parameter value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>convertor</CODE> - The expression to be applied. This performs type checking,
and the basic conversions implied by function calling rules, for example
numeric promotion, atomization, and conversion of untyped atomic values to
a required type. The conversion uses the actual parameter value as input,
referencing it using a VariableReference. The argument can be null to indicate
that no conversion is required.</DL>
</DD>
</DL>
<HR>
<A NAME="getConversion()"><!-- --></A><H3>
getConversion</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>getConversion</B>()</PRE>
<DL>
<DD>Get the conversion expression
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the expression used to convert the value to the required type,
or null if there is none</DL>
</DD>
</DL>
<HR>
<A NAME="getConversionEvaluationMode()"><!-- --></A><H3>
getConversionEvaluationMode</H3>
<PRE>
public int <B>getConversionEvaluationMode</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getInstructionNameCode()"><!-- --></A><H3>
getInstructionNameCode</H3>
<PRE>
public int <B>getInstructionNameCode</B>()</PRE>
<DL>
<DD>Get the name of this instruction for diagnostic and tracing purposes
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#getInstructionNameCode()">getInstructionNameCode</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 name of this instruction, as a name pool name code</DL>
</DD>
</DL>
<HR>
<A NAME="iterateSubExpressions()"><!-- --></A><H3>
iterateSubExpressions</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="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A>> <B>iterateSubExpressions</B>()</PRE>
<DL>
<DD>Get all the XPath expressions associated with this instruction
(in XSLT terms, the expression present on attributes of the instruction,
as distinct from the child instructions in a sequence construction)
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#iterateSubExpressions()">iterateSubExpressions</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>an iterator over all the contained expressions (in practice,
the select expression)</DL>
</DD>
</DL>
<HR>
<A NAME="replaceSubExpression(net.sf.saxon.expr.Expression, net.sf.saxon.expr.Expression)"><!-- --></A><H3>
replaceSubExpression</H3>
<PRE>
public boolean <B>replaceSubExpression</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> original,
<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> replacement)</PRE>
<DL>
<DD>Replace one subexpression by a replacement subexpression
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#replaceSubExpression(net.sf.saxon.expr.Expression, net.sf.saxon.expr.Expression)">replaceSubExpression</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>original</CODE> - the original subexpression<DD><CODE>replacement</CODE> - the replacement subexpression
<DT><B>Returns:</B><DD>true if the original subexpression is found</DL>
</DD>
</DL>
<HR>
<A NAME="processLeavingTail(net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
processLeavingTail</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/instruct/TailCall.html" title="interface in net.sf.saxon.expr.instruct">TailCall</A> <B>processLeavingTail</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>Process the local parameter declaration
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the dynamic context
<DT><B>Returns:</B><DD>either null if processing is complete, or a tailcall if one is left outstanding
<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 in the evaluation</DL>
</DD>
</DL>
<HR>
<A NAME="getIntegerBoundsForVariable()"><!-- --></A><H3>
getIntegerBoundsForVariable</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/value/IntegerValue.html" title="class in net.sf.saxon.value">IntegerValue</A>[] <B>getIntegerBoundsForVariable</B>()</PRE>
<DL>
<DD>If the variable is bound to an integer, get the minimum and maximum possible values.
Return null if unknown or not applicable
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/Binding.html#getIntegerBoundsForVariable()">getIntegerBoundsForVariable</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#getIntegerBoundsForVariable()">getIntegerBoundsForVariable</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>a pair of integers containing the minimum and maximum values for the integer value;
or null if the value is not an integer or the range is unknown</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> c)</PRE>
<DL>
<DD>Evaluate the variable
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the XPath dynamic evaluation context
<DT><B>Returns:</B><DD>the result of evaluating the variable</DL>
</DD>
</DL>
<HR>
<A NAME="explain(net.sf.saxon.trace.ExpressionPresenter)"><!-- --></A><H3>
explain</H3>
<PRE>
public void <B>explain</B>(<A HREF="../../../../../net/sf/saxon/trace/ExpressionPresenter.html" title="class in net.sf.saxon.trace">ExpressionPresenter</A> out)</PRE>
<DL>
<DD>Diagnostic print of expression structure. The abstract expression tree
is written to the supplied output destination.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/expr/instruct/GeneralVariable.html#explain(net.sf.saxon.trace.ExpressionPresenter)">explain</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>out</CODE> - the object used to present the output</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/ITemplateCall.html" title="interface in net.sf.saxon.expr.instruct"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/instruct/LocalParamBlock.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/LocalParam.html" target="_top"><B>FRAMES</B></A>
<A HREF="LocalParam.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>
