Page MenuHomec4science

Pyblio.Store.Database-class.html
No OneTemporary

File Metadata

Created
Mon, Jul 7, 02:54

Pyblio.Store.Database-class.html

<?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>Pyblio.Store.Database</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">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Pyblio-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Pyblio-module.html">Package&nbsp;Pyblio</a> ::
<a href="Pyblio.Store-module.html">Module&nbsp;Store</a> ::
Class&nbsp;Database
</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&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Pyblio.Store.Database-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Database</h1><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<strong class="uidshort">Database</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<a href="Pyblio.Adapter.Adapter-class.html">Adapter.Adapter</a>,
<a href="Pyblio.Stores.filestore.Database-class.html">Stores.filestore.Database</a>,
<a href="Pyblio.Stores.bsddbstore.Database-class.html">Stores.bsddbstore.Database</a>
</dd></dl>
<hr />
<p>A bibliographic database.</p>
A database behaves like a dictionnary, linking a <a
href="Pyblio.Store.Key-class.html" class="link">key</a> with a <a
href="Pyblio.Store.Record-class.html" class="link">record</a>. The
records are <b>typed</b>, and must follow the specifications of a <a
href="Pyblio.Schema-module.html" class="link">Schema</a>.
<h1 class="heading">Adding a new record</h1>
To add a new record r to a database db:
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>record = Record ()
<span class="py-prompt">&gt;&gt;&gt; </span>record [<span class="py-string">'title'</span>] = Attribute.Text (<span class="py-string">'my title'</span>)
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-comment"># ...</span>
<span class="py-prompt">&gt;&gt;&gt; </span>key = db.add (record)</pre>
When the record is added, a <a href="Pyblio.Store.Key-class.html"
class="link">key</a> is generated which uniquely references the
record.
<h1 class="heading">Accessing a record</h1>
It is possible to use the database as a dictionnary. So, given a key
k:
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>r = db [k]</pre>
Alternatively, one can access all the records in a database in
random order:
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">for</span> key, record <span class="py-keyword">in</span> db.entries.iteritems ():
<span class="py-prompt">&gt;&gt;&gt; </span> <span class="py-comment"># do something with the record...</span></pre>
<h1 class="heading">Updating a record</h1>
Simply store the record back once it is updated:
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>record = db [key]
<span class="py-prompt">&gt;&gt;&gt; </span>... <span class="py-comment"># update the record</span>
<span class="py-prompt">&gt;&gt;&gt; </span>db [key] = record</pre><br /><br />
<hr />
<div class="fields"> <p><strong>See Also:</strong>
<a href="Pyblio.Query-module.html" class="link">queries</a>
</p>
<p><strong>Attention:</strong>
getting a record from the database returns a <i>new copy</i> at
each access. Updating this copy <i>does not</i> change the stored
value.
</p>
</div><!-- ==================== 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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_txo_warn"></a><span class="summary-sig-name">_txo_warn</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database._txo_warn">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_txo_get"></a><span class="summary-sig-name">_txo_get</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database._txo_get">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_entries_get"></a><span class="summary-sig-name">_entries_get</span>(<span class="summary-sig-arg">self</span>)</span><br />
Return the result set that contains _all_ the entries.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database._entries_get">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">record</span>,
<span class="summary-sig-arg">key</span>=<span class="summary-sig-default">None</span>)</span><br />
Insert a new entry in the database.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.add">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#__setitem__" class="summary-sig-name">__setitem__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">record</span>)</span><br />
Update a record.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.__setitem__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>)</span><br />
Get a record by key.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.__getitem__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#has_key" class="summary-sig-name">has_key</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>)</span><br />
Check for the existence of a key.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.has_key">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="query"></a><span class="summary-sig-name">query</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">query</span>,
<span class="summary-sig-arg">permanent</span>=<span class="summary-sig-default">False</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.query">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="collate"></a><span class="summary-sig-name">collate</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">rs</span>,
<span class="summary-sig-arg">field</span>)</span><br />
Partition the result set in a list of sets for every value taken
by the specified field</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.collate">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="save"></a><span class="summary-sig-name">save</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.save">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">entry</span>)</span><br />
Check an entry for conformance against the Schema.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.validate">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="xmlwrite"></a><span class="summary-sig-name">xmlwrite</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fd</span>)</span><br />
Output a database in XML format</td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.xmlwrite">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="xmlread"></a><span class="summary-sig-name">xmlread</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fd</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.xmlread">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
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">&nbsp;</span>
</td><td class="summary">
<a name="rs"></a><span class="summary-name">rs</span><br />
a <a href="Pyblio.Store.ResultSetStore-class.html"
class="link">ResultSetStore</a> instance, containing all the result
sets defined on this database.
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
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">&nbsp;</span>
</td><td class="summary">
<a href="Pyblio.Store.Database-class.html#txo" class="summary-name">txo</a><br />
<b>DEPRECATED</b>, use <code class="link">schema.txo</code>
instead.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="Pyblio.Store.Database-class.html#entries" class="summary-name">entries</a><br />
a <a href="Pyblio.Store.ResultSet-class.html"
class="link">resultset</a> containing all the records of the
database.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</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>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</table>
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
<dl class="fields">
<dt>Overrides:
object.__init__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="add"></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">add</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">record</span>,
<span class="sig-arg">key</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.add">source&nbsp;code</a></span>&nbsp;
</td>
</table>
<p>Insert a new entry in the database.</p>
New entries <b>MUST</b> be added with this method, not via an update
with a hand-made Key.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>record</code></strong> (a <a href="Pyblio.Store.Record-class.html"
class="link">Record</a>) - the new record to add</li>
<li><strong class="pname"><code>key</code></strong> (a <a href="Pyblio.Store.Key-class.html"
class="link">Key</a>) - only useful for importing an existing database, by
<i>proposing</i> a key choice.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="__setitem__"></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">__setitem__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">key</span>,
<span class="sig-arg">record</span>)</span>
<br /><em class="fname">(Index assignment operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.__setitem__">source&nbsp;code</a></span>&nbsp;
</td>
</table>
<p>Update a record.</p>
Updates a record with a new value.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>key</code></strong> (a <a href="Pyblio.Store.Key-class.html"
class="link">Key</a>) - the record's key</li>
<li><strong class="pname"><code>record</code></strong> (a <a href="Pyblio.Store.Record-class.html"
class="link">Record</a>) - the new value of the record</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="__getitem__"></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">__getitem__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">key</span>)</span>
<br /><em class="fname">(Indexing operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.__getitem__">source&nbsp;code</a></span>&nbsp;
</td>
</table>
Get a record by key.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>key</code></strong> (a <a href="Pyblio.Store.Key-class.html"
class="link">Key</a>) - the key of the requested record</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="has_key"></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">has_key</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">key</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.has_key">source&nbsp;code</a></span>&nbsp;
</td>
</table>
Check for the existence of a key.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>key</code></strong> (a <a href="Pyblio.Store.Key-class.html"
class="link">Key</a>) - the key to check for</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="validate"></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">validate</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">entry</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Pyblio.Store-pysrc.html#Database.validate">source&nbsp;code</a></span>&nbsp;
</td>
</table>
Check an entry for conformance against the Schema. This method may
modify the entry to normalize certain fields.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></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">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="txo"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">txo</h3>
<b>DEPRECATED</b>, use <code class="link">schema.txo</code> instead. A
<a href="Pyblio.Schema.TxoGroup-class.html" class="link">TxoGroup</a>
instance, containing all the taxonomy definitions in the database. See <a
href="Pyblio.Schema.TxoItem-class.html" class="link">TxoItem</a>.
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#_txo_get" class="summary-sig-name">Pyblio.Store.Database._txo_get</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="entries"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">entries</h3>
a <a href="Pyblio.Store.ResultSet-class.html"
class="link">resultset</a> containing all the records of the
database.
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#_entries_get" class="summary-sig-name">Pyblio.Store.Database._entries_get</a>(<span class="summary-sig-arg">self</span>)</span>
- Return the result set that contains _all_ the entries.
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Pyblio-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Sep 13 21:54:20 2007
</td>
<td align="right" class="footer">
<a 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>

Event Timeline