Permalink
Browse files

updated api docs

  • Loading branch information...
1 parent 9cca54e commit ccd2fb0a91de240f90f1056fab2fa83ac282d15f @marcesher committed Aug 20, 2011
@@ -3,7 +3,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
All Classes
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -233,7 +233,7 @@ <H2>
<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="DBCollection.html#findAndModify()">findAndModify</A></B>([struct query], [struct fields], [any sort], [boolean remove='false'], [struct update], [boolean returnNew='true'], [boolean upsert='false'])</CODE>
+<TD><CODE><B><A HREF="DBCollection.html#findAndModify()">findAndModify</A></B>([struct query], [struct fields], [struct sort], [boolean remove='false'], [struct update], [boolean returnNew='true'], [boolean upsert='false'])</CODE>
<BR>
@@ -402,6 +402,15 @@ <H2>
</TD>
</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private&nbsp;any</CODE></FONT></TD>
+<TD><CODE><B><A HREF="DBCollection.html#toMongoOperation()">toMongoOperation</A></B>([any doc])</CODE>
+<BR>
+
+</TD>
+</TR>
+
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
@@ -687,7 +696,7 @@ <H2>
<a name="findAndModify()"><!-- --></a><h3>
findAndModify</h3>
- <code>public any <B>findAndModify</B>([struct query], [struct fields], [any sort], [boolean remove='false'], [struct update], [boolean returnNew='true'], [boolean upsert='false'])</code>
+ <code>public any <B>findAndModify</B>([struct query], [struct fields], [struct sort], [boolean remove='false'], [struct update], [boolean returnNew='true'], [boolean upsert='false'])</code>
<dl>
<dd>
@@ -1053,6 +1062,29 @@ <H2>
</dl>
+ </dd>
+ </dl>
+ <hr>
+
+ <a name="toMongoOperation()"><!-- --></a><h3>
+ toMongoOperation</h3>
+ <code>private any <B>toMongoOperation</B>([any doc])</code>
+
+ <dl>
+ <dd>
+
+ <p>
+ </p></dd>
+
+
+ <dl>
+ <dt><b>Parameters:</b></dt>
+
+ <dd><code>doc</code></dd>
+
+ </dl>
+
+
</dd>
</dl>
<hr>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -158,7 +158,7 @@ <H2>
<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="MongoUtil.html#createOrderedDBObject()">createOrderedDBObject</A></B>([any keyValues])</CODE>
+<TD><CODE><B><A HREF="MongoUtil.html#createOrderedDBObject()">createOrderedDBObject</A></B>([any keyValues], [any dbObject=''])</CODE>
<BR>
@@ -180,11 +180,22 @@ <H2>
<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="MongoUtil.html#getTyperClass()">getTyperClass</A></B>()</CODE>
+<TD><CODE><B><A HREF="MongoUtil.html#getDocumentTyperClass()">getDocumentTyperClass</A></B>()</CODE>
<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a passthrough typer for Railo b/c it knows that 1 is 1 and not "1"; returns the CFStrictTyper otherwise
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the typer class name to use for Document and Query objects
+</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="MongoUtil.html#getOperationTyperClass()">getOperationTyperClass</A></B>()</CODE>
+<BR>
+
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns a simple typer class that only concerns itself with 1, -1, and 0, which MongoDB uses for operation decision making such as sorting and field selection
</TD>
</TR>
@@ -252,6 +263,17 @@ <H2>
</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="MongoUtil.html#newOperationalDBObject()">newOperationalDBObject</A></B>()</CODE>
+<BR>
+
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new instance of the CFBasicDBObject for use in operational (i
+</TD>
+</TR>
+
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
@@ -274,6 +296,17 @@ <H2>
</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="MongoUtil.html#toMongoOperation()">toMongoOperation</A></B>([struct data])</CODE>
+<BR>
+
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts a ColdFusion structure to a CFBasicDBobject which ensures 1 and -1 remain ints
+</TD>
+</TR>
+
</TR>
</TABLE>
@@ -383,7 +416,7 @@ <H2>
<a name="createOrderedDBObject()"><!-- --></a><h3>
createOrderedDBObject</h3>
- <code>public any <B>createOrderedDBObject</B>([any keyValues])</code>
+ <code>public any <B>createOrderedDBObject</B>([any keyValues], [any dbObject=''])</code>
<dl>
<dd>
@@ -397,6 +430,8 @@ <H2>
<dd><code>keyValues</code></dd>
+ <dd><code>dbObject</code></dd>
+
</dl>
@@ -427,13 +462,29 @@ <H2>
</dl>
<hr>
- <a name="getTyperClass()"><!-- --></a><h3>
- getTyperClass</h3>
- <code>public any <B>getTyperClass</B>()</code>
+ <a name="getDocumentTyperClass()"><!-- --></a><h3>
+ getDocumentTyperClass</h3>
+ <code>public any <B>getDocumentTyperClass</B>()</code>
<dl>
<dd>
- Returns a passthrough typer for Railo b/c it knows that 1 is 1 and not "1"; returns the CFStrictTyper otherwise
+ returns the typer class name to use for Document and Query objects. For Adobe ColdFusion, we need the CFStrictTyper because Adobe CF will treat numbers and booleans as strings. For Railo, we can use the "NoTyper" because Railo treats numbers as numbers and booleans as booleans
+ <p>
+ </p></dd>
+
+
+
+ </dd>
+ </dl>
+ <hr>
+
+ <a name="getOperationTyperClass()"><!-- --></a><h3>
+ getOperationTyperClass</h3>
+ <code>public any <B>getOperationTyperClass</B>()</code>
+
+ <dl>
+ <dd>
+ returns a simple typer class that only concerns itself with 1, -1, and 0, which MongoDB uses for operation decision making such as sorting and field selection
<p>
</p></dd>
@@ -563,6 +614,22 @@ <H2>
</dl>
+ </dd>
+ </dl>
+ <hr>
+
+ <a name="newOperationalDBObject()"><!-- --></a><h3>
+ newOperationalDBObject</h3>
+ <code>public any <B>newOperationalDBObject</B>()</code>
+
+ <dl>
+ <dd>
+ Create a new instance of the CFBasicDBObject for use in operational (i.e. non-document-save) situations
+ <p>
+ </p></dd>
+
+
+
</dd>
</dl>
<hr>
@@ -613,6 +680,29 @@ <H2>
</dl>
<hr>
+ <a name="toMongoOperation()"><!-- --></a><h3>
+ toMongoOperation</h3>
+ <code>public any <B>toMongoOperation</B>([struct data])</code>
+
+ <dl>
+ <dd>
+ Converts a ColdFusion structure to a CFBasicDBobject which ensures 1 and -1 remain ints
+ <p>
+ </p></dd>
+
+
+ <dl>
+ <dt><b>Parameters:</b></dt>
+
+ <dd><code>data</code></dd>
+
+ </dl>
+
+
+ </dd>
+ </dl>
+ <hr>
+
<!-- ========= START OF NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -4,7 +4,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Callable
</TITLE>
@@ -3,7 +3,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
cfmongodb.core
</TITLE>
@@ -3,7 +3,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
cfmongodb.core
</TITLE>
View
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Generated Documentation (CFMongoDB)
</TITLE>
@@ -3,7 +3,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Overview
</TITLE>
@@ -3,7 +3,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by colddoc on {ts '2011-08-20 08:14:14'} -->
+<!-- Generated by colddoc on {ts '2011-08-20 11:37:54'} -->
<TITLE>
Overview
</TITLE>

0 comments on commit ccd2fb0

Please sign in to comment.