twisted.enterprise.reflector.Reflector.html [plain text]
<?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>twisted.enterprise.reflector.Reflector</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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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="twisted.html">Package twisted</a> ::
<a href="twisted.enterprise.html">Package enterprise</a> ::
<a href="twisted.enterprise.reflector.html">Module reflector</a> ::
Class Reflector
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.enterprise.reflector.Reflector.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Reflector</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.enterprise.sqlreflector.SQLReflector.html"><code>SQLReflector</code></a>,
<a href="twisted.enterprise.xmlreflector.XMLReflector.html"><code>XMLReflector</code></a></dd></dl>
<hr/>
Base class for enterprise reflectors. This implements row caching.
<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><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowClasses</span>)</span></code>
<br />
Initialize me against a database.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</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><a name="__setstate__"></a><span class="summary-sig"><span class="summary-sig-name">__setstate__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</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="twisted.enterprise.reflector.Reflector.html#_populate" class="summary-sig-name"><code>_populate</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Implement me to populate schema information for the reflector.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#addToCache" class="summary-sig-name"><code>addToCache</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowObject</span>)</span></code>
<br />
NOTE: Should this be recursive?! requires better container
knowledge...</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#addToParent" class="summary-sig-name"><code>addToParent</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parentRow</span>,
<span class=summary-sig-arg>rows</span>,
<span class=summary-sig-arg>tableName</span>)</span></code>
<br />
util method used by reflectors.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#buildWhereClause" class="summary-sig-name"><code>buildWhereClause</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>relationship</span>,
<span class=summary-sig-arg>row</span>)</span></code>
<br />
util method used by reflectors.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#deleteRow" class="summary-sig-name"><code>deleteRow</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowObject</span>)</span></code>
<br />
delete the row for this object from the database.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="findInCache"></a><span class="summary-sig"><span class="summary-sig-name">findInCache</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowClass</span>,
<span class=summary-sig-arg>kw</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="twisted.enterprise.reflector.Reflector.html#getTableInfo" class="summary-sig-name"><code>getTableInfo</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowObject</span>)</span></code>
<br />
Get a TableInfo record about a particular instance.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#insertRow" class="summary-sig-name"><code>insertRow</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowObject</span>)</span></code>
<br />
insert a new row for this object instance.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#loadObjectsFrom" class="summary-sig-name"><code>loadObjectsFrom</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tableName</span>,
<span class=summary-sig-arg>parent</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>whereClause</span>,
<span class=summary-sig-arg>loadChildren</span>)</span></code>
<br />
Implement me to load objects from the database.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#populateSchemaFor" class="summary-sig-name"><code>populateSchemaFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tableInfo</span>)</span></code>
<br />
This is called once for each registered rowClass to add it and its
foreign key relationships for that rowClass to 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="twisted.enterprise.reflector.Reflector.html#removeFromCache" class="summary-sig-name"><code>removeFromCache</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowObject</span>)</span></code>
<br />
NOTE: should this be recursive!??</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.enterprise.reflector.Reflector.html#updateRow" class="summary-sig-name"><code>updateRow</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rowObject</span>)</span></code>
<br />
update this rowObject to the database.</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><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.enterprise.reflector.Reflector.html#populated"><code>populated</code></a></b> = <span title="0">0 </span></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="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowClasses</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize me against a database.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>rowClasses</b></code> -
a list of row class objects that describe the database
schema.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_populate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_populate</span>(<span class=sig-arg>self</span>)</span>
</h3>
Implement me to populate schema information for the reflector.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addToCache"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addToCache</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowObject</span>)</span>
</h3>
NOTE: Should this be recursive?! requires better container
knowledge...
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addToParent"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addToParent</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>parentRow</span>,
<span class=sig-arg>rows</span>,
<span class=sig-arg>tableName</span>)</span>
</h3>
util method used by reflectors. adds these rows to the parent row
object. If a rowClass does not have a containerMethod, then a list
attribute "childRows" will be used.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="buildWhereClause"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">buildWhereClause</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>relationship</span>,
<span class=sig-arg>row</span>)</span>
</h3>
util method used by reflectors. builds a where clause to link a row
to another table.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="deleteRow"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">deleteRow</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowObject</span>)</span>
</h3>
delete the row for this object from the database.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getTableInfo"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getTableInfo</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowObject</span>)</span>
</h3>
<p>Get a TableInfo record about a particular instance.</p>
This record contains various information about the instance's class
as registered with this reflector.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>rowObject</b></code> -
a <code>RowObject</code> instance of a class previously
registered with me.
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>twisted.enterprise.row.DBError</b></code> -
raised if this class was not previously registered.
</dl>
</dd></dl>
</td></tr></table>
<a name="insertRow"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">insertRow</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowObject</span>)</span>
</h3>
insert a new row for this object instance.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="loadObjectsFrom"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">loadObjectsFrom</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>tableName</span>,
<span class=sig-arg>parent</span>=<span class=sig-default>None</span>,
<span class=sig-arg>data</span>=<span class=sig-default>None</span>,
<span class=sig-arg>whereClause</span>=<span class=sig-default>[]</span>,
<span class=sig-arg>loadChildren</span>=<span class=sig-default>1</span>)</span>
</h3>
Implement me to load objects from the database.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>whereClause</b></code> -
a list of tuples of (columnName, conditional, value) so it can
be parsed by all types of reflectors. eg.:
<pre class="literalblock">
whereClause = [("name", EQUALS, "fred"), ("age", GREATERTHAN, 18)]
</pre>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="populateSchemaFor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">populateSchemaFor</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>tableInfo</span>)</span>
</h3>
This is called once for each registered rowClass to add it and its
foreign key relationships for that rowClass to the schema.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeFromCache"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeFromCache</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowObject</span>)</span>
</h3>
NOTE: should this be recursive!??
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="updateRow"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">updateRow</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>rowObject</span>)</span>
</h3>
update this rowObject to the database.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="populated"></a>
<h3>populated</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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.0 on Sat May 15 20:08:31 2004</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>