<!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:46 GMT 2011 --> <TITLE> XQStaticContext </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="XQStaticContext"; } } </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="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?javax/xml/xquery/XQStaticContext.html" target="_top"><B>FRAMES</B></A> <A HREF="XQStaticContext.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <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"> javax.xml.xquery</FONT> <BR> Interface XQStaticContext</H2> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../net/sf/saxon/xqj/SaxonXQStaticContext.html" title="class in net.sf.saxon.xqj">SaxonXQStaticContext</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>XQStaticContext</B></DL> </PRE> <P> An <code>XQStaticContext</code> represents default values for various <a href="http://www.w3.org/TR/xquery/#id-xq-static-context-components"> <i>XQuery Static Context Components</i></a>. Further it includes the static XQJ properties for an <code>XQExpression</code> or <code>XQPreparedExpression</code> object. <p> The following XQuery Static Context Components are supported through the <code>XQStaticContext</code> interface: <ul> <li>Statically known namespaces <li>Default element/type namespace <li>Default function namespace <li>Context item static type <li>Default collation <li>Construction mode <li>Ordering mode <li>Default order for empty sequences <li>Boundary-space policy <li>Copy-namespaces mode <li>Base URI </ul> As described in the XQuery specification, each of these default values can be overridden or augmented in the query prolog.<br> <p> In addition <code>XQStaticContext</code> includes the static XQJ properties for an <code>XQExpression</code> or <code>XQPreparedExpression</code> object: <ul> <li>Binding mode <li>Holdability of the result sequences <li>Scrollability of the result sequences <li>Query language <li>Query timeout </ul> <p> Note that <code>XQStaticContext</code> is a value object, changing attributes in such object doesn't affect any existing <code>XQExpression</code> or <code>XQPreparedExpression</code> object.<br> In order to take effect, the application needs to explicitly change the <code>XQConnection</code> default values, or specify an <code>XQStaticContext</code> object when creating an <code>XQExpression</code> or <code>XQPreparedExpression</code>. <pre> XQConnection conn = XQDatasource.getConnection(); // get the default values from the implementation XQStaticContext cntxt = conn.getStaticContext(); // change the base uri cntxt.setBaseURI("http://www.foo.com/xml/"); // change the implementation defaults conn.setStaticContext(cntxt); // create an XQExpression using the new defaults XQExpression expr1 = conn.createExpression(); // creat an XQExpression, using BaseURI "file:///root/user/john/" cntxt.setBaseURI("file:///root/user/john/"); XQExpression expr2 = conn.createExpression(cntxt); ... </pre> <P> <P> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStaticContext.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> Declares a namespace prefix and associates it with a namespace URI.</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="../../../javax/xml/xquery/XQStaticContext.html#getBaseURI()">getBaseURI</A></B>()</CODE> <BR> Gets the Base URI, if set in the static context, else the empty string.</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="../../../javax/xml/xquery/XQStaticContext.html#getBindingMode()">getBindingMode</A></B>()</CODE> <BR> Gets the value of the binding mode property.</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="../../../javax/xml/xquery/XQStaticContext.html#getBoundarySpacePolicy()">getBoundarySpacePolicy</A></B>()</CODE> <BR> Gets the boundary-space policy defined in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#getConstructionMode()">getConstructionMode</A></B>()</CODE> <BR> Gets the construction mode defined in the static context.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../javax/xml/xquery/XQItemType.html" title="interface in javax.xml.xquery">XQItemType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStaticContext.html#getContextItemStaticType()">getContextItemStaticType</A></B>()</CODE> <BR> Gets 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> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../javax/xml/xquery/XQStaticContext.html#getCopyNamespacesModeInherit()">getCopyNamespacesModeInherit</A></B>()</CODE> <BR> Gets the inherit part of the copy-namespaces mode defined in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#getCopyNamespacesModePreserve()">getCopyNamespacesModePreserve</A></B>()</CODE> <BR> Gets the preserve part of the copy-namespaces mode defined in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#getDefaultCollation()">getDefaultCollation</A></B>()</CODE> <BR> Gets the URI of the default collation.</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="../../../javax/xml/xquery/XQStaticContext.html#getDefaultElementTypeNamespace()">getDefaultElementTypeNamespace</A></B>()</CODE> <BR> Gets the URI of the default element/type namespace, the empty string if not set.</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="../../../javax/xml/xquery/XQStaticContext.html#getDefaultFunctionNamespace()">getDefaultFunctionNamespace</A></B>()</CODE> <BR> Gets the URI of the default function namespace, the empty string if not set.</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="../../../javax/xml/xquery/XQStaticContext.html#getDefaultOrderForEmptySequences()">getDefaultOrderForEmptySequences</A></B>()</CODE> <BR> Gets the default order for empty sequences defined in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#getHoldability()">getHoldability</A></B>()</CODE> <BR> Gets the value of the holdability property.</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="../../../javax/xml/xquery/XQStaticContext.html#getNamespacePrefixes()">getNamespacePrefixes</A></B>()</CODE> <BR> Returns the prefixes of all the statically known namespaces.</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="../../../javax/xml/xquery/XQStaticContext.html#getNamespaceURI(java.lang.String)">getNamespaceURI</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)</CODE> <BR> Retrieves the namespace URI associated with a prefix.</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="../../../javax/xml/xquery/XQStaticContext.html#getOrderingMode()">getOrderingMode</A></B>()</CODE> <BR> Gets the ordering mode defined in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#getQueryLanguageTypeAndVersion()">getQueryLanguageTypeAndVersion</A></B>()</CODE> <BR> Gets the value of the language type and version property.</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="../../../javax/xml/xquery/XQStaticContext.html#getQueryTimeout()">getQueryTimeout</A></B>()</CODE> <BR> Retrieves the number of seconds an implementation will wait for a query to execute.</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="../../../javax/xml/xquery/XQStaticContext.html#getScrollability()">getScrollability</A></B>()</CODE> <BR> Gets the value of the scrollability property.</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="../../../javax/xml/xquery/XQStaticContext.html#setBaseURI(java.lang.String)">setBaseURI</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> baseUri)</CODE> <BR> Sets the Base URI in the static context, specify the empty string to make it undefined.</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="../../../javax/xml/xquery/XQStaticContext.html#setBindingMode(int)">setBindingMode</A></B>(int bindingMode)</CODE> <BR> Sets the binding mode property.</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="../../../javax/xml/xquery/XQStaticContext.html#setBoundarySpacePolicy(int)">setBoundarySpacePolicy</A></B>(int policy)</CODE> <BR> Sets the boundary-space policy in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#setConstructionMode(int)">setConstructionMode</A></B>(int mode)</CODE> <BR> Sets the construction mode in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#setContextItemStaticType(javax.xml.xquery.XQItemType)">setContextItemStaticType</A></B>(<A HREF="../../../javax/xml/xquery/XQItemType.html" title="interface in javax.xml.xquery">XQItemType</A> contextItemType)</CODE> <BR> Sets the static type of the context item, specify <code>null</code> to make it unspecified.</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="../../../javax/xml/xquery/XQStaticContext.html#setCopyNamespacesModeInherit(int)">setCopyNamespacesModeInherit</A></B>(int mode)</CODE> <BR> Sets the inherit part of the copy-namespaces mode in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#setCopyNamespacesModePreserve(int)">setCopyNamespacesModePreserve</A></B>(int mode)</CODE> <BR> Sets the preserve part of the copy-namespaces mode in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#setDefaultCollation(java.lang.String)">setDefaultCollation</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> Sets the URI of 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="../../../javax/xml/xquery/XQStaticContext.html#setDefaultElementTypeNamespace(java.lang.String)">setDefaultElementTypeNamespace</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> Sets the URI of the default element/type namespace, the empty string to make it unspecified.</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="../../../javax/xml/xquery/XQStaticContext.html#setDefaultFunctionNamespace(java.lang.String)">setDefaultFunctionNamespace</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> Sets the URI of the default function namespace, the empty string to make it unspecified.</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="../../../javax/xml/xquery/XQStaticContext.html#setDefaultOrderForEmptySequences(int)">setDefaultOrderForEmptySequences</A></B>(int order)</CODE> <BR> Sets the default order for empty sequences in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#setHoldability(int)">setHoldability</A></B>(int holdability)</CODE> <BR> Sets the holdability property.</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="../../../javax/xml/xquery/XQStaticContext.html#setOrderingMode(int)">setOrderingMode</A></B>(int mode)</CODE> <BR> Sets the ordering mode in the static context.</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="../../../javax/xml/xquery/XQStaticContext.html#setQueryLanguageTypeAndVersion(int)">setQueryLanguageTypeAndVersion</A></B>(int langType)</CODE> <BR> Sets the input query language type and version.</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="../../../javax/xml/xquery/XQStaticContext.html#setQueryTimeout(int)">setQueryTimeout</A></B>(int seconds)</CODE> <BR> Sets the number of seconds an implementation will wait for a query to execute.</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="../../../javax/xml/xquery/XQStaticContext.html#setScrollability(int)">setScrollability</A></B>(int scrollability)</CODE> <BR> Sets the scrollability of the result sequence.</TD> </TR> </TABLE> <P> <!-- ============ 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="getNamespacePrefixes()"><!-- --></A><H3> getNamespacePrefixes</H3> <PRE> <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>getNamespacePrefixes</B>()</PRE> <DL> <DD>Returns the prefixes of all the statically known namespaces. Use the <code>getNamespaceURI</code> method to look up the namespace URI corresponding to a specific prefix. <P> <DD><DL> <DT><B>Returns:</B><DD><code>String</code> array containing the namespace prefixes. Cannot be <code>null</code></DL> </DD> </DL> <HR> <A NAME="getNamespaceURI(java.lang.String)"><!-- --></A><H3> getNamespaceURI</H3> <PRE> <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>getNamespaceURI</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) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Retrieves the namespace URI associated with a prefix. An <code>XQException</code> is thrown if an unknown prefix is specified, i.e. a prefix not returned by the <code>getInScopeNamespacePrefixes</code> method. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix for which the namespace URI is sought. Cannot be <code>null</code> <DT><B>Returns:</B><DD>the namespace URI. Cannot be <code>null</code> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if a <code>null</code> prefix is specified or if the prefix is unknown</DL> </DD> </DL> <HR> <A NAME="declareNamespace(java.lang.String, java.lang.String)"><!-- --></A><H3> declareNamespace</H3> <PRE> 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) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Declares a namespace prefix and associates it with a namespace URI. If the namespace URI is the empty string, the prefix is removed from the in-scope namespace definitions. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix for the namespace URI<DD><CODE>uri</CODE> - the namespace URI. An empty string undeclares the specific prefix. Cannot be <code>null</code> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if (1) a <code>null</code> prefix, or (2) a <code>null</code> namespace URI is specified</DL> </DD> </DL> <HR> <A NAME="getDefaultElementTypeNamespace()"><!-- --></A><H3> getDefaultElementTypeNamespace</H3> <PRE> <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>getDefaultElementTypeNamespace</B>()</PRE> <DL> <DD>Gets the URI of the default element/type namespace, the empty string if not set. <P> <DD><DL> <DT><B>Returns:</B><DD>the URI of the default element/type namespace, if set, else the empty string. Cannot be <code>null</code></DL> </DD> </DL> <HR> <A NAME="setDefaultElementTypeNamespace(java.lang.String)"><!-- --></A><H3> setDefaultElementTypeNamespace</H3> <PRE> void <B>setDefaultElementTypeNamespace</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) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the URI of the default element/type namespace, the empty string to make it unspecified. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the namespace URI of the default element/type namespace, the empty string to make it unspecified. Cannot be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if a <code>null</code> uri is specified</DL> </DD> </DL> <HR> <A NAME="getDefaultFunctionNamespace()"><!-- --></A><H3> getDefaultFunctionNamespace</H3> <PRE> <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>getDefaultFunctionNamespace</B>()</PRE> <DL> <DD>Gets the URI of the default function namespace, the empty string if not set. <P> <DD><DL> <DT><B>Returns:</B><DD>the URI of the default function namespace, if set, else the empty string. Cannot be <code>null</code></DL> </DD> </DL> <HR> <A NAME="setDefaultFunctionNamespace(java.lang.String)"><!-- --></A><H3> setDefaultFunctionNamespace</H3> <PRE> void <B>setDefaultFunctionNamespace</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) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the URI of the default function namespace, the empty string to make it unspecified. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the namespace URI of the default function namespace, the empty string to make it unspecified. Cannot be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if a <code>null</code> URI is specified</DL> </DD> </DL> <HR> <A NAME="getContextItemStaticType()"><!-- --></A><H3> getContextItemStaticType</H3> <PRE> <A HREF="../../../javax/xml/xquery/XQItemType.html" title="interface in javax.xml.xquery">XQItemType</A> <B>getContextItemStaticType</B>()</PRE> <DL> <DD>Gets the static type of the context item. <code>null</code> if unspecified. <P> <DD><DL> <DT><B>Returns:</B><DD>the static type of the context item, if set, else <code>null</code></DL> </DD> </DL> <HR> <A NAME="setContextItemStaticType(javax.xml.xquery.XQItemType)"><!-- --></A><H3> setContextItemStaticType</H3> <PRE> void <B>setContextItemStaticType</B>(<A HREF="../../../javax/xml/xquery/XQItemType.html" title="interface in javax.xml.xquery">XQItemType</A> contextItemType) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the static type of the context item, specify <code>null</code> to make it unspecified. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>contextItemType</CODE> - the static type of the context item; <code>null</code> if unspecified. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the <code>contextItemType</code> is not a valid <code>XQItemType</code></DL> </DD> </DL> <HR> <A NAME="getDefaultCollation()"><!-- --></A><H3> getDefaultCollation</H3> <PRE> <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>getDefaultCollation</B>()</PRE> <DL> <DD>Gets the URI of the default collation. <P> <DD><DL> <DT><B>Returns:</B><DD>the URI of the default collation. Cannot be <code>null</code>.</DL> </DD> </DL> <HR> <A NAME="setDefaultCollation(java.lang.String)"><!-- --></A><H3> setDefaultCollation</H3> <PRE> void <B>setDefaultCollation</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) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the URI of the default collation. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the namespace URI of the default collation. Cannot be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if a <code>null</code> URI is specified</DL> </DD> </DL> <HR> <A NAME="getConstructionMode()"><!-- --></A><H3> getConstructionMode</H3> <PRE> int <B>getConstructionMode</B>()</PRE> <DL> <DD>Gets the construction mode defined in the static context. <P> <DD><DL> <DT><B>Returns:</B><DD>construction mode value. One of: <code>XQConstants.CONSTRUCTION_MODE_PRESERVE</code>, <code>XQConstants.CONSTRUCTION_MODE_STRIP</code></DL> </DD> </DL> <HR> <A NAME="setConstructionMode(int)"><!-- --></A><H3> setConstructionMode</H3> <PRE> void <B>setConstructionMode</B>(int mode) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the construction mode in the static context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mode</CODE> - construction mode value. One of: <code>XQConstants.CONSTRUCTION_MODE_PRESERVE</code>, <code>XQConstants.CONSTRUCTION_MODE_STRIP</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified mode is different from <code>XQConstants.CONSTRUCTION_MODE_PRESERVE</code>, <code>XQConstants.CONSTRUCTION_MODE_STRIP</code></DL> </DD> </DL> <HR> <A NAME="getOrderingMode()"><!-- --></A><H3> getOrderingMode</H3> <PRE> int <B>getOrderingMode</B>()</PRE> <DL> <DD>Gets the ordering mode defined in the static context. <P> <DD><DL> <DT><B>Returns:</B><DD>ordering mode value. One of: <code>XQConstants.ORDERING_MODE_ORDERED</code>, <code>XQConstants.ORDERING_MODE_UNORDERED</code>.</DL> </DD> </DL> <HR> <A NAME="setOrderingMode(int)"><!-- --></A><H3> setOrderingMode</H3> <PRE> void <B>setOrderingMode</B>(int mode) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the ordering mode in the static context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mode</CODE> - ordering mode value. One of: <code>XQConstants.ORDERING_MODE_ORDERED</code>, <code>XQConstants.ORDERING_MODE_UNORDERED</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified mode is different from <code>XQConstants.ORDERING_MODE_ORDERED</code>, <code>XQConstants.ORDERING_MODE_UNORDERED</code></DL> </DD> </DL> <HR> <A NAME="getDefaultOrderForEmptySequences()"><!-- --></A><H3> getDefaultOrderForEmptySequences</H3> <PRE> int <B>getDefaultOrderForEmptySequences</B>()</PRE> <DL> <DD>Gets the default order for empty sequences defined in the static context. <P> <DD><DL> <DT><B>Returns:</B><DD>default order for empty sequences value. One of: <code>XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST</code>, <code>XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEAST</code>.</DL> </DD> </DL> <HR> <A NAME="setDefaultOrderForEmptySequences(int)"><!-- --></A><H3> setDefaultOrderForEmptySequences</H3> <PRE> void <B>setDefaultOrderForEmptySequences</B>(int order) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the default order for empty sequences in the static context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>order</CODE> - the default order for empty sequences. One of: <code>XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST</code>, <code>XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEAST</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified order for empty sequences is different from <code>XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_GREATEST</code>, <code>XQConstants.DEFAULT_ORDER_FOR_EMPTY_SEQUENCES_LEAST</code></DL> </DD> </DL> <HR> <A NAME="getBoundarySpacePolicy()"><!-- --></A><H3> getBoundarySpacePolicy</H3> <PRE> int <B>getBoundarySpacePolicy</B>()</PRE> <DL> <DD>Gets the boundary-space policy defined in the static context. <P> <DD><DL> <DT><B>Returns:</B><DD>the boundary-space policy value. One of: <code>XQConstants.BOUNDARY_SPACE_PRESERVE</code>, <code>XQConstants.BOUNDARY_SPACE_STRIP</code>.</DL> </DD> </DL> <HR> <A NAME="setBoundarySpacePolicy(int)"><!-- --></A><H3> setBoundarySpacePolicy</H3> <PRE> void <B>setBoundarySpacePolicy</B>(int policy) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the boundary-space policy in the static context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>policy</CODE> - boundary space policy. One of: <code>XQConstants.BOUNDARY_SPACE_PRESERVE</code>, <code>XQConstants.BOUNDARY_SPACE_STRIP</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified mode is different from <code>XQConstants.BOUNDARY_SPACE_PRESERVE</code>, <code>XQConstants.BOUNDARY_SPACE_STRIP</code></DL> </DD> </DL> <HR> <A NAME="getCopyNamespacesModePreserve()"><!-- --></A><H3> getCopyNamespacesModePreserve</H3> <PRE> int <B>getCopyNamespacesModePreserve</B>()</PRE> <DL> <DD>Gets the preserve part of the copy-namespaces mode defined in the static context. <P> <DD><DL> <DT><B>Returns:</B><DD>construction mode value. One of: <code>XQConstants.COPY_NAMESPACES_MODE_PRESERVE</code>, <code>XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVE</code>.</DL> </DD> </DL> <HR> <A NAME="setCopyNamespacesModePreserve(int)"><!-- --></A><H3> setCopyNamespacesModePreserve</H3> <PRE> void <B>setCopyNamespacesModePreserve</B>(int mode) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the preserve part of the copy-namespaces mode in the static context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mode</CODE> - ordering mode value. One of: <code>XQConstants.COPY_NAMESPACES_MODE_PRESERVE</code>, <code>XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVE</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified mode is different from <code>XQConstants.COPY_NAMESPACES_MODE_PRESERVE</code>, <code>XQConstants.COPY_NAMESPACES_MODE_NO_PRESERVE</code></DL> </DD> </DL> <HR> <A NAME="getCopyNamespacesModeInherit()"><!-- --></A><H3> getCopyNamespacesModeInherit</H3> <PRE> int <B>getCopyNamespacesModeInherit</B>()</PRE> <DL> <DD>Gets the inherit part of the copy-namespaces mode defined in the static context. <P> <DD><DL> <DT><B>Returns:</B><DD>construction mode value. One of: <code>XQConstants.COPY_NAMESPACES_MODE_INHERIT</code>, <code>XQConstants.COPY_NAMESPACES_MODE_NO_INHERIT</code>.</DL> </DD> </DL> <HR> <A NAME="setCopyNamespacesModeInherit(int)"><!-- --></A><H3> setCopyNamespacesModeInherit</H3> <PRE> void <B>setCopyNamespacesModeInherit</B>(int mode) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the inherit part of the copy-namespaces mode in the static context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mode</CODE> - ordering mode value. One of: <code>XQConstants.COPY_NAMESPACES_MODE_INHERIT</code>, <code>XQConstants.COPY_NAMESPACES_MODE_NO_INHERIT</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified mode is different from <code>XQConstants.COPY_NAMESPACES_MODE_INHERIT</code>, <code>XQConstants.COPY_NAMESPACES_MODE_NO_INHERIT</code></DL> </DD> </DL> <HR> <A NAME="getBaseURI()"><!-- --></A><H3> getBaseURI</H3> <PRE> <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>getBaseURI</B>()</PRE> <DL> <DD>Gets the Base URI, if set in the static context, else the empty string. <P> <DD><DL> <DT><B>Returns:</B><DD>the base URI, if set, else the empty string. Cannot be <code>null</code>..</DL> </DD> </DL> <HR> <A NAME="setBaseURI(java.lang.String)"><!-- --></A><H3> setBaseURI</H3> <PRE> void <B>setBaseURI</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> baseUri) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the Base URI in the static context, specify the empty string to make it undefined. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>baseUri</CODE> - the new baseUri, or empty string to make it undefined. Cannot be <code>null</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if a <code>null</code> base uri is specified</DL> </DD> </DL> <HR> <A NAME="getBindingMode()"><!-- --></A><H3> getBindingMode</H3> <PRE> int <B>getBindingMode</B>()</PRE> <DL> <DD>Gets the value of the binding mode property. By default an XQJ implementation operates in immediate binding mode. <P> <DD><DL> <DT><B>Returns:</B><DD>the binding mode. One of <code>XQConstants.BINDING_MODE_IMMEDIATE</code>, or<code>XQConstants.BINDING_MODE_DEFERRED</code>.</DL> </DD> </DL> <HR> <A NAME="setBindingMode(int)"><!-- --></A><H3> setBindingMode</H3> <PRE> void <B>setBindingMode</B>(int bindingMode) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the binding mode property. By default an XQJ implementation operates in immediate binding mode. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>bindingMode</CODE> - the binding mode. One of: <code>XQConstants.BINDING_MODE_IMMEDIATE</code>, or<code>XQConstants.BINDING_MODE_DEFERRED</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified mode is different from <code>XQConstants.BINDING_MODE_IMMEDIATE</code>, <code>XQConstants.BINDING_MODE_DEFERRED</code></DL> </DD> </DL> <HR> <A NAME="getHoldability()"><!-- --></A><H3> getHoldability</H3> <PRE> int <B>getHoldability</B>()</PRE> <DL> <DD>Gets the value of the holdability property. <P> <DD><DL> <DT><B>Returns:</B><DD>the type of a result's holdability. One of: <code>XQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT</code>, or <code>XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT</code>.</DL> </DD> </DL> <HR> <A NAME="setHoldability(int)"><!-- --></A><H3> setHoldability</H3> <PRE> void <B>setHoldability</B>(int holdability) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the holdability property. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>holdability</CODE> - the holdability of the result. One of: <code>XQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT</code>, or <code>XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified holdability is different from <code>XQConstants.HOLDTYPE_HOLD_CURSORS_OVER_COMMIT</code>, <code>XQConstants.HOLDTYPE_CLOSE_CURSORS_AT_COMMIT</code></DL> </DD> </DL> <HR> <A NAME="getQueryLanguageTypeAndVersion()"><!-- --></A><H3> getQueryLanguageTypeAndVersion</H3> <PRE> int <B>getQueryLanguageTypeAndVersion</B>()</PRE> <DL> <DD>Gets the value of the language type and version property. By default an XQJ implementation's default is <code>XQConstants.LANGTYPE_XQUERY</code>. <P> <DD><DL> <DT><B>Returns:</B><DD>the language type and version. One of: <code>XQConstants.LANGTYPE_XQUERY</code>, or <code>XQConstants.LANGTYPE_XQUERYX</code> or a negative value indicating a vendor specific query language type and version.</DL> </DD> </DL> <HR> <A NAME="setQueryLanguageTypeAndVersion(int)"><!-- --></A><H3> setQueryLanguageTypeAndVersion</H3> <PRE> void <B>setQueryLanguageTypeAndVersion</B>(int langType) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the input query language type and version. When this is set to a particular language type and version, then the query is assumed to be in that language and version. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>langType</CODE> - the query language type and version of the inputs. One of: <code>XQConstants.LANGTYPE_XQUERY</code> (default), or <code>XQConstants.LANGTYPE_XQUERYX</code>. A negative number indicates a vendor specific query language type and version. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified langtype is different from <code>XQConstants.LANGTYPE_XQUERY</code>, <code>XQConstants.LANGTYPE_XQUERYX</code> and is not negative</DL> </DD> </DL> <HR> <A NAME="getScrollability()"><!-- --></A><H3> getScrollability</H3> <PRE> int <B>getScrollability</B>()</PRE> <DL> <DD>Gets the value of the scrollability property. By default query results are forward only. <P> <DD><DL> <DT><B>Returns:</B><DD>the type of a result's scrollability. One of: <code>XQConstants.SCROLLTYPE_FORWARD_ONLY</code>, or <code>XQConstants.SCROLLTYPE_SCROLLABLE</code>.</DL> </DD> </DL> <HR> <A NAME="setScrollability(int)"><!-- --></A><H3> setScrollability</H3> <PRE> void <B>setScrollability</B>(int scrollability) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the scrollability of the result sequence. By default query results are forward only. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>scrollability</CODE> - the scrollability of the result. One of: <code>XQConstants.SCROLLTYPE_FORWARD_ONLY</code>, or <code>XQConstants.SCROLLTYPE_SCROLLABLE</code>. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - the specified crollability type is different from <code>XQConstants.SCROLLTYPE_FORWARD_ONLY</code>, <code>XQConstants.SCROLLTYPE_SCROLLABLE</code></DL> </DD> </DL> <HR> <A NAME="getQueryTimeout()"><!-- --></A><H3> getQueryTimeout</H3> <PRE> int <B>getQueryTimeout</B>()</PRE> <DL> <DD>Retrieves the number of seconds an implementation will wait for a query to execute. <P> <DD><DL> <DT><B>Returns:</B><DD>the query execution timeout value in seconds. A value of 0 indicates no limit.</DL> </DD> </DL> <HR> <A NAME="setQueryTimeout(int)"><!-- --></A><H3> setQueryTimeout</H3> <PRE> void <B>setQueryTimeout</B>(int seconds) throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE> <DL> <DD>Sets the number of seconds an implementation will wait for a query to execute. If the implementation does not support query timeout it can ignore the specified timeout value. It the limit is exceeded, the behavor of the query is the same as an execution of a cancel by another thread. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>seconds</CODE> - the query execution timeout value in seconds. A value of 0 indicates no limit <DT><B>Throws:</B> <DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the passed in value is negative</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="../../../javax/xml/xquery/XQStackTraceVariable.html" title="class in javax.xml.xquery"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?javax/xml/xquery/XQStaticContext.html" target="_top"><B>FRAMES</B></A> <A HREF="XQStaticContext.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <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>