<?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: Store</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">Store</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/storage/store_rb.html">
lib/storage/store.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</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,5,77,53" href="Store.html" alt="Store
" />
</map>
<img src="../dot/f_51.png" usemap="#map" border="0" alt="dot/f_51.png">
</div>
<div id="description">
<p>
The <a href="Store.html">Store</a> class is an abstract class defining the
methods needed to access a data store
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000080">check</a>
<a href="#M000075">close</a>
<a href="#M000083">delete</a>
<a href="#M000084">each</a>
<a href="#M000079">get</a>
<a href="#M000078">getid</a>
<a href="#M000076">inspect</a>
<a href="#M000085">makenoswap</a>
<a href="#M000086">makeswap</a>
<a href="#M000081">mark</a>
<a href="#M000074">new</a>
<a href="#M000082">put</a>
<a href="#M000077">save</a>
<a href="#M000087">stats</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-M000074" class="method-detail">
<a name="M000074"></a>
<div class="method-heading">
<a href="#M000074" class="method-signature">
<span class="method-name">new</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Construct store
</p>
<dl>
<dt><tt>return</tt></dt><dd>Handle to the store
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000074-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 57</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
<span class="ruby-ivar">@dbtop</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000080" class="method-detail">
<a name="M000080"></a>
<div class="method-heading">
<a href="#M000080" 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('M000080-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000080-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 93</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">false</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000075" class="method-detail">
<a name="M000075"></a>
<div class="method-heading">
<a href="#M000075" class="method-signature">
<span class="method-name">close</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Close the store
</p>
<dl>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000075-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 63</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000083" class="method-detail">
<a name="M000083"></a>
<div class="method-heading">
<a href="#M000083" 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('M000083-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000083-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 112</span>
<span class="ruby-keyword kw">def</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-M000084" class="method-detail">
<a name="M000084"></a>
<div class="method-heading">
<a href="#M000084" class="method-signature">
<span class="method-name">each</span><span class="method-args">()</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('M000084-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000084-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 117</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000079" class="method-detail">
<a name="M000079"></a>
<div class="method-heading">
<a href="#M000079" 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('M000079-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000079-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 86</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000078" class="method-detail">
<a name="M000078"></a>
<div class="method-heading">
<a href="#M000078" class="method-signature">
<span class="method-name">getid</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Fetch the next available id.
</p>
<dl>
<dt><tt>return</tt></dt><dd>An id.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000078-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 79</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getid</span>
<span class="ruby-ivar">@dbtop</span><span class="ruby-operator">+=</span><span class="ruby-value">1</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000076" class="method-detail">
<a name="M000076"></a>
<div class="method-heading">
<a href="#M000076" class="method-signature">
<span class="method-name">inspect</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Store.html#M000076">inspect</a> the store cache (only for caches)
</p>
<dl>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000076-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 68</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
<span class="ruby-value str">""</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000085" class="method-detail">
<a name="M000085"></a>
<div class="method-heading">
<a href="#M000085" class="method-signature">
<span class="method-name">makenoswap</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Marks an object nonswappable
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the object id
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000085-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000085-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 123</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">makenoswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000086" class="method-detail">
<a name="M000086"></a>
<div class="method-heading">
<a href="#M000086" class="method-signature">
<span class="method-name">makeswap</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Marks an object swappable
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the object id
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000086-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000086-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 129</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">makeswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000081" class="method-detail">
<a name="M000081"></a>
<div class="method-heading">
<a href="#M000081" class="method-signature">
<span class="method-name">mark</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Marks an object dirty
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the id to use in the search.
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000081-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 100</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mark</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000082" class="method-detail">
<a name="M000082"></a>
<div class="method-heading">
<a href="#M000082" 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="Store.html#M000074">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('M000082-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000082-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 106</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000077" class="method-detail">
<a name="M000077"></a>
<div class="method-heading">
<a href="#M000077" class="method-signature">
<span class="method-name">save</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Save or flush the store to disk
</p>
<dl>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000077-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 74</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000087" class="method-detail">
<a name="M000087"></a>
<div class="method-heading">
<a href="#M000087" class="method-signature">
<span class="method-name">stats</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
produces a statistical report of the database
</p>
<dl>
<dt><tt>return</tt></dt><dd>a string containing the report
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000087-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000087-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/store.rb, line 134</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stats</span>
<span class="ruby-identifier">rooms</span> = <span class="ruby-identifier">objs</span> = <span class="ruby-identifier">scripts</span> = <span class="ruby-identifier">characters</span> = <span class="ruby-identifier">accounts</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-keyword kw">case</span> <span class="ruby-identifier">val</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-constant">Room</span>
<span class="ruby-identifier">rooms</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-constant">Character</span>
<span class="ruby-identifier">characters</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-constant">GameObject</span>
<span class="ruby-identifier">objs</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-constant">Script</span>
<span class="ruby-identifier">scripts</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-constant">Account</span>
<span class="ruby-identifier">accounts</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">stats</span>=<span class="ruby-value str">"[COLOR Cyan]\n---* Database Statistics *---\n Rooms - \#{rooms}\n Objects - \#{objs}\n Scripts - \#{scripts}\n Accounts - \#{accounts}\n Characters - \#{characters}\n Total Objects - \#{rooms+objs+characters+accounts+scripts}\n Highest OID in use - \#{@dbtop}\n---* *---\n[/COLOR]\n"</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>
