<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Class: XmlStore</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">XmlStore</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/storage/xmlstore_rb.html"> lib/storage/xmlstore.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> <a href="Store.html"> Store </a> </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="diagram"> <map id="map" name="map"> <area shape="rect" coords="5,101,83,149" href="XmlStore.html" alt="XmlStore " /> <area shape="rect" coords="8,5,80,53" href="Store.html" alt="Store " /> </map> <img src="../dot/f_52.png" usemap="#map" border="0" alt="dot/f_52.png"> </div> <div id="description"> <p> The <a href="XmlStore.html">XmlStore</a> class manages access to all object storage. </p> <dl> <dt><tt>db</tt></dt><dd>is a handle to the database implementation (in this iteration a hash). </dd> <dt><tt>dbtop</tt></dt><dd>stores the highest id used in the database. </dd> </dl> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000072">check</a> <a href="#M000070">delete</a> <a href="#M000073">each</a> <a href="#M000071">get</a> <a href="#M000067">new</a> <a href="#M000069">put</a> <a href="#M000068">save</a> </div> </div> </div> <!-- if includes --> <div id="section"> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000067" class="method-detail"> <a name="M000067"></a> <div class="method-heading"> <a href="#M000067" class="method-signature"> <span class="method-name">new</span><span class="method-args">(dbfile)</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000067-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000067-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 28</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">dbfile</span>) <span class="ruby-keyword kw">super</span>() <span class="ruby-ivar">@dbfile</span> = <span class="ruby-node">"#{dbfile}.xml"</span> <span class="ruby-comment cmt"># check if database exists and build it if not</span> <span class="ruby-identifier">build_database</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Loading world..."</span> <span class="ruby-ivar">@db</span> = {} <span class="ruby-comment cmt"># load the yaml database and sets @dbtop to highest object id</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@dbfile</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-constant">XMLRPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">f</span>.<span class="ruby-identifier">read</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@dbtop</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@dbtop</span> <span class="ruby-ivar">@db</span>[<span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span>]=<span class="ruby-identifier">o</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"Database '#{@dbfile}' loaded...highest id = #{@dbtop}."</span> <span class="ruby-comment cmt"># log.debug @db.inspect</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-value str">"Error loading database"</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">$!</span> <span class="ruby-identifier">raise</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000072" class="method-detail"> <a name="M000072"></a> <div class="method-heading"> <a href="#M000072" class="method-signature"> <span class="method-name">check</span><span class="method-args">(oid)</span> </a> </div> <div class="method-description"> <p> Check if an object is in the database by its id. </p> <dl> <dt><tt>oid</tt></dt><dd>is the id to use in the search. </dd> <dt><tt>return</tt></dt><dd>true or false </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000072-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000072-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 86</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check</span>(<span class="ruby-identifier">oid</span>) <span class="ruby-ivar">@db</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">oid</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000070" class="method-detail"> <a name="M000070"></a> <div class="method-heading"> <a href="#M000070" class="method-signature"> <span class="method-name">delete</span><span class="method-args">(oid)</span> </a> </div> <div class="method-description"> <p> Deletes an object from the database. </p> <dl> <dt><tt>oid</tt></dt><dd>is the id to to be deleted. </dd> <dt><tt>return</tt></dt><dd>Undefined. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000070-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000070-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 72</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>) <span class="ruby-ivar">@db</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000073" class="method-detail"> <a name="M000073"></a> <div class="method-heading"> <a href="#M000073" class="method-signature"> <span class="method-name">each</span><span class="method-args">(&blk)</span> </a> </div> <div class="method-description"> <p> Iterate through all objects </p> <dl> <dt><tt>yield</tt></dt><dd>Each object in database to block of caller. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000073-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000073-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 92</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>) <span class="ruby-ivar">@db</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000071" class="method-detail"> <a name="M000071"></a> <div class="method-heading"> <a href="#M000071" class="method-signature"> <span class="method-name">get</span><span class="method-args">(oid)</span> </a> </div> <div class="method-description"> <p> Finds an object in the database by its id. </p> <dl> <dt><tt>oid</tt></dt><dd>is the id to use in the search. </dd> <dt><tt>return</tt></dt><dd>Handle to the object or nil. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000071-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000071-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 79</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">oid</span>) <span class="ruby-ivar">@db</span>[<span class="ruby-identifier">oid</span>] <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000069" class="method-detail"> <a name="M000069"></a> <div class="method-heading"> <a href="#M000069" class="method-signature"> <span class="method-name">put</span><span class="method-args">(obj)</span> </a> </div> <div class="method-description"> <p> Adds a <a href="XmlStore.html#M000067">new</a> object to the database. </p> <dl> <dt><tt>obj</tt></dt><dd>is a reference to object to be added </dd> <dt><tt>return</tt></dt><dd>Undefined. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000069-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000069-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 64</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put</span>(<span class="ruby-identifier">obj</span>) <span class="ruby-ivar">@db</span>[<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">id</span>] = <span class="ruby-identifier">obj</span> <span class="ruby-identifier">obj</span> <span class="ruby-comment cmt"># return really ought not be checked</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000068" class="method-detail"> <a name="M000068"></a> <div class="method-heading"> <a href="#M000068" class="method-signature"> <span class="method-name">save</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Save the world </p> <dl> <dt><tt>return</tt></dt><dd>Undefined. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000068-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000068-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/xmlstore.rb, line 55</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@dbfile</span>,<span class="ruby-value str">'w'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">XMLRPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">values</span>)) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>