<!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:27 GMT 2011 -->
<TITLE>
XQueryExecutable
</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="XQueryExecutable";
}
}
</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/s9api/XQueryEvaluator.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XsltCompiler.html" title="class in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/XQueryExecutable.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQueryExecutable.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.s9api</FONT>
<BR>
Class XQueryExecutable</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.s9api.XQueryExecutable</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>XQueryExecutable</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>
An XQueryExecutable represents the compiled form of a query.
To execute the query, it must first be loaded to form an <A HREF="../../../../net/sf/saxon/s9api/XQueryEvaluator.html" title="class in net.sf.saxon.s9api"><CODE>XQueryEvaluator</CODE></A>.
<p>An XQueryExecutable is immutable, and therefore thread-safe.
It is simplest to load a new XQueryEvaluator each time the query is to be run.
However, the XQueryEvaluator is serially reusable within a single thread. </p>
<p>An XQueryExecutable is created by using one of the <code>compile</code> methods on the
<A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html" title="class in net.sf.saxon.s9api"><CODE>XQueryCompiler</CODE></A> class.</p>
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
<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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html#XQueryExecutable(net.sf.saxon.s9api.Processor, net.sf.saxon.query.XQueryExpression)">XQueryExecutable</A></B>(<A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> processor,
<A HREF="../../../../net/sf/saxon/query/XQueryExpression.html" title="class in net.sf.saxon.query">XQueryExpression</A> exp)</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/s9api/OccurrenceIndicator.html" title="enum in net.sf.saxon.s9api">OccurrenceIndicator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html#getResultCardinality()">getResultCardinality</A></B>()</CODE>
<BR>
Get the statically-determined cardinality of the result of the query.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html#getResultItemType()">getResultItemType</A></B>()</CODE>
<BR>
Get the ItemType of the items in the result of the query, as determined by static analysis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/query/XQueryExpression.html" title="class in net.sf.saxon.query">XQueryExpression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html#getUnderlyingCompiledQuery()">getUnderlyingCompiledQuery</A></B>()</CODE>
<BR>
Get the underlying implementation object representing the compiled stylesheet.</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/s9api/XQueryExecutable.html#isUpdateQuery()">isUpdateQuery</A></B>()</CODE>
<BR>
Ask whether the query is an updating query: that is, whether it returns a Pending Update List
rather than a Value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XQueryEvaluator.html" title="class in net.sf.saxon.s9api">XQueryEvaluator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html#load()">load</A></B>()</CODE>
<BR>
Load the stylesheet to prepare it for execution.</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="XQueryExecutable(net.sf.saxon.s9api.Processor, net.sf.saxon.query.XQueryExpression)"><!-- --></A><H3>
XQueryExecutable</H3>
<PRE>
protected <B>XQueryExecutable</B>(<A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> processor,
<A HREF="../../../../net/sf/saxon/query/XQueryExpression.html" title="class in net.sf.saxon.query">XQueryExpression</A> exp)</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="load()"><!-- --></A><H3>
load</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryEvaluator.html" title="class in net.sf.saxon.s9api">XQueryEvaluator</A> <B>load</B>()</PRE>
<DL>
<DD>Load the stylesheet to prepare it for execution.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>An XsltTransformer. The returned XsltTransformer can be used to set up the
dynamic context for stylesheet evaluation, and to run the stylesheet.</DL>
</DD>
</DL>
<HR>
<A NAME="getResultItemType()"><!-- --></A><H3>
getResultItemType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A> <B>getResultItemType</B>()</PRE>
<DL>
<DD>Get the ItemType of the items in the result of the query, as determined by static analysis. This
is the most precise ItemType that the processor is able to determine from static examination of the
query; the actual items in the query result are guaranteed to belong to this ItemType or to a subtype
of this ItemType.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the statically-determined ItemType of the result of the query<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getResultCardinality()"><!-- --></A><H3>
getResultCardinality</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/OccurrenceIndicator.html" title="enum in net.sf.saxon.s9api">OccurrenceIndicator</A> <B>getResultCardinality</B>()</PRE>
<DL>
<DD>Get the statically-determined cardinality of the result of the query. This is the most precise cardinality
that the processor is able to determine from static examination of the query.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the statically-determined cardinality of the result of the query<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isUpdateQuery()"><!-- --></A><H3>
isUpdateQuery</H3>
<PRE>
public boolean <B>isUpdateQuery</B>()</PRE>
<DL>
<DD>Ask whether the query is an updating query: that is, whether it returns a Pending Update List
rather than a Value. Note that queries using the XUpdate copy-modify syntax are not considered
to be updating queries.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the query is an updating query, false if not<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getUnderlyingCompiledQuery()"><!-- --></A><H3>
getUnderlyingCompiledQuery</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/query/XQueryExpression.html" title="class in net.sf.saxon.query">XQueryExpression</A> <B>getUnderlyingCompiledQuery</B>()</PRE>
<DL>
<DD>Get the underlying implementation object representing the compiled stylesheet. This provides
an escape hatch into lower-level APIs. The object returned by this method may change from release
to release.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the underlying implementation of the compiled stylesheet</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/s9api/XQueryEvaluator.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XsltCompiler.html" title="class in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/XQueryExecutable.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQueryExecutable.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>
