<!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>
XQueryCompiler
</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="XQueryCompiler";
}
}
</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/XPathSelector.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XQueryEvaluator.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/XQueryCompiler.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQueryCompiler.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 XQueryCompiler</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.XQueryCompiler</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>XQueryCompiler</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 XQueryCompiler object allows XQuery 1.0 queries to be compiled. The compiler holds information that
represents the static context for the compilation.
<p>To construct an XQueryCompiler, use the factory method <A HREF="../../../../net/sf/saxon/s9api/Processor.html#newXQueryCompiler()"><CODE>Processor.newXQueryCompiler()</CODE></A>.</p>
<p>An XQueryCompiler may be used repeatedly to compile multiple queries. Any changes made to the
XQueryCompiler (that is, to the static context) do not affect queries that have already been compiled.
An XQueryCompiler may be used concurrently in multiple threads, but it should not then be modified once
initialized.</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/XQueryCompiler.html#XQueryCompiler(net.sf.saxon.s9api.Processor)">XQueryCompiler</A></B>(<A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> processor)</CODE>
<BR>
Protected constructor</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/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#compile(java.io.File)">compile</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> query)</CODE>
<BR>
Compile a query supplied as a file</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#compile(java.io.InputStream)">compile</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> query)</CODE>
<BR>
Compile a query supplied as an InputStream</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#compile(java.io.Reader)">compile</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> query)</CODE>
<BR>
Compile a query supplied as a Reader</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#compile(java.lang.String)">compile</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> query)</CODE>
<BR>
Compile a query supplied as a string.</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/s9api/XQueryCompiler.html#compileLibrary(java.io.File)">compileLibrary</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> query)</CODE>
<BR>
Compile a library module supplied as a file.</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/s9api/XQueryCompiler.html#compileLibrary(java.io.InputStream)">compileLibrary</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> query)</CODE>
<BR>
Compile a library module supplied as an InputStream.</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/s9api/XQueryCompiler.html#compileLibrary(java.io.Reader)">compileLibrary</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> query)</CODE>
<BR>
Compile a library module supplied as a Reader.</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/s9api/XQueryCompiler.html#compileLibrary(java.lang.String)">compileLibrary</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> query)</CODE>
<BR>
Compile a library module supplied as a string.</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/s9api/XQueryCompiler.html#declareCollation(java.lang.String, java.text.Collator)">declareCollation</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text">Collator</A> collation)</CODE>
<BR>
Bind a collation URI to a collation</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/s9api/XQueryCompiler.html#declareDefaultCollation(java.lang.String)">declareDefaultCollation</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri)</CODE>
<BR>
Declare the default collation</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/s9api/XQueryCompiler.html#declareNamespace(java.lang.String, java.lang.String)">declareNamespace</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> prefix,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri)</CODE>
<BR>
Declare a namespace binding as part of the static context for queries compiled using this
XQueryCompiler.</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/net/URI.html?is-external=true" title="class or interface in java.net">URI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getBaseURI()">getBaseURI</A></B>()</CODE>
<BR>
Get the static base URI for the query</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getEncoding()">getEncoding</A></B>()</CODE>
<BR>
Get the encoding previously set for the supplied query.</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/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getErrorListener()">getErrorListener</A></B>()</CODE>
<BR>
Get the ErrorListener being used during this compilation episode</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getLanguageVersion()">getLanguageVersion</A></B>()</CODE>
<BR>
Ask whether an XQuery 1.0 or XQuery 1.1 processor is being used</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/lib/ModuleURIResolver.html" title="interface in net.sf.saxon.lib">ModuleURIResolver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getModuleURIResolver()">getModuleURIResolver</A></B>()</CODE>
<BR>
Get the user-defined ModuleURIResolver for resolving URIs used in <code>import module</code>
declarations in the XQuery prolog; returns null if none has been explicitly set either
here or in the Saxon Configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getProcessor()">getProcessor</A></B>()</CODE>
<BR>
Get the Processor from which this XQueryCompiler was constructed</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/XQueryCompiler.html#getRequiredContextItemType()">getRequiredContextItemType</A></B>()</CODE>
<BR>
Get the required type of the context item.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/query/StaticQueryContext.html" title="class in net.sf.saxon.query">StaticQueryContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#getUnderlyingStaticContext()">getUnderlyingStaticContext</A></B>()</CODE>
<BR>
Get the underlying <A HREF="../../../../net/sf/saxon/query/StaticQueryContext.html" title="class in net.sf.saxon.query"><CODE>StaticQueryContext</CODE></A> object that maintains the static context
information on behalf of this XQueryCompiler.</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/XQueryCompiler.html#isCompileWithTracing()">isCompileWithTracing</A></B>()</CODE>
<BR>
Ask whether trace hooks are included in the compiled code.</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/XQueryCompiler.html#isSchemaAware()">isSchemaAware</A></B>()</CODE>
<BR>
Ask whether schema-awareness has been requested either by means of a call on
<A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setSchemaAware(boolean)"><CODE>setSchemaAware(boolean)</CODE></A></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/XQueryCompiler.html#isUpdatingEnabled()">isUpdatingEnabled</A></B>()</CODE>
<BR>
Ask whether the query is allowed to use XQuery Update syntax</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/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)">setBaseURI</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> baseURI)</CODE>
<BR>
Set the static base URI for the query</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/s9api/XQueryCompiler.html#setCompileWithTracing(boolean)">setCompileWithTracing</A></B>(boolean option)</CODE>
<BR>
Set whether trace hooks are to be included in the compiled code.</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/s9api/XQueryCompiler.html#setEncoding(java.lang.String)">setEncoding</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> encoding)</CODE>
<BR>
Set the encoding of the supplied query.</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/s9api/XQueryCompiler.html#setErrorListener(javax.xml.transform.ErrorListener)">setErrorListener</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A> listener)</CODE>
<BR>
Set the ErrorListener to be used during this query compilation episode</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/s9api/XQueryCompiler.html#setLanguageVersion(java.lang.String)">setLanguageVersion</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> version)</CODE>
<BR>
Say whether an XQuery 1.0 or XQuery 3.0 processor is required.</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/s9api/XQueryCompiler.html#setModuleURIResolver(net.sf.saxon.lib.ModuleURIResolver)">setModuleURIResolver</A></B>(<A HREF="../../../../net/sf/saxon/lib/ModuleURIResolver.html" title="interface in net.sf.saxon.lib">ModuleURIResolver</A> resolver)</CODE>
<BR>
Set a user-defined ModuleURIResolver for resolving URIs used in <code>import module</code>
declarations in the XQuery prolog.</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/s9api/XQueryCompiler.html#setRequiredContextItemType(net.sf.saxon.s9api.ItemType)">setRequiredContextItemType</A></B>(<A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A> type)</CODE>
<BR>
Declare the static type of the context item.</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/s9api/XQueryCompiler.html#setSchemaAware(boolean)">setSchemaAware</A></B>(boolean schemaAware)</CODE>
<BR>
Say that the query must be compiled to be schema-aware, even if it contains no
"import schema" declarations.</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/s9api/XQueryCompiler.html#setUpdatingEnabled(boolean)">setUpdatingEnabled</A></B>(boolean updating)</CODE>
<BR>
Say whether the query is allowed to be updating.</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="XQueryCompiler(net.sf.saxon.s9api.Processor)"><!-- --></A><H3>
XQueryCompiler</H3>
<PRE>
protected <B>XQueryCompiler</B>(<A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> processor)</PRE>
<DL>
<DD>Protected constructor
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>processor</CODE> - the Saxon Processor</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="getProcessor()"><!-- --></A><H3>
getProcessor</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> <B>getProcessor</B>()</PRE>
<DL>
<DD>Get the Processor from which this XQueryCompiler was constructed
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the Processor to which this XQueryCompiler belongs<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setBaseURI(java.net.URI)"><!-- --></A><H3>
setBaseURI</H3>
<PRE>
public void <B>setBaseURI</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> baseURI)</PRE>
<DL>
<DD>Set the static base URI for the query
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseURI</CODE> - the static base URI</DL>
</DD>
</DL>
<HR>
<A NAME="getBaseURI()"><!-- --></A><H3>
getBaseURI</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> <B>getBaseURI</B>()</PRE>
<DL>
<DD>Get the static base URI for the query
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the static base URI</DL>
</DD>
</DL>
<HR>
<A NAME="setErrorListener(javax.xml.transform.ErrorListener)"><!-- --></A><H3>
setErrorListener</H3>
<PRE>
public void <B>setErrorListener</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A> listener)</PRE>
<DL>
<DD>Set the ErrorListener to be used during this query compilation episode
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - The error listener to be used. This is notified of all errors detected during the
compilation.</DL>
</DD>
</DL>
<HR>
<A NAME="getErrorListener()"><!-- --></A><H3>
getErrorListener</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A> <B>getErrorListener</B>()</PRE>
<DL>
<DD>Get the ErrorListener being used during this compilation episode
<P>
<DD><DL>
<DT><B>Returns:</B><DD>listener The error listener in use. This is notified of all errors detected during the
compilation. If no user-supplied ErrorListener has been set, returns the system-supplied
ErrorListener.</DL>
</DD>
</DL>
<HR>
<A NAME="setCompileWithTracing(boolean)"><!-- --></A><H3>
setCompileWithTracing</H3>
<PRE>
public void <B>setCompileWithTracing</B>(boolean option)</PRE>
<DL>
<DD>Set whether trace hooks are to be included in the compiled code. To use tracing, it is necessary
both to compile the code with trace hooks included, and to supply a TraceListener at run-time
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>option</CODE> - true if trace code is to be compiled in, false otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="isCompileWithTracing()"><!-- --></A><H3>
isCompileWithTracing</H3>
<PRE>
public boolean <B>isCompileWithTracing</B>()</PRE>
<DL>
<DD>Ask whether trace hooks are included in the compiled code.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if trace hooks are included, false if not.</DL>
</DD>
</DL>
<HR>
<A NAME="setModuleURIResolver(net.sf.saxon.lib.ModuleURIResolver)"><!-- --></A><H3>
setModuleURIResolver</H3>
<PRE>
public void <B>setModuleURIResolver</B>(<A HREF="../../../../net/sf/saxon/lib/ModuleURIResolver.html" title="interface in net.sf.saxon.lib">ModuleURIResolver</A> resolver)</PRE>
<DL>
<DD>Set a user-defined ModuleURIResolver for resolving URIs used in <code>import module</code>
declarations in the XQuery prolog.
This will override any ModuleURIResolver that was specified as part of the configuration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resolver</CODE> - the ModuleURIResolver to be used</DL>
</DD>
</DL>
<HR>
<A NAME="getModuleURIResolver()"><!-- --></A><H3>
getModuleURIResolver</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/lib/ModuleURIResolver.html" title="interface in net.sf.saxon.lib">ModuleURIResolver</A> <B>getModuleURIResolver</B>()</PRE>
<DL>
<DD>Get the user-defined ModuleURIResolver for resolving URIs used in <code>import module</code>
declarations in the XQuery prolog; returns null if none has been explicitly set either
here or in the Saxon Configuration.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the registered ModuleURIResolver</DL>
</DD>
</DL>
<HR>
<A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
setEncoding</H3>
<PRE>
public void <B>setEncoding</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> encoding)</PRE>
<DL>
<DD>Set the encoding of the supplied query. This is ignored if the query is supplied
in character form, that is, as a <code>String</code> or as a <code>Reader</code>. If no value
is set, the query processor will attempt to infer the encoding, defaulting to UTF-8 if no
information is available.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the encoding of the supplied query, for example "iso-8859-1"<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getEncoding()"><!-- --></A><H3>
getEncoding</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getEncoding</B>()</PRE>
<DL>
<DD>Get the encoding previously set for the supplied query.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the encoding previously set using <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setEncoding(java.lang.String)"><CODE>setEncoding(String)</CODE></A>, or null
if no value has been set. Note that this is not necessarily the actual encoding of the query.<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setUpdatingEnabled(boolean)"><!-- --></A><H3>
setUpdatingEnabled</H3>
<PRE>
public void <B>setUpdatingEnabled</B>(boolean updating)</PRE>
<DL>
<DD>Say whether the query is allowed to be updating. XQuery update syntax will be rejected
during query compilation unless this flag is set. XQuery Update is supported only under Saxon-EE.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>updating</CODE> - true if the query is allowed to use the XQuery Update facility
(requires Saxon-EE). If set to false, the query must not be an updating query. If set
to true, it may be either an updating or a non-updating query.<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isUpdatingEnabled()"><!-- --></A><H3>
isUpdatingEnabled</H3>
<PRE>
public boolean <B>isUpdatingEnabled</B>()</PRE>
<DL>
<DD>Ask whether the query is allowed to use XQuery Update syntax
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the query is allowed to use the XQuery Update facility. Note that this
does not necessarily mean that the query is an updating query; but if the value is false,
the it must definitely be non-updating.<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSchemaAware(boolean)"><!-- --></A><H3>
setSchemaAware</H3>
<PRE>
public void <B>setSchemaAware</B>(boolean schemaAware)</PRE>
<DL>
<DD>Say that the query must be compiled to be schema-aware, even if it contains no
"import schema" declarations. Normally a query is treated as schema-aware
only if it contains one or more "import schema" declarations. If it is not schema-aware,
then all input documents must be untyped (or xs:anyType), and validation of temporary nodes is disallowed
(though validation of the final result tree is permitted). Setting the argument to true
means that schema-aware code will be compiled regardless.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>schemaAware</CODE> - If true, the stylesheet will be compiled with schema-awareness
enabled even if it contains no xsl:import-schema declarations. If false, the stylesheet
is treated as schema-aware only if it contains one or more xsl:import-schema declarations.<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isSchemaAware()"><!-- --></A><H3>
isSchemaAware</H3>
<PRE>
public boolean <B>isSchemaAware</B>()</PRE>
<DL>
<DD>Ask whether schema-awareness has been requested either by means of a call on
<A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setSchemaAware(boolean)"><CODE>setSchemaAware(boolean)</CODE></A>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if schema-awareness has been requested<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setLanguageVersion(java.lang.String)"><!-- --></A><H3>
setLanguageVersion</H3>
<PRE>
public void <B>setLanguageVersion</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> version)</PRE>
<DL>
<DD>Say whether an XQuery 1.0 or XQuery 3.0 processor is required.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>version</CODE> - Must be "1.0" or "3.0". At present onle limited support
for XQuery 3.01 is available. This functionality is available only in Saxon-EE, and it cannot
be used in conjunction with XQuery Updates. To use XQuery 3.0 features,
the query prolog must also specify version="3.0".
<p>In Saxon 9.3, the value "1.1" is accepted as a synonym for "3.0".</p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the version is not 1.0 or 3.0.<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLanguageVersion()"><!-- --></A><H3>
getLanguageVersion</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLanguageVersion</B>()</PRE>
<DL>
<DD>Ask whether an XQuery 1.0 or XQuery 1.1 processor is being used
<P>
<DD><DL>
<DT><B>Returns:</B><DD>version: "1.0" or "3.0"<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="declareNamespace(java.lang.String, java.lang.String)"><!-- --></A><H3>
declareNamespace</H3>
<PRE>
public void <B>declareNamespace</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> prefix,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri)</PRE>
<DL>
<DD>Declare a namespace binding as part of the static context for queries compiled using this
XQueryCompiler. This binding may be overridden by a binding that appears in the query prolog.
The namespace binding will form part of the static context of the query, but it will not be copied
into result trees unless the prefix is actually used in an element or attribute name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The namespace prefix. If the value is a zero-length string, this method sets the default
namespace for elements and types.<DD><CODE>uri</CODE> - The namespace URI. It is possible to specify a zero-length string to "undeclare" a namespace;
in this case the prefix will not be available for use, except in the case where the prefix
is also a zero length string, in which case the absence of a prefix implies that the name
is in no namespace.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if either the prefix or uri is null.
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - in the event of an invalid declaration of the XML namespace</DL>
</DD>
</DL>
<HR>
<A NAME="declareCollation(java.lang.String, java.text.Collator)"><!-- --></A><H3>
declareCollation</H3>
<PRE>
public void <B>declareCollation</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text">Collator</A> collation)</PRE>
<DL>
<DD>Bind a collation URI to a collation
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the absolute collation URI<DD><CODE>collation</CODE> - a <A HREF="http://download.oracle.com/javase/6/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text"><CODE>Collator</CODE></A> object that implements the required collation
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an attempt is made to rebind the standard URI
for the Unicode codepoint collation<DT><B>Since:</B></DT>
<DD>9.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="declareDefaultCollation(java.lang.String)"><!-- --></A><H3>
declareDefaultCollation</H3>
<PRE>
public void <B>declareDefaultCollation</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> uri)</PRE>
<DL>
<DD>Declare the default collation
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the absolute URI of the default collation. This URI must have been bound to a collation
using the method <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#declareCollation(java.lang.String, java.text.Collator)"><CODE>declareCollation(String, java.text.Collator)</CODE></A>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the collation URI has not been registered, unless it is the standard
Unicode codepoint collation which is registered implicitly<DT><B>Since:</B></DT>
<DD>9.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setRequiredContextItemType(net.sf.saxon.s9api.ItemType)"><!-- --></A><H3>
setRequiredContextItemType</H3>
<PRE>
public void <B>setRequiredContextItemType</B>(<A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A> type)</PRE>
<DL>
<DD>Declare the static type of the context item. If this type is declared, and if a context item
is supplied when the query is invoked, then the context item must conform to this type (no
type conversion will take place to force it into this type).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the required type of the context item</DL>
</DD>
</DL>
<HR>
<A NAME="getRequiredContextItemType()"><!-- --></A><H3>
getRequiredContextItemType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/ItemType.html" title="class in net.sf.saxon.s9api">ItemType</A> <B>getRequiredContextItemType</B>()</PRE>
<DL>
<DD>Get the required type of the context item. If no type has been explicitly declared for the context
item, an instance of AnyItemType (representing the type item()) is returned.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the required type of the context item</DL>
</DD>
</DL>
<HR>
<A NAME="compileLibrary(java.lang.String)"><!-- --></A><H3>
compileLibrary</H3>
<PRE>
public void <B>compileLibrary</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Compile a library module supplied as a string. The code generated by compiling the library is available
for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
"import module" declaration that specifies the module URI of the library module. No module location
hint is required, and if one is present, it is ignored.
<p>The base URI of the query should be supplied by calling <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> </p>
<p>Separate compilation of library modules is supported only under Saxon-EE</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text of the query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileLibrary(java.io.File)"><!-- --></A><H3>
compileLibrary</H3>
<PRE>
public void <B>compileLibrary</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A>,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Compile a library module supplied as a file. The code generated by compiling the library is available
for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
"import module" declaration that specifies the module URI of the library module. No module location
hint is required, and if one is present, it is ignored.
<p>The encoding of the input stream may be specified using <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setEncoding(java.lang.String)"><CODE>setEncoding(String)</CODE></A>;
if this has not been set, the compiler determines the encoding from the version header of the
query, and if that too is absent, it assumes UTF-8.</p>
<p>Separate compilation of library modules is supported only under Saxon-EE</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the file containing the query. The URI corresponding to this file will be used as the
base URI of the query, overriding any URI supplied using <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> (but not
overriding any base URI specified within the query prolog)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if the file does not exist or cannot be read<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileLibrary(java.io.Reader)"><!-- --></A><H3>
compileLibrary</H3>
<PRE>
public void <B>compileLibrary</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Compile a library module supplied as a Reader. The code generated by compiling the library is available
for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
"import module" declaration that specifies the module URI of the library module. No module location
hint is required, and if one is present, it is ignored.
<p>The base URI of the query should be supplied by calling <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> </p>
<p>Separate compilation of library modules is supported only under Saxon-EE</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text of the query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileLibrary(java.io.InputStream)"><!-- --></A><H3>
compileLibrary</H3>
<PRE>
public void <B>compileLibrary</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Compile a library module supplied as an InputStream. The code generated by compiling the library is available
for importing by all subsequent compilations using the same XQueryCompiler; it is identified by an
"import module" declaration that specifies the module URI of the library module. No module location
hint is required, and if one is present, it is ignored.
<p>The encoding of the input stream may be specified using <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setEncoding(java.lang.String)"><CODE>setEncoding(String)</CODE></A>;
if this has not been set, the compiler determines the encoding from the version header of the
query, and if that too is absent, it assumes UTF-8. </p>
<p>The base URI of the query should be supplied by calling <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> </p>
<p>Separate compilation of library modules is supported only under Saxon-EE</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text of the query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compile(java.lang.String)"><!-- --></A><H3>
compile</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> <B>compile</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Compile a query supplied as a string.
<p>The base URI of the query should be supplied by calling <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text of the query
<DT><B>Returns:</B><DD>an XQueryExecutable representing the compiled query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compile(java.io.File)"><!-- --></A><H3>
compile</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> <B>compile</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A>,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Compile a query supplied as a file
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the file containing the query. The URI corresponding to this file will be used as the
base URI of the query, overriding any URI supplied using <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> (but not
overriding any base URI specified within the query prolog)
<DT><B>Returns:</B><DD>an XQueryExecutable representing the compiled query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if the file does not exist or cannot be read<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compile(java.io.InputStream)"><!-- --></A><H3>
compile</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> <B>compile</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A>,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Compile a query supplied as an InputStream
<p>The base URI of the query should be supplied by calling <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the input stream on which the query is supplied. This will be consumed by this method
<DT><B>Returns:</B><DD>an XQueryExecutable representing the compiled query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if the file does not exist or cannot be read<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="compile(java.io.Reader)"><!-- --></A><H3>
compile</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> <B>compile</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> query)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A>,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Compile a query supplied as a Reader
<p>The base URI of the query should be supplied by calling <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html#setBaseURI(java.net.URI)"><CODE>setBaseURI(java.net.URI)</CODE></A> </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the input stream on which the query is supplied. This will be consumed by this method
<DT><B>Returns:</B><DD>an XQueryExecutable representing the compiled query
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the query compilation fails with a static error
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if the file does not exist or cannot be read<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getUnderlyingStaticContext()"><!-- --></A><H3>
getUnderlyingStaticContext</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/query/StaticQueryContext.html" title="class in net.sf.saxon.query">StaticQueryContext</A> <B>getUnderlyingStaticContext</B>()</PRE>
<DL>
<DD>Get the underlying <A HREF="../../../../net/sf/saxon/query/StaticQueryContext.html" title="class in net.sf.saxon.query"><CODE>StaticQueryContext</CODE></A> object that maintains the static context
information on behalf of this XQueryCompiler. This method provides an escape hatch to internal Saxon
implementation objects that offer a finer and lower-level degree of control than the s9api classes and
methods. Some of these classes and methods may change from release to release.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the underlying StaticQueryContext object<DT><B>Since:</B></DT>
<DD>9.2</DD>
</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/XPathSelector.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XQueryEvaluator.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/XQueryCompiler.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQueryCompiler.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>
