<!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>
XQResultSequence
</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="XQResultSequence";
}
}
</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/XQResultItem.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/xquery/XQSequence.html" title="interface 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/XQResultSequence.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQResultSequence.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 XQResultSequence</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../javax/xml/xquery/XQItemAccessor.html" title="interface in javax.xml.xquery">XQItemAccessor</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html" title="interface in javax.xml.xquery">XQSequence</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../net/sf/saxon/xqj/SaxonXQForwardSequence.html" title="class in net.sf.saxon.xqj">SaxonXQForwardSequence</A>, <A HREF="../../../net/sf/saxon/xqj/SaxonXQSequence.html" title="class in net.sf.saxon.xqj">SaxonXQSequence</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>XQResultSequence</B><DT>extends <A HREF="../../../javax/xml/xquery/XQSequence.html" title="interface in javax.xml.xquery">XQSequence</A></DL>
</PRE>
<P>
This interface represents a sequence of items obtained as a result of
evaluation XQuery expressions. The result sequence is tied to the
<code>XQconnection</code> object on which the expression was evaluated.<p>
This sequence can be obtained by performing an <code>executeQuery</code>
on the expression object. It represents a cursor-like interface.<p>
The <code>XQResultSequence</code> object is dependent on
the connection and the expression from which it was created and is only
valid for the duration of those objects. Thus, if any one of those objects is closed,
this <code>XQResultSequence</code> object will be implicitly closed
and it can no longer be used. Similarly re-executing the expression
also implicitly closes the associated result sequences. <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>XQResultSequence</code> is closed any
<code>XQResultItem</code> objects obtained from it
are also implicitly closed.<p>
Example -
<pre>
XQPreparedExpression expr = conn.prepareExpression("for $i ..");
XQResultSequence result = expr.executeQuery();
// create the ItemTypes for string and integer
XQItemType strType = conn.createAtomicType(XQItemType.XQBASETYPE_STRING);
XQItemType intType = conn.createAtomicType(XQItemType.XQBASETYPE_INT);
// posititioned before the first item
while (result.next())
{
XQItemType type = result.getItemType();
// If string, then get the string value out
if (type.equals(strType))
String str = result.getAtomicValue();
else if (type.equals(intType)) // if it is an integer..
int intval = result.getInt();
...
}
result.close(); // explicitly close the result sequence
</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> <A HREF="../../../javax/xml/xquery/XQConnection.html" title="interface in javax.xml.xquery">XQConnection</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQResultSequence.html#getConnection()">getConnection</A></B>()</CODE>
<BR>
Gets the XQuery connection associated with this result sequence</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.xml.xquery.XQSequence"><!-- --></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/XQSequence.html" title="interface in javax.xml.xquery">XQSequence</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../javax/xml/xquery/XQSequence.html#absolute(int)">absolute</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#afterLast()">afterLast</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#beforeFirst()">beforeFirst</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#close()">close</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#count()">count</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#first()">first</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#getItem()">getItem</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#getPosition()">getPosition</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#getSequenceAsStream()">getSequenceAsStream</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#getSequenceAsString(java.util.Properties)">getSequenceAsString</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isAfterLast()">isAfterLast</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isBeforeFirst()">isBeforeFirst</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isClosed()">isClosed</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isFirst()">isFirst</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isLast()">isLast</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isOnItem()">isOnItem</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#isScrollable()">isScrollable</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#last()">last</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#next()">next</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#previous()">previous</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#relative(int)">relative</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#writeSequence(java.io.OutputStream, java.util.Properties)">writeSequence</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#writeSequence(java.io.Writer, java.util.Properties)">writeSequence</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#writeSequenceToResult(javax.xml.transform.Result)">writeSequenceToResult</A>, <A HREF="../../../javax/xml/xquery/XQSequence.html#writeSequenceToSAX(org.xml.sax.ContentHandler)">writeSequenceToSAX</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.xml.xquery.XQItemAccessor"><!-- --></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/XQItemAccessor.html" title="interface in javax.xml.xquery">XQItemAccessor</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getAtomicValue()">getAtomicValue</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getBoolean()">getBoolean</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getByte()">getByte</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getDouble()">getDouble</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getFloat()">getFloat</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getInt()">getInt</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getItemAsStream()">getItemAsStream</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getItemAsString(java.util.Properties)">getItemAsString</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getItemType()">getItemType</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getLong()">getLong</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getNode()">getNode</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getNodeUri()">getNodeUri</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getObject()">getObject</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#getShort()">getShort</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#instanceOf(javax.xml.xquery.XQItemType)">instanceOf</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#writeItem(java.io.OutputStream, java.util.Properties)">writeItem</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#writeItem(java.io.Writer, java.util.Properties)">writeItem</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#writeItemToResult(javax.xml.transform.Result)">writeItemToResult</A>, <A HREF="../../../javax/xml/xquery/XQItemAccessor.html#writeItemToSAX(org.xml.sax.ContentHandler)">writeItemToSAX</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="getConnection()"><!-- --></A><H3>
getConnection</H3>
<PRE>
<A HREF="../../../javax/xml/xquery/XQConnection.html" title="interface in javax.xml.xquery">XQConnection</A> <B>getConnection</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the XQuery connection associated with this result sequence
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the connection associated with this result sequence
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the result sequence 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/XQResultItem.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/xquery/XQSequence.html" title="interface 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/XQResultSequence.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQResultSequence.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>
