root/GearsORM/trunk/docs/files/GearsORM-ResultIterator-js.html

Revision 414, 12.8 kB (checked in by uriel, 8 months ago)

*updated docs
*changed version to 0.2.1
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2
3<html><head><title>GearsORM.ResultIterator.js</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!--
4if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
5
6<!--  Generated by Natural Docs, version 1.35 -->
7<!--  http://www.naturaldocs.org  -->
8
9<!-- saved from url=(0026)http://www.naturaldocs.org -->
10
11<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MEntry><div class=MFile><a href="GearsORM-Events-js.html">Events.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Fields-js.html">Fields.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Introspection-js.html">Introspection.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-js.html">js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Model-js.html">Model.js</a></div></div><div class=MEntry><div class=MFile id=MSelected>ResultIterator.js</div></div><div class=MEntry><div class=MFile><a href="GearsORM-Sql-js.html">Sql.js</a></div></div><div class=MEntry><div class=MFile><a href="GearsORM-Transaction-js.html">Transaction.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Properties.html">Properties</a></div></div></div></div></div><!--END_ND_MENU--></td>
12
13<td class=ContentSection valign=top><div class=CFile id=MainTopic><div class=CTopic><h1 class=CTitle><a name="GearsORM.ResultIterator.js"></a>GearsORM.<span class=HB> </span>ResultIterator.js</h1><div class=CBody><p class=CParagraph>Contains the ResultIterator class.</p><h4 class=CHeading>License</h4><p class=CParagraph>MIT-style license.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#GearsORM.ResultIterator.js" >GearsORM.<span class=HB> </span>ResultIterator.js</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Contains the ResultIterator class.</div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#GearsORM.ResultIterator" >GearsORM.<span class=HB> </span>ResultIterator</a></div></div></td><td><div class=SClass><div class=SDescription>a iterator on a Google Gears ResultSet</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#GearsORM.ResultIterator.Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.ResultIterator.next" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">next</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the next row in the ResultSet as a model instance,if it is the last row it will return false.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.ResultIterator.each" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">each</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>a function to iterate the ResultSet like ruby each.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.ResultIterator.close" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">close</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>close the ResultSet,this will be done automaticlly if the ResultSet is iterated to the end. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.ResultIterator.getOne" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">getOne</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the first row of the ResultSet,will return false if the ResultSet is empty.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#GearsORM.ResultIterator.toArray" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">toArray</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>return the ResultSet as Array of model instances</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
14
15<div class=CClass><div class=CTopic><h2 class=CTitle><a name="GearsORM.ResultIterator"></a>GearsORM.<span class=HB> </span>ResultIterator</h2><div class=CBody><p class=CParagraph>a iterator on a Google Gears ResultSet</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>result</td><td class=CDLDescription>the ResultSet to iterate</td></tr><tr><td class=CDLEntry>modelClass</td><td class=CDLDescription>the model class used to map the results</td></tr></table><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SGroup><div class=SEntry><a href="#GearsORM.ResultIterator.Functions" >Functions</a></div></div></td><td class=SDescriptionSize><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.ResultIterator.next" id=link6 onMouseOver="ShowTip(event, 'tt1', 'link6')" onMouseOut="HideTip('tt1')">next</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the next row in the ResultSet as a model instance,if it is the last row it will return false.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.ResultIterator.each" id=link7 onMouseOver="ShowTip(event, 'tt2', 'link7')" onMouseOut="HideTip('tt2')">each</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>a function to iterate the ResultSet like ruby each.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.ResultIterator.close" id=link8 onMouseOver="ShowTip(event, 'tt3', 'link8')" onMouseOut="HideTip('tt3')">close</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>close the ResultSet,this will be done automaticlly if the ResultSet is iterated to the end. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.ResultIterator.getOne" id=link9 onMouseOver="ShowTip(event, 'tt4', 'link9')" onMouseOut="HideTip('tt4')">getOne</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the first row of the ResultSet,will return false if the ResultSet is empty.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#GearsORM.ResultIterator.toArray" id=link10 onMouseOver="ShowTip(event, 'tt5', 'link10')" onMouseOut="HideTip('tt5')">toArray</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>return the ResultSet as Array of model instances</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16
17<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="GearsORM.ResultIterator.Functions"></a>Functions</h3></div></div>
18
19<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.ResultIterator.next"></a>next</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>next:function()</td></tr></table></blockquote><p class=CParagraph>return the next row in the ResultSet as a model instance,if it is the last row it will return false.</p></div></div></div>
20
21<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.ResultIterator.each"></a>each</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>each:function(</td><td class=PParameter nowrap>fn,</td></tr><tr><td></td><td class=PParameter nowrap>bind</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>a function to iterate the ResultSet like ruby each.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>fn</td><td class=CDLDescription>function to be called for each row in the ResultSet</td></tr><tr><td class=CDLEntry>bind</td><td class=CDLDescription>this will be used as this for the function,optional</td></tr></table></div></div></div>
22
23<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.ResultIterator.close"></a>close</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>close:function()</td></tr></table></blockquote><p class=CParagraph>close the ResultSet,this will be done automaticlly if the ResultSet is iterated to the end. if you don`t finish iterate the ResultSet this need to be called manually.</p></div></div></div>
24
25<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.ResultIterator.getOne"></a>getOne</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getOne:function()</td></tr></table></blockquote><p class=CParagraph>return the first row of the ResultSet,will return false if the ResultSet is empty.</p></div></div></div>
26
27<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="GearsORM.ResultIterator.toArray"></a>toArray</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toArray:function()</td></tr></table></blockquote><p class=CParagraph>return the ResultSet as Array of model instances</p></div></div></div>
28
29</td>
30
31</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div>
32<!--START_ND_TOOLTIPS-->
33<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>next:function()</td></tr></table></blockquote>return the next row in the ResultSet as a model instance,if it is the last row it will return false.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>each:function(</td><td class=PParameter nowrap>fn,</td></tr><tr><td></td><td class=PParameter nowrap>bind</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>a function to iterate the ResultSet like ruby each.</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>close:function()</td></tr></table></blockquote>close the ResultSet,this will be done automaticlly if the ResultSet is iterated to the end. </div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>getOne:function()</td></tr></table></blockquote>return the first row of the ResultSet,will return false if the ResultSet is empty.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>toArray:function()</td></tr></table></blockquote>return the ResultSet as Array of model instances</div></div><!--END_ND_TOOLTIPS-->
34
35<script language=JavaScript><!--
36if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
Note: See TracBrowser for help on using the browser.