<!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>
XQPreparedExpression
</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="XQPreparedExpression";
}
}
</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/XQMetaData.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/xquery/XQQueryException.html" title="class in javax.xml.xquery"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/xquery/XQPreparedExpression.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQPreparedExpression.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 XQPreparedExpression</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../javax/xml/xquery/XQDynamicContext.html" title="interface in javax.xml.xquery">XQDynamicContext</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../net/sf/saxon/xqj/SaxonXQPreparedExpression.html" title="class in net.sf.saxon.xqj">SaxonXQPreparedExpression</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>XQPreparedExpression</B><DT>extends <A HREF="../../../javax/xml/xquery/XQDynamicContext.html" title="interface in javax.xml.xquery">XQDynamicContext</A></DL>
</PRE>
<P>
This interface describes an expression that can be prepared for multiple
subsequent executions. A prepared expression can be created from the
connection. <p>
The preparation of the expression does the static analysis of the expression
using the static context information. <p>
The dynamic context information, such as values for bind variables, can then
be set using the setter methods. When setting values for bind variables,
these variables should be present as external
variables in the prolog of the prepared expression.<p>
The static type information of the query can also be retrieved if the XQuery
implementation provides it using the <code>getStaticResultType</code>
method.<p>
When the expression is executed using the <code>executeQuery</code>
method, if the execution is successful, then
an <code>XQResultSequence</code> object is returned.
The <code>XQResultSequence</code> object is tied to
the <code>XQPreparedExpression</code> from which it was prepared and is
closed implicitly if that expression is either closed or if re-executed. <p>
The <code>XQPreparedExpression</code> object is dependent on
the <code>XQConnection</code> object from which it was created and is only
valid for the duration of that object.
Thus, if the <code>XQConnection</code> object is closed then
this <code>XQPreparedExpression</code> object will be implicitly closed
and it can no longer be used.<p>
An XQJ driver is not required to provide finalizer methods for
the connection and other objects. Hence it is strongly recommended that
users call close method explicitly to free any resources. It is also
recommended that they do so under a final block to ensure that the object
is closed even when there are exceptions.
Not closing this object implicitly or explicitly might result in serious memory
leaks.<p>
When the <code>XQPreparedExpression</code> is closed any
<code>XQResultSequence</code> object obtained from it
is also implicitly closed. <p>
Example -
<pre>
XQConnection conn = XQDataSource.getconnection();
XQPreparedExpression expr = conn.prepareExpression
("for $i in (1) return 'abc' ");
// get the sequence type out.. This would be something like xs:string *
XQSequenceType type = expr.getStaticResultType();
XQSequence result1 = expr.executeQuery();
// process the result..
result1.next();
System.out.println(" First result1 "+ result1.getAtomicValue());
XQResultSequence result2 = expr.executeQuery();
// result1 is implicitly closed
// recommended to close the result sequences explicitly.
// process the result..
while (result2.next())
System.out.println(" result is "+ result2.getAtomicValue());
result2.close();
expr.close(); // closing expression implicitly closes all result sequence or
// items obtained from this expression.
conn.close(); // closing connections will close expressions and results.
</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/XQPreparedExpression.html#cancel()">cancel</A></B>()</CODE>
<BR>
Attempts to cancel the execution if both the XQuery engine and XQJ
driver support aborting the execution of an <code>XQPreparedExpression</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="../../../javax/xml/xquery/XQPreparedExpression.html#close()">close</A></B>()</CODE>
<BR>
Closes the expression object and release all resources associated with
this prepared expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/xml/xquery/XQResultSequence.html" title="interface in javax.xml.xquery">XQResultSequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#executeQuery()">executeQuery</A></B>()</CODE>
<BR>
Executes the prepared query expression.</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/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#getAllExternalVariables()">getAllExternalVariables</A></B>()</CODE>
<BR>
Retrieves all the external variables defined in the prolog of the
prepared expression.</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/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#getAllUnboundExternalVariables()">getAllUnboundExternalVariables</A></B>()</CODE>
<BR>
Retrieves the names of all unbound external variables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/xml/xquery/XQStaticContext.html" title="interface in javax.xml.xquery">XQStaticContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#getStaticContext()">getStaticContext</A></B>()</CODE>
<BR>
Gets an <code>XQStaticContext</code> representing the values for all
expression properties.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/xml/xquery/XQSequenceType.html" title="interface in javax.xml.xquery">XQSequenceType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#getStaticResultType()">getStaticResultType</A></B>()</CODE>
<BR>
Gets the static type information of the result sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/xml/xquery/XQSequenceType.html" title="interface in javax.xml.xquery">XQSequenceType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#getStaticVariableType(javax.xml.namespace.QName)">getStaticVariableType</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A> name)</CODE>
<BR>
Retrieves the static type of a given external variable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQPreparedExpression.html#isClosed()">isClosed</A></B>()</CODE>
<BR>
Checks if the prepared expression in a closed state.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.xml.xquery.XQDynamicContext"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.xml.xquery.<A HREF="../../../javax/xml/xquery/XQDynamicContext.html" title="interface in javax.xml.xquery">XQDynamicContext</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindAtomicValue(javax.xml.namespace.QName, java.lang.String, javax.xml.xquery.XQItemType)">bindAtomicValue</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindBoolean(javax.xml.namespace.QName, boolean, javax.xml.xquery.XQItemType)">bindBoolean</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindByte(javax.xml.namespace.QName, byte, javax.xml.xquery.XQItemType)">bindByte</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindDocument(javax.xml.namespace.QName, java.io.InputStream, java.lang.String, javax.xml.xquery.XQItemType)">bindDocument</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindDocument(javax.xml.namespace.QName, java.io.Reader, java.lang.String, javax.xml.xquery.XQItemType)">bindDocument</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindDocument(javax.xml.namespace.QName, javax.xml.transform.Source, javax.xml.xquery.XQItemType)">bindDocument</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindDocument(javax.xml.namespace.QName, java.lang.String, java.lang.String, javax.xml.xquery.XQItemType)">bindDocument</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindDocument(javax.xml.namespace.QName, javax.xml.stream.XMLStreamReader, javax.xml.xquery.XQItemType)">bindDocument</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindDouble(javax.xml.namespace.QName, double, javax.xml.xquery.XQItemType)">bindDouble</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindFloat(javax.xml.namespace.QName, float, javax.xml.xquery.XQItemType)">bindFloat</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindInt(javax.xml.namespace.QName, int, javax.xml.xquery.XQItemType)">bindInt</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindItem(javax.xml.namespace.QName, javax.xml.xquery.XQItem)">bindItem</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindLong(javax.xml.namespace.QName, long, javax.xml.xquery.XQItemType)">bindLong</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindNode(javax.xml.namespace.QName, org.w3c.dom.Node, javax.xml.xquery.XQItemType)">bindNode</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindObject(javax.xml.namespace.QName, java.lang.Object, javax.xml.xquery.XQItemType)">bindObject</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindSequence(javax.xml.namespace.QName, javax.xml.xquery.XQSequence)">bindSequence</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindShort(javax.xml.namespace.QName, short, javax.xml.xquery.XQItemType)">bindShort</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#bindString(javax.xml.namespace.QName, java.lang.String, javax.xml.xquery.XQItemType)">bindString</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#getImplicitTimeZone()">getImplicitTimeZone</A>, <A HREF="../../../javax/xml/xquery/XQDynamicContext.html#setImplicitTimeZone(java.util.TimeZone)">setImplicitTimeZone</A></CODE></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="cancel()"><!-- --></A><H3>
cancel</H3>
<PRE>
void <B>cancel</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Attempts to cancel the execution if both the XQuery engine and XQJ
driver support aborting the execution of an <code>XQPreparedExpression</code>.
This method can be used by one thread to cancel an <code>XQPreparedExpression</code>,
that is being executed in another thread. If cancellation is not supported or
the attempt to cancel the execution was not successful, the method returns without
any error. If the cancellation is successful, an <code>XQException</code>
is thrown, to indicate that it has been aborted, by <code>executeQuery</code>,
<code>executeCommand</code> or any method accessing the <code>XQResultSequence</code>
returned by <code>executeQuery</code>. If applicable, any open <code>XQResultSequence</code>
and <code>XQResultItem</code> objects will also be implicitly closed in this case.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the prepared expression is in a closed state</DL>
</DD>
</DL>
<HR>
<A NAME="isClosed()"><!-- --></A><H3>
isClosed</H3>
<PRE>
boolean <B>isClosed</B>()</PRE>
<DL>
<DD>Checks if the prepared expression in a closed state.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the prepared expression is in
a closed state, <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
void <B>close</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Closes the expression object and release all resources associated with
this prepared expression. This also closes any result sequences obtained
from this expression.
Once the expression is closed, all methods on this object other than the
<code>close</code> or <code>isClosed</code> will raise exceptions.
Calling close on an <code>XQExpression</code> object that is already closed has no
effect.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if there are errors when closing the expression</DL>
</DD>
</DL>
<HR>
<A NAME="executeQuery()"><!-- --></A><H3>
executeQuery</H3>
<PRE>
<A HREF="../../../javax/xml/xquery/XQResultSequence.html" title="interface in javax.xml.xquery">XQResultSequence</A> <B>executeQuery</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Executes the prepared query expression.
Calling this method implicitly closes any previous result sequence
obtained from this expression.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the xquery sequence object containing the result of the
query execution
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if (1) there are errors when executing the prepared
expression, (2) the prepared expression is in a closed state,
or (3) the query execution is cancelled</DL>
</DD>
</DL>
<HR>
<A NAME="getAllExternalVariables()"><!-- --></A><H3>
getAllExternalVariables</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A>[] <B>getAllExternalVariables</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Retrieves all the external variables defined in the prolog of the
prepared expression.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an array of <code>QName</code> objects for all the external
variables defined in the prolog of a prepared expression.
Empty array if there are no external variables present.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the prepared expression is in a closed state</DL>
</DD>
</DL>
<HR>
<A NAME="getAllUnboundExternalVariables()"><!-- --></A><H3>
getAllUnboundExternalVariables</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A>[] <B>getAllUnboundExternalVariables</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Retrieves the names of all unbound external variables.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the <code>QName</code> for all the external variables defined
in the prolog of a prepared expression that are yet to be bound
with a value. If there are no such variables an empty array
is returned
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the prepared expression is in a closed state</DL>
</DD>
</DL>
<HR>
<A NAME="getStaticResultType()"><!-- --></A><H3>
getStaticResultType</H3>
<PRE>
<A HREF="../../../javax/xml/xquery/XQSequenceType.html" title="interface in javax.xml.xquery">XQSequenceType</A> <B>getStaticResultType</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the static type information of the result sequence. If an
implementation does not do static typing of the query, then
this method must return an <code>XQSequenceType</code> object
corresponding to the XQuery sequence type <code>item()*</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>XQSequenceType</code> containing the static
result information.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the prepared expression is in a closed state</DL>
</DD>
</DL>
<HR>
<A NAME="getStaticVariableType(javax.xml.namespace.QName)"><!-- --></A><H3>
getStaticVariableType</H3>
<PRE>
<A HREF="../../../javax/xml/xquery/XQSequenceType.html" title="interface in javax.xml.xquery">XQSequenceType</A> <B>getStaticVariableType</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</A> name)
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Retrieves the static type of a given external variable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the external variable
<DT><B>Returns:</B><DD>the static type information of the variable as defined
in the prolog of the prepared expression
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if (1) the variable does not exist in the static
context of the expression, or (2) the sequence is
in a closed state, or (3) the <code>name</code>
parameter is <code>null</code></DL>
</DD>
</DL>
<HR>
<A NAME="getStaticContext()"><!-- --></A><H3>
getStaticContext</H3>
<PRE>
<A HREF="../../../javax/xml/xquery/XQStaticContext.html" title="interface in javax.xml.xquery">XQStaticContext</A> <B>getStaticContext</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets an <code>XQStaticContext</code> representing the values for all
expression properties. Note that these properties cannot be changed; in
order to change, a new <code>XQPreparedExpression</code> needs to be created.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an <code>XQStaticContext</code> representing
the values for all expression properties
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the expression is in a closed state</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/XQMetaData.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/xquery/XQQueryException.html" title="class in javax.xml.xquery"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/xquery/XQPreparedExpression.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQPreparedExpression.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>
