Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F120663260
Pyblio.Stores.filestore.Database-class.html
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Sun, Jul 6, 02:47
Size
23 KB
Mime Type
text/xml
Expires
Tue, Jul 8, 02:47 (2 d)
Engine
blob
Format
Raw Data
Handle
27206621
Attached To
R3596 pybliographer
Pyblio.Stores.filestore.Database-class.html
View Options
<?xml version="1.0" encoding="iso-8859-1"?>
<!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.Stores.filestore.Database</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="Pyblio-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer 1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="Pyblio-module.html">Package Pyblio</a> ::
<a href="Pyblio.Stores-module.html">Package Stores</a> ::
<a href="Pyblio.Stores.filestore-module.html">Module filestore</a> ::
Class Database
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/Pyblio.Stores.filestore.Database-class.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="Pyblio.Stores.filestore.Database-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type Database</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<a href="Pyblio.Store.Database-class.html"><code>Database</code></a> --+
|
<a href="__builtin__.object-class.html"><code>object</code></a> --+ |
| |
<a href="Pyblio.Callback.Publisher-class.html"><code>Publisher</code></a> --+
|
<a href="__builtin__.object-class.html"><code>object</code></a> --+ |
| |
<a href="Pyblio.Query.Queryable-class.html"><code>Queryable</code></a> --+
|
<b>Database</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>schema</span>,
<span class=summary-sig-arg>file</span>,
<span class=summary-sig-arg>create</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__delitem__"></a><span class="summary-sig"><span class="summary-sig-name">__delitem__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Stores.filestore.Database-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
<br />
Get a record by key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__setitem__"></a><span class="summary-sig"><span class="summary-sig-name">__setitem__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>,
<span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Stores.filestore.Database-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>record</span>,
<span class=summary-sig-arg>key</span>)</span></code>
<br />
Insert a new entry in the database.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="has_key"></a><span class="summary-sig"><span class="summary-sig-name">has_key</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Stores.filestore.Database-class.html#index" class="summary-sig-name"><code>index</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Turn on indexing of the db content.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="save"></a><span class="summary-sig"><span class="summary-sig-name">save</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Stores.filestore.Database-class.html#_entries_get" class="summary-sig-name"><code>_entries_get</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the result set that contains all the entries.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_idxadd"></a><span class="summary-sig"><span class="summary-sig-name">_idxadd</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>,
<span class=summary-sig-arg>val</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_idxdel"></a><span class="summary-sig"><span class="summary-sig-name">_idxdel</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_q_anyword"></a><span class="summary-sig"><span class="summary-sig-name">_q_anyword</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>query</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Queryable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Query.Queryable-class.html#count" class="summary-sig-name"><code>count</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>query</span>)</span></code>
<br />
Perform a query and return the count of matching records.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Query.Queryable-class.html#query" class="summary-sig-name"><code>query</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>query</span>,
<span class=summary-sig-arg>permanent</span>)</span></code>
<br />
Perform a query and return a result set of the matching records.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Query.Queryable-class.html#_q_all" class="summary-sig-name"><code>_q_all</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Query.Queryable-class.html#_q_check" class="summary-sig-name"><code>_q_check</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>query</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Query.Queryable-class.html#_q_hasfield" class="summary-sig-name"><code>_q_hasfield</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>q</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Query.Queryable-class.html#_q_to_rs" class="summary-sig-name"><code>_q_to_rs</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>res</span>,
<span class=summary-sig-arg>permanent</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Query.Queryable-class.html#_q_txo" class="summary-sig-name"><code>_q_txo</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>q</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Database</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#collate" class="summary-sig-name"><code>collate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rs</span>,
<span class=summary-sig-arg>field</span>)</span></code>
<br />
Partition the result set in a list of sets for every value taken by
the specified field</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#validate" class="summary-sig-name"><code>validate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>entry</span>)</span></code>
<br />
Check an entry for conformance against the Schema.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#xmlread" class="summary-sig-name"><code>xmlread</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fd</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Store.Database-class.html#xmlwrite" class="summary-sig-name"><code>xmlwrite</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fd</span>)</span></code>
<br />
Output a database in XML format</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Store.Database-class.html#_txo_get" class="summary-sig-name"><code>_txo_get</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Store.Database-class.html#_txo_warn" class="summary-sig-name"><code>_txo_warn</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Publisher</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Callback.Publisher-class.html#emit" class="summary-sig-name"><code>emit</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>signal</span>,
<span class="summary-sig-vararg">*args</span>)</span></code>
<br />
Call this method to emit a signal.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Callback.Publisher-class.html#register" class="summary-sig-name"><code>register</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>signal</span>,
<span class=summary-sig-arg>callback</span>,
<span class="summary-sig-vararg">*args</span>)</span></code>
<br />
Clients interested in a given signal must register with this
method.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Callback.Publisher-class.html#unregister" class="summary-sig-name"><code>unregister</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>signal</span>,
<span class=summary-sig-arg>callback</span>)</span></code>
<br />
Stop notifying events for the specified signal/callback pair.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__delattr__('name') <==> del x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__getattribute__('name') <==> x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__hash__() <==> hash(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
<span class=summary-sig-arg>S</span>,
<span class="summary-sig-vararg">...</span>)</span></code>
<br />
T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__repr__() <==> repr(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__setattr__('name', value) <==> x.name = value</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__str__() <==> str(x)</td></tr>
</table><br />
<!-- =========== START OF PROPERTY SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Property Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Database</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="Pyblio.Stores.filestore.Database-class.html#entries"><code>entries</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="Pyblio.Store.Database-class.html#txo"><code>txo</code></a></b></td></tr></table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Database</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><a name="entries"></a><b><code>entries</code></b> = <a href="Pyblio.Store.Database-class.html#entries"><code>Pyblio.Store.Database.entries</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="Pyblio.Store.Database-class.html#rs"><code>rs</code></a></b>: a <a href="Pyblio.Store.ResultSetStore-class.html"
class="link"><code>ResultSetStore</code></a> instance, containing all the
result sets defined on this database.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><a name="txo"></a><b><code>txo</code></b> = <a href="Pyblio.Store.Database-class.html#txo"><code>Pyblio.Store.Database.txo</code></a></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__getitem__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__getitem__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>key</span>)</span>
<br /><i>(Indexing operator)</i>
</h3>
Get a record by key.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>key</b></code> -
the key of the requested record
<br /><i>
(type=a <a href="Pyblio.Store.Key-class.html"
class="link"><code>Key</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="Pyblio.Store.Database-class.html#__getitem__"><code>Pyblio.Store.Database.__getitem__</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><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>
<p>Insert a new entry in the database.</p>
<p>New entries MUST be added with this method, not via an update with a
hand-made Key.</p>
key is only useful for importing an existing database, by proposing
a key choice.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="Pyblio.Store.Database-class.html#add"><code>Pyblio.Store.Database.add</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="index"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">index</span>(<span class=sig-arg>self</span>)</span>
</h3>
Turn on indexing of the db content.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_entries_get"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_entries_get</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the result set that contains all the entries.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="../private/Pyblio.Store.Database-class.html#_entries_get"><code>Pyblio.Store.Database._entries_get</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF PROPERTY DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Property Details</th></tr>
</table>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<a name="entries"></a>
<h3>entries</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Get Method:</b></dt>
<dd><span class="summary-sig"><a href="../private/Pyblio.Stores.filestore.Database-class.html#_entries_get" class="summary-sig-name"><code>_entries_get</code></a>(<span class=summary-sig-arg>self</span>)</span>
</dd>
</dl>
</dd>
</dl></td></tr></table><br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="Pyblio-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer 1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Sep 24 23:52:43 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
Event Timeline
Log In to Comment