Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
445 lines (297 sloc) 9.63 KB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
<META NAME="keywords" CONTENT="cfmongodb.core.concurrent.Callable interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="SearchResult";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF 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>&nbsp;</TD>
<TD BGCOLOR="##EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
CFMongoDB</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?cfmongodb/core/SearchResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
cfmongodb.core</FONT>
<BR>
Class SearchResult</H2>
<PRE>WEB-INF.cftags.component
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">cfmongodb.core.SearchResult
</PRE>
<HR>
<DL>
<DT>
<PRE>public class <B>SearchResult</B>
<DT>extends WEB-INF.cftags.component</DT></PRE>
</DT>
</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>
<CODE><B><A HREF="SearchResult.html#init()">init</A></B>([any mongoCursor], [any sort], [any mongoUtil])</CODE>
<BR>
</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#asArray()">asArray</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts all cursor elements into a ColdFusion structure and returns them as an array of structs
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#asCursor()">asCursor</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The fastest return type
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#explain()">explain</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mongo's native explain command
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#getQuery()">getQuery</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The criteria used for the query
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#getSort()">getSort</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The sort used for the query
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#size()">size</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of elements in the result, after limit and skip are applied
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="SearchResult.html#totalCount()">totalCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The total number of elements for the query, before limit and skip are applied
</TD>
</TR>
</TR>
</TABLE>
&nbsp;
<a name="methods_inherited_from_class_WEB-INF.cftags.component"><!-- --></a>
<table summary="" border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableSubHeadingColor" bgcolor="#eeeeff">
<th align="left"><b>Methods inherited from class WEB-INF.cftags.component</b></th>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td>
<code></code>
</td>
</tr>
</tbody></table>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<a name="constructor_detail"><!-- --></a>
</p><table summary="" border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<th colspan="1" align="left"><font size="+2">
<b>Constructor Detail</b></font></th>
</tr>
</tbody></table>
<a name="init()"><!-- --></a><h3>
init</h3>
<CODE>public <B>init</B>([any mongoCursor], [any sort], [any mongoUtil])</CODE>
<dl>
<dd>
<p>
</p>
<dl>
<dt><b>Parameters:</b></dt>
<dd><code>mongoCursor</code></dd>
<dd><code>sort</code></dd>
<dd><code>mongoUtil</code></dd>
</dl>
</dd></dl>
<!-- ============ METHOD DETAIL ========== -->
<a name="method_detail"><!-- --></a>
<table summary="" border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<th colspan="1" align="left"><font size="+2">
<b>Method Detail</b></font></th>
</tr>
</tbody></table>
<a name="asArray()"><!-- --></a><h3>
asArray</h3>
<code>public any <B>asArray</B>()</code>
<dl>
<dd>
Converts all cursor elements into a ColdFusion structure and returns them as an array of structs.
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="asCursor()"><!-- --></a><h3>
asCursor</h3>
<code>public any <B>asCursor</B>()</code>
<dl>
<dd>
The fastest return type... returns the case-sensitive cursor which you'd iterate over with while(cursor.hasNext()) {cursor.next();} Note: you can use the cursor object to get full access to the full API at http://api.mongodb.org/java
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="explain()"><!-- --></a><h3>
explain</h3>
<code>public any <B>explain</B>()</code>
<dl>
<dd>
Mongo's native explain command. Useful for debugging and performance analysis
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getQuery()"><!-- --></a><h3>
getQuery</h3>
<code>public any <B>getQuery</B>()</code>
<dl>
<dd>
The criteria used for the query. Use getQuery().toString() to get a copy/paste string for the Mongo shell
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getSort()"><!-- --></a><h3>
getSort</h3>
<code>public any <B>getSort</B>()</code>
<dl>
<dd>
The sort used for the query. use getSort().toString() to get a copy/paste string for the Mongo shell
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="size()"><!-- --></a><h3>
size</h3>
<code>public any <B>size</B>()</code>
<dl>
<dd>
The number of elements in the result, after limit and skip are applied
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="totalCount()"><!-- --></a><h3>
totalCount</h3>
<code>public any <B>totalCount</B>()</code>
<dl>
<dd>
The total number of elements for the query, before limit and skip are applied
<p>
</p></dd>
</dd>
</dl>
<hr>
<!-- ========= START OF 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>&nbsp;</TD>
<TD BGCOLOR="##EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
CFMongoDB</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?cfmongodb/core/SearchResult.html" target="_top"><B>FRAMES</B></A> &nbsp;
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF NAVBAR ========= -->
<HR>
</BODY>
</HTML>
Something went wrong with that request. Please try again.