<!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:13 GMT 2011 -->
<TITLE>
PromotionOffer
</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="PromotionOffer";
}
}
</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/parser/PathMap.PathMapRoot.html" title="class in net.sf.saxon.expr.parser"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/parser/RoleLocator.html" title="class in net.sf.saxon.expr.parser"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/expr/parser/PromotionOffer.html" target="_top"><B>FRAMES</B></A>
<A HREF="PromotionOffer.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="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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.parser</FONT>
<BR>
Class PromotionOffer</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.parser.PromotionOffer</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>PromotionOffer</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>
PromotionOffer is an object used transiently during compilation of an expression. It contains
information passed by a containing expression to its subexpressions, when looking for subexpressions
that can be promoted to a higher level because they are not dependent on the context established
by the containing expression. The object is also used to pass back return information when the
promotion actually takes place.
<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>
<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/parser/PromotionOffer.html#accepted">accepted</A></B></CODE>
<BR>
Flag that is set if the offer has been accepted, that is, if the expression has changed</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/parser/PromotionOffer.html#action">action</A></B></CODE>
<BR>
action is one of the possible promotion actions, FOCUS_INDEPENDENT, RANGE_INDEPENDENT,
INLINE_VARIABLE_REFERENCES, UNORDERED, EXTRACT_GLOBAL_VARIABLES</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#bindingList">bindingList</A></B></CODE>
<BR>
In the case of RANGE_INDEPENDENT, "binding" identifies the range variables whose dependencies
we are looking for.</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/parser/PromotionOffer.html#containingExpression">containingExpression</A></B></CODE>
<BR>
When a promotion offer is made, containingExpression identifies the level to which the promotion
should occur.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#EXTRACT_GLOBAL_VARIABLES">EXTRACT_GLOBAL_VARIABLES</A></B></CODE>
<BR>
EXTRACT_GLOBAL_VARIABLES identifies subexpressions that are not constant, but have no dependencies
other than on global variables or parameters (they must also be non-creative).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#FOCUS_INDEPENDENT">FOCUS_INDEPENDENT</A></B></CODE>
<BR>
FOCUS_INDEPENDENT requests promotion of all non-trivial subexpressions that don't depend on the
focus.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#INLINE_VARIABLE_REFERENCES">INLINE_VARIABLE_REFERENCES</A></B></CODE>
<BR>
Inline variable references causes all references to a variable V to be replaced by the
expression E.</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/parser/PromotionOffer.html#promoteDocumentDependent">promoteDocumentDependent</A></B></CODE>
<BR>
In the case of FOCUS_INDEPENDENT, "promoteDocumentDependent" is a boolean that, when set to
true, indicates that it is safe to promote a subexpression that depends on the context document
but not on other aspects of the focus.</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/parser/PromotionOffer.html#promoteXSLTFunctions">promoteXSLTFunctions</A></B></CODE>
<BR>
In the case of FOCUS_INDEPENDENT, "promoteXSLTFunctions" is a boolean that, when set to true, indicates
that it is safe to promote XSLT functions such as current().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#RANGE_INDEPENDENT">RANGE_INDEPENDENT</A></B></CODE>
<BR>
RANGE_INDEPENDENT requests promotion of all non-trivial subexpressions that don't depend on a
specified range variable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#REPLACE_CURRENT">REPLACE_CURRENT</A></B></CODE>
<BR>
REPLACE_CURRENT causes calls to the XSLT current() function to be replaced by
reference to a 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/parser/PromotionOffer.html#retainAllNodes">retainAllNodes</A></B></CODE>
<BR>
In the case of UNORDERED, "retainAllNodes" is a boolean that is set to
true if the nodes can be delivered in any order so long as the right number of nodes
are delivered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#UNORDERED">UNORDERED</A></B></CODE>
<BR>
UNORDERED indicates that the containing expression does not require the results
to be delivered in any particular order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#visitor">visitor</A></B></CODE>
<BR>
The expression visitor in use</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/parser/PromotionOffer.html#PromotionOffer(net.sf.saxon.expr.parser.Optimizer)">PromotionOffer</A></B>(<A HREF="../../../../../net/sf/saxon/expr/parser/Optimizer.html" title="class in net.sf.saxon.expr.parser">Optimizer</A> optimizer)</CODE>
<BR>
Create a PromotionOffer for use with a particular Optimizer</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/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#accept(net.sf.saxon.expr.Expression, net.sf.saxon.expr.Expression)">accept</A></B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> parent,
<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> child)</CODE>
<BR>
Method to test whether a subexpression qualifies for promotion, and if so, to
accept the promotion.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../net/sf/saxon/expr/parser/Optimizer.html" title="class in net.sf.saxon.expr.parser">Optimizer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../net/sf/saxon/expr/parser/PromotionOffer.html#getOptimizer()">getOptimizer</A></B>()</CODE>
<BR>
Get the optimizer in use</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>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="FOCUS_INDEPENDENT"><!-- --></A><H3>
FOCUS_INDEPENDENT</H3>
<PRE>
public static final int <B>FOCUS_INDEPENDENT</B></PRE>
<DL>
<DD>FOCUS_INDEPENDENT requests promotion of all non-trivial subexpressions that don't depend on the
focus. This is typically used to extract subexpressions from a filter predicate. The offer is
optional - each subexpression can decide whether it's worth the trouble of promoting itself.
The offer is normally passed on to subexpressions, except subexpressions that are evaluated
with a different focus
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.sf.saxon.expr.parser.PromotionOffer.FOCUS_INDEPENDENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="RANGE_INDEPENDENT"><!-- --></A><H3>
RANGE_INDEPENDENT</H3>
<PRE>
public static final int <B>RANGE_INDEPENDENT</B></PRE>
<DL>
<DD>RANGE_INDEPENDENT requests promotion of all non-trivial subexpressions that don't depend on a
specified range variable. This is typically used to extract subexpressions from the action of
a for expression or the condition of a some/every quantified expression. The offer is
optional - each subexpression can decide whether it's worth the trouble of promoting itself.
The offer is normally passed on to subexpressions, except subexpressions that are evaluated
with a different focus or a different range variable, because these may have other dependencies
that prevent their promotion.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.sf.saxon.expr.parser.PromotionOffer.RANGE_INDEPENDENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="INLINE_VARIABLE_REFERENCES"><!-- --></A><H3>
INLINE_VARIABLE_REFERENCES</H3>
<PRE>
public static final int <B>INLINE_VARIABLE_REFERENCES</B></PRE>
<DL>
<DD>Inline variable references causes all references to a variable V to be replaced by the
expression E. The variable is supplied in the "binding" property; the replacement expression
in the containingExpression property. A special case is where the replacement expression is
a ContextItemExpression; in this case the offer is not passed on to subexpressions where
the context is different.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.sf.saxon.expr.parser.PromotionOffer.INLINE_VARIABLE_REFERENCES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UNORDERED"><!-- --></A><H3>
UNORDERED</H3>
<PRE>
public static final int <B>UNORDERED</B></PRE>
<DL>
<DD>UNORDERED indicates that the containing expression does not require the results
to be delivered in any particular order. The boolean mustEliminateDuplicates
is set if duplicate items in the result are not allowed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.sf.saxon.expr.parser.PromotionOffer.UNORDERED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="REPLACE_CURRENT"><!-- --></A><H3>
REPLACE_CURRENT</H3>
<PRE>
public static final int <B>REPLACE_CURRENT</B></PRE>
<DL>
<DD>REPLACE_CURRENT causes calls to the XSLT current() function to be replaced by
reference to a variable. The variable binding is the single member of the array bindingList
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.sf.saxon.expr.parser.PromotionOffer.REPLACE_CURRENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EXTRACT_GLOBAL_VARIABLES"><!-- --></A><H3>
EXTRACT_GLOBAL_VARIABLES</H3>
<PRE>
public static final int <B>EXTRACT_GLOBAL_VARIABLES</B></PRE>
<DL>
<DD>EXTRACT_GLOBAL_VARIABLES identifies subexpressions that are not constant, but have no dependencies
other than on global variables or parameters (they must also be non-creative). Such expressions can
be extracted from a function or template and converted into global variables. This optimization is done
in Saxon-EE only.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#net.sf.saxon.expr.parser.PromotionOffer.EXTRACT_GLOBAL_VARIABLES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="visitor"><!-- --></A><H3>
visitor</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/parser/ExpressionVisitor.html" title="class in net.sf.saxon.expr.parser">ExpressionVisitor</A> <B>visitor</B></PRE>
<DL>
<DD>The expression visitor in use
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="action"><!-- --></A><H3>
action</H3>
<PRE>
public int <B>action</B></PRE>
<DL>
<DD>action is one of the possible promotion actions, FOCUS_INDEPENDENT, RANGE_INDEPENDENT,
INLINE_VARIABLE_REFERENCES, UNORDERED, EXTRACT_GLOBAL_VARIABLES
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="promoteDocumentDependent"><!-- --></A><H3>
promoteDocumentDependent</H3>
<PRE>
public boolean <B>promoteDocumentDependent</B></PRE>
<DL>
<DD>In the case of FOCUS_INDEPENDENT, "promoteDocumentDependent" is a boolean that, when set to
true, indicates that it is safe to promote a subexpression that depends on the context document
but not on other aspects of the focus. This is the case, for example, in a filter expression when
it is known that all the nodes selected by the expression will be in the same document - as happens
when the filter is applied to a path expression. This allows subexpressions such as key() to be
promoted
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="promoteXSLTFunctions"><!-- --></A><H3>
promoteXSLTFunctions</H3>
<PRE>
public boolean <B>promoteXSLTFunctions</B></PRE>
<DL>
<DD>In the case of FOCUS_INDEPENDENT, "promoteXSLTFunctions" is a boolean that, when set to true, indicates
that it is safe to promote XSLT functions such as current(). This flag is set when rewriting XPath expressions
and is unset when rewriting XSLT templates.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="retainAllNodes"><!-- --></A><H3>
retainAllNodes</H3>
<PRE>
public boolean <B>retainAllNodes</B></PRE>
<DL>
<DD>In the case of UNORDERED, "retainAllNodes" is a boolean that is set to
true if the nodes can be delivered in any order so long as the right number of nodes
are delivered. If this boolean is false, the caller doesn't care whether duplicate nodes
are retained or whether they are eliminated.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="bindingList"><!-- --></A><H3>
bindingList</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Binding.html" title="interface in net.sf.saxon.expr">Binding</A>[] <B>bindingList</B></PRE>
<DL>
<DD>In the case of RANGE_INDEPENDENT, "binding" identifies the range variables whose dependencies
we are looking for. For INLINE_VARIABLE_REFERENCES it is a single Binding that we are aiming to inline
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="containingExpression"><!-- --></A><H3>
containingExpression</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>containingExpression</B></PRE>
<DL>
<DD>When a promotion offer is made, containingExpression identifies the level to which the promotion
should occur. When a subexpression is promoted, an expression of the form let $VAR := SUB return ORIG
is created, and this replaces the original containingExpression within the PromotionOffer.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="accepted"><!-- --></A><H3>
accepted</H3>
<PRE>
public boolean <B>accepted</B></PRE>
<DL>
<DD>Flag that is set if the offer has been accepted, that is, if the expression has changed
<P>
<DL>
</DL>
</DL>
<!-- ========= 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="PromotionOffer(net.sf.saxon.expr.parser.Optimizer)"><!-- --></A><H3>
PromotionOffer</H3>
<PRE>
public <B>PromotionOffer</B>(<A HREF="../../../../../net/sf/saxon/expr/parser/Optimizer.html" title="class in net.sf.saxon.expr.parser">Optimizer</A> optimizer)</PRE>
<DL>
<DD>Create a PromotionOffer for use with a particular Optimizer
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>optimizer</CODE> - the optimizer</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="getOptimizer()"><!-- --></A><H3>
getOptimizer</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/parser/Optimizer.html" title="class in net.sf.saxon.expr.parser">Optimizer</A> <B>getOptimizer</B>()</PRE>
<DL>
<DD>Get the optimizer in use
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the optimizer</DL>
</DD>
</DL>
<HR>
<A NAME="accept(net.sf.saxon.expr.Expression, net.sf.saxon.expr.Expression)"><!-- --></A><H3>
accept</H3>
<PRE>
public <A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> <B>accept</B>(<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> parent,
<A HREF="../../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> child)
throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Method to test whether a subexpression qualifies for promotion, and if so, to
accept the promotion.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - <DD><CODE>child</CODE> - the subexpression in question
<DT><B>Returns:</B><DD>if promotion was done, returns the expression that should be used in place
of the child expression. If no promotion was done, returns null. If promotion is
determined not to be necessary for this subtree, returns the supplied child expression
unchanged
<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/parser/PathMap.PathMapRoot.html" title="class in net.sf.saxon.expr.parser"><B>PREV CLASS</B></A>
<A HREF="../../../../../net/sf/saxon/expr/parser/RoleLocator.html" title="class in net.sf.saxon.expr.parser"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/expr/parser/PromotionOffer.html" target="_top"><B>FRAMES</B></A>
<A HREF="PromotionOffer.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="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <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>
