| 1 | <!DOCTYPE html> <html> <head> <title>Cursor.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="ByteIterable.html"> ByteIterable.coffee </a> <a class="source" href="ByteIterator.html"> ByteIterator.coffee </a> <a class="source" href="ArrayByteIterable.html"> ArrayByteIterable.coffee </a> <a class="source" href="ByteIterableBase.html"> ByteIterableBase.coffee </a> <a class="source" href="ByteIterableUtil.html"> ByteIterableUtil.coffee </a> <a class="source" href="LightOutputStream.html"> LightOutputStream.coffee </a> <a class="source" href="StoreConfiguration.html"> StoreConfiguration.coffee </a> <a class="source" href="Reader.html"> Reader.coffee </a> <a class="source" href="Writer.html"> Writer.coffee </a> <a class="source" href="List.html"> List.coffee </a> <a class="source" href="ListNode.html"> ListNode.coffee </a> <a class="source" href="Cursor.html"> Cursor.coffee </a> <a class="source" href="DatabaseRoot.html"> DatabaseRoot.coffee </a> <a class="source" href="Environment.html"> Environment.coffee </a> <a class="source" href="EnvironmentConfig.html"> EnvironmentConfig.coffee </a> <a class="source" href="Store.html"> Store.coffee </a> <a class="source" href="Transaction.html"> Transaction.coffee </a> <a class="source" href="Addr64.html"> Addr64.coffee </a> <a class="source" href="DataIterator.html"> DataIterator.coffee </a> <a class="source" href="Log.html"> Log.coffee </a> <a class="source" href="LogCache.html"> LogCache.coffee </a> <a class="source" href="LogConfig.html"> LogConfig.coffee </a> <a class="source" href="LogUtil.html"> LogUtil.coffee </a> <a class="source" href="Loggable.html"> Loggable.coffee </a> <a class="source" href="LoggableFactory.html"> LoggableFactory.coffee </a> <a class="source" href="LoggableIterator.html"> LoggableIterator.coffee </a> <a class="source" href="LoggableToWrite.html"> LoggableToWrite.coffee </a> <a class="source" href="NullLoggable.html"> NullLoggable.coffee </a> <a class="source" href="RandomAccessByteIterable.html"> RandomAccessByteIterable.coffee </a> <a class="source" href="RandomAccessLoggable.html"> RandomAccessLoggable.coffee </a> <a class="source" href="RandomAccessLoggableIterator.html"> RandomAccessLoggableIterator.coffee </a> <a class="source" href="StackList.html"> StackList.coffee </a> <a class="source" href="CompoundByteIterable.html"> CompoundByteIterable.coffee </a> <a class="source" href="CompoundByteIteratorBase.html"> CompoundByteIteratorBase.coffee </a> <a class="source" href="CompressedUnsignedLongByteIterable.html"> CompressedUnsignedLongByteIterable.coffee </a> <a class="source" href="FixedLengthByteIterable.html"> FixedLengthByteIterable.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> Cursor.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">EventEmitter = </span><span class="p">(</span><span class="nx">require</span> <span class="s1">'events'</span><span class="p">).</span><span class="nx">EventEmitter</span>
|
| 2 | <span class="nv">ListNode = </span><span class="p">(</span><span class="nx">require</span> <span class="s1">'../list/ListNode.coffee'</span><span class="p">).</span><span class="nx">ListNode</span>
|
| 3 | <span class="nv">ExodusError = </span><span class="p">(</span><span class="nx">require</span> <span class="s1">'../errors/ExodusError.coffee'</span><span class="p">).</span><span class="nx">ExodusError</span>
|
| 4 |
|
| 5 | <span class="k">class</span> <span class="nx">Cursor</span> <span class="k">extends</span> <span class="nx">EventEmitter</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">store: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">txn: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">node: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">begin: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">end: </span><span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <p>@private</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">isClosed: </span><span class="kc">undefined</span>
|
| 6 |
|
| 7 | <span class="nx">@create$Store</span><span class="nv">$TransactionDescriptor: </span><span class="nf">(store, txn, o) -></span>
|
| 8 | <span class="k">if</span> <span class="o">!</span><span class="nx">o</span><span class="o">?</span> <span class="k">then</span> <span class="nv">o = </span><span class="k">new</span> <span class="nx">Cursor</span><span class="p">()</span>
|
| 9 | <span class="nv">o.store = </span><span class="nx">store</span>
|
| 10 | <span class="nv">o.txn = </span><span class="nx">txn</span>
|
| 11 | <span class="nv">o.node = </span><span class="nx">ListNode</span><span class="p">.</span><span class="nx">create$Log</span> <span class="nx">store</span><span class="p">.</span><span class="nx">getList</span><span class="p">().</span><span class="nx">log</span>
|
| 12 | <span class="nv">o.node.next = </span><span class="nx">store</span><span class="p">.</span><span class="nx">getList</span><span class="p">().</span><span class="nx">rootNode</span><span class="p">.</span><span class="nx">next</span>
|
| 13 | <span class="nv">o.node.nextAddr = </span><span class="nx">store</span><span class="p">.</span><span class="nx">getList</span><span class="p">().</span><span class="nx">rootNode</span><span class="p">.</span><span class="nx">nextAddr</span>
|
| 14 | <span class="nv">o.begin = </span><span class="kc">true</span>
|
| 15 | <span class="nv">o.end = </span><span class="kc">false</span>
|
| 16 | <span class="nv">o.isClosed = </span><span class="kc">false</span>
|
| 17 | <span class="k">return</span> <span class="nx">o</span></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <p>Move to next record.</p>
|
| 18 |
|
| 19 | <p>@return boolean</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">getNext</span><span class="nv">$emit: </span><span class="nf">() -></span>
|
| 20 | <span class="nv">oldnode = </span><span class="nx">@node</span>
|
| 21 | <span class="vi">@node = </span><span class="nx">@node</span><span class="p">.</span><span class="nx">next</span>
|
| 22 | <span class="k">if</span> <span class="nx">@node</span><span class="o">?</span>
|
| 23 | <span class="nx">@node</span><span class="p">.</span><span class="nx">once</span> <span class="s1">'getNode'</span><span class="p">,</span> <span class="p">(</span><span class="nx">ok</span><span class="p">,</span> <span class="nx">newnode</span><span class="p">)</span> <span class="o">=></span>
|
| 24 | <span class="k">if</span> <span class="nx">ok</span><span class="o">?</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">newnode</span><span class="p">.</span><span class="nx">isEmpty</span><span class="p">()</span>
|
| 25 | <span class="vi">@begin = </span><span class="kc">false</span>
|
| 26 | <span class="vi">@node = </span><span class="nx">newnode</span>
|
| 27 | <span class="vi">@node.prev = </span><span class="nx">oldnode</span>
|
| 28 | <span class="nx">@emit</span> <span class="s1">'getNext'</span><span class="p">,</span> <span class="kc">true</span>
|
| 29 | <span class="k">else</span>
|
| 30 | <span class="vi">@end = </span><span class="kc">true</span>
|
| 31 | <span class="vi">@node = </span><span class="nx">oldnode</span>
|
| 32 | <span class="nx">@emit</span> <span class="s1">'getNext'</span><span class="p">,</span> <span class="kc">false</span>
|
| 33 | <span class="nx">@node</span><span class="p">.</span><span class="nx">getNode</span><span class="p">()</span>
|
| 34 | <span class="k">else</span>
|
| 35 | <span class="vi">@end = </span><span class="kc">true</span>
|
| 36 | <span class="nx">@emit</span> <span class="s1">'getNext'</span><span class="p">,</span> <span class="nx">@node</span><span class="o">?</span></pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <p>Move to next record.</p>
|
| 37 |
|
| 38 | <p>@return boolean
|
| 39 | TODO getNextDup: () -></p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <p>TODO getNextNoDup: () -></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">getLast</span><span class="nv">$emit: </span><span class="nf">() -></span>
|
| 40 | <span class="vi">@begin = </span><span class="kc">false</span>
|
| 41 | <span class="vi">@end = </span><span class="kc">true</span>
|
| 42 | <span class="k">if</span> <span class="nx">@node</span><span class="p">.</span><span class="nx">next</span><span class="o">?</span>
|
| 43 | <span class="nx">@once</span> <span class="s1">'getNext'</span><span class="p">,</span> <span class="p">(</span><span class="nx">success</span><span class="p">)</span> <span class="o">=></span>
|
| 44 | <span class="k">if</span> <span class="nx">success</span>
|
| 45 | <span class="nx">@getLast$emit</span><span class="p">()</span>
|
| 46 | <span class="k">else</span>
|
| 47 | <span class="nx">@emit</span> <span class="s1">'getLast'</span><span class="p">,</span> <span class="kc">true</span>
|
| 48 | <span class="nx">@getNext$emit</span><span class="p">()</span>
|
| 49 | <span class="k">else</span>
|
| 50 | <span class="nx">@emit</span> <span class="s1">'getLast'</span><span class="p">,</span> <span class="kc">true</span></pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> <p>Move to previous record.</p>
|
| 51 |
|
| 52 | <p>@return</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">getPrev: </span><span class="nf">() -></span>
|
| 53 | <span class="k">if</span> <span class="nx">@node</span><span class="p">.</span><span class="nx">prev</span><span class="o">?</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">@node</span><span class="p">.</span><span class="nx">prev</span><span class="p">.</span><span class="nx">keyAddr</span><span class="p">.</span><span class="nx">equals$Addr64</span> <span class="nx">@node</span><span class="p">.</span><span class="nx">nullAddr</span>
|
| 54 | <span class="vi">@node = </span><span class="nx">@node</span><span class="p">.</span><span class="nx">prev</span>
|
| 55 | <span class="vi">@end = </span><span class="kc">false</span>
|
| 56 | <span class="k">return</span> <span class="kc">true</span>
|
| 57 | <span class="k">else</span>
|
| 58 | <span class="vi">@begin = </span><span class="kc">true</span>
|
| 59 | <span class="k">return</span> <span class="kc">false</span></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> <p>Move to previous record.</p>
|
| 60 |
|
| 61 | <p>@return
|
| 62 | TODO getPrevDup: () -></p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> <p>TODO getPrevNoDup: () -></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">getKey: </span><span class="nf">() -></span>
|
| 63 | <span class="k">return</span> <span class="nx">@node</span><span class="p">.</span><span class="nx">key</span>
|
| 64 |
|
| 65 | <span class="nv">getValue: </span><span class="nf">() -></span>
|
| 66 | <span class="k">return</span> <span class="nx">@node</span><span class="p">.</span><span class="nx">value</span></pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> <p>ByteIterable Nullable
|
| 67 | TODO getSearchKey$ByteIterable: (key) -></p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> <p>ByteIterable Nullable
|
| 68 | TODO getSearchKeyRange$ByteIterable: (key) -></p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> <p>boolean
|
| 69 | TODO getSearchBoth$ByteIterable$ByteIterable: (key, value) -></p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> <p>ByteIterable Nullable
|
| 70 | TODO getSearchBothRange$ByteIterable$ByteIterable: (key, value) -></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">count: </span><span class="nf">() -></span>
|
| 71 | <span class="k">return</span> <span class="nx">@store</span><span class="p">.</span><span class="nx">count</span><span class="p">()</span>
|
| 72 |
|
| 73 | <span class="nv">close: </span><span class="nf">() -></span>
|
| 74 | <span class="k">if</span> <span class="nx">@isClosed</span>
|
| 75 | <span class="k">throw</span> <span class="k">new</span> <span class="nx">ExodusError</span> <span class="s2">"Cursor is already closed"</span>
|
| 76 | <span class="vi">@isClosed = </span><span class="kc">true</span>
|
| 77 |
|
| 78 | <span class="nv">deleteCurrent: </span><span class="nf">() -></span>
|
| 79 | <span class="k">if</span> <span class="nx">@begin</span>
|
| 80 | <span class="k">return</span> <span class="kc">false</span>
|
| 81 | <span class="k">else</span>
|
| 82 | <span class="vi">@node = </span><span class="nx">@store</span><span class="p">.</span><span class="nx">getList</span><span class="p">().</span><span class="nx">deleteNode$ListNode</span> <span class="nx">@node</span>
|
| 83 | <span class="k">return</span> <span class="kc">true</span>
|
| 84 |
|
| 85 | <span class="nv">exports.Cursor = </span><span class="nx">Cursor</span>
|
| 86 |
|
| 87 | </pre></div> </td> </tr> </tbody> </table> </div> </body> </html> |
| \ | No newline at end of file |