<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Bio.config.DBRegistry.DBObject</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Bio-module.html">Package Bio</a> ::
<a href="Bio.config-module.html">Package config</a> ::
<a href="Bio.config.DBRegistry-module.html">Module DBRegistry</a> ::
Class DBObject
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Bio.config.DBRegistry.DBObject-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DBObject</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject">source code</a></span></p>
<pre class="base-tree">
<a href="Bio.config.Registry.RegisterableObject-class.html">Registry.RegisterableObject</a> --+
|
<strong class="uidshort">DBObject</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Bio.config.DBRegistry.BioCorbaDB-class.html">BioCorbaDB</a></li><li>, <a href="Bio.config.DBRegistry.BioSQLDB-class.html">BioSQLDB</a></li><li>, <a href="Bio.config.DBRegistry.CGIDB-class.html">CGIDB</a></li><li>, <a href="Bio.config.DBRegistry.EUtilsDB-class.html">EUtilsDB</a></li><li>, <a href="Bio.config.DBRegistry.IndexedFileDB-class.html">IndexedFileDB</a></li> </ul>
</dd></dl>
<hr />
<pre class="literalblock">
This is a base class for dictionary-like interfaces to
databases.
Methods:
get Lookup a key in a database, with a default value.
get_as Lookup a key and convert to an object.
__getitem__ Lookup a key in a database.
THE FOLLOWING SHOULD BE IMPLEMENTED IN A DERIVED CLASS.
_get Return the data indicated by key.
_convert_to Convert the data to another object.
IMPLEMENT THESE ONLY IF TIMEOUT OR CONCURRENT ACCESS IS NEEDED.
_make_pickleable Make the object returned by _get to a pickleable.
_unmake_pickleable Turn the pickleable object back into the original
</pre>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.config.DBRegistry.DBObject-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">abbrev</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">doc</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">delay</span>=<span class="summary-sig-default">None</span>)</span><br />
DBObject(name[, abbrev][, doc][, delay])</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="set"></a><span class="summary-sig-name">set</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">data</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject.set">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">data</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get"></a><span class="summary-sig-name">get</span>(<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">default</span>=<span class="summary-sig-default">...</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject.get">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_as"></a><span class="summary-sig-name">get_as</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">to_io</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br />
S.get_as(key[, to_io][, default]) -> object</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject.get_as">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject.__getitem__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">data</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_get"></a><span class="summary-sig-name">_get</span>(<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">key</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject._get">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">another data type</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_convert_to"></a><span class="summary-sig-name">_convert_to</span>(<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">data</span>,
<span class="summary-sig-arg">to_io</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject._convert_to">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_set"></a><span class="summary-sig-name">_set</span>(<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">data</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject._set">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">pickleable_obj</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_make_pickleable"></a><span class="summary-sig-name">_make_pickleable</span>(<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">data</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject._make_pickleable">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">data</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_unmake_pickleable"></a><span class="summary-sig-name">_unmake_pickleable</span>(<span class="summary-sig-arg">S</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">pickleable_obj</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject._unmake_pickleable">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">abbrev</span>=<span class="sig-default">None</span>,
<span class="sig-arg">doc</span>=<span class="sig-default">None</span>,
<span class="sig-arg">delay</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.config.DBRegistry-pysrc.html#DBObject.__init__">source code</a></span>
</td>
</tr></table>
<p>DBObject(name[, abbrev][, doc][, delay])</p>
<dl class="fields">
<dt>Overrides:
<a href="Bio.config.Registry.RegisterableObject-class.html#__init__">Registry.RegisterableObject.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:39 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
