<?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>Martel.Dispatch.Dispatcher</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="Martel-module.html">Package Martel</a> ::
<a href="Martel.Dispatch-module.html">Module Dispatch</a> ::
Class Dispatcher
</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="Martel.Dispatch.Dispatcher-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Dispatcher</h1><p class="nomargin-top"><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher">source code</a></span></p>
<pre class="base-tree">
xml.sax.handler.ContentHandler --+
|
<a href="Martel.Dispatch.DispatchHandler-class.html">DispatchHandler</a> --+
|
<strong class="uidshort">Dispatcher</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Bio.StdHandler.ConvertDispatchHandler-class.html">Bio.StdHandler.ConvertDispatchHandler</a></li><li>, <a href="Bio.builders.SeqRecord.sequence.BuildSeqRecord-class.html">Bio.builders.SeqRecord.sequence.BuildSeqRecord</a></li><li class="private">, <a href="Bio.Saf._RecordConsumer-class.html" onclick="show_private();">Bio.Saf._RecordConsumer</a></li><li>, <a href="Bio.builders.Search.search.BuildSearch-class.html">Bio.builders.Search.search.BuildSearch</a></li><li class="private">, <a href="Bio.LocusLink._RecordConsumer-class.html" onclick="show_private();">Bio.LocusLink._RecordConsumer</a></li><li class="private">, <a href="Bio.CDD._RecordConsumer-class.html" onclick="show_private();">Bio.CDD._RecordConsumer</a></li> </ul>
</dd></dl>
<hr />
<p>Adapter from the standard SAX events</p>
<!-- ==================== 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="Martel.Dispatch.Dispatcher-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">remap</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.__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 href="Martel.Dispatch.Dispatcher-class.html#acquire" class="summary-sig-name">acquire</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">obj</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.acquire">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="uses_tags"></a><span class="summary-sig-name">uses_tags</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.uses_tags">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 href="Martel.Dispatch.Dispatcher-class.html#startDocument" class="summary-sig-name">startDocument</a>(<span class="summary-sig-arg">self</span>)</span><br />
Receive notification of the beginning of a document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.startDocument">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 href="Martel.Dispatch.Dispatcher-class.html#startElement" class="summary-sig-name">startElement</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>,
<span class="summary-sig-arg">attrs</span>)</span><br />
Signals the start of an element in non-namespace mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.startElement">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 href="Martel.Dispatch.Dispatcher-class.html#endElement" class="summary-sig-name">endElement</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>)</span><br />
Signals the end of an element in non-namespace mode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.endElement">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 href="Martel.Dispatch.Dispatcher-class.html#endDocument" class="summary-sig-name">endDocument</a>(<span class="summary-sig-arg">self</span>)</span><br />
Receive notification of the end of a document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.endDocument">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 href="Martel.Dispatch.Dispatcher-class.html#save_characters" class="summary-sig-name">save_characters</a>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.save_characters">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 href="Martel.Dispatch.Dispatcher-class.html#get_characters" class="summary-sig-name">get_characters</a>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.get_characters">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 href="Martel.Dispatch.Dispatcher-class.html#characters" class="summary-sig-name">characters</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">s</span>)</span><br />
Receive notification of character data.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.characters">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>xml.sax.handler.ContentHandler</code></b>:
<code>endElementNS</code>,
<code>endPrefixMapping</code>,
<code>ignorableWhitespace</code>,
<code>processingInstruction</code>,
<code>setDocumentLocator</code>,
<code>skippedEntity</code>,
<code>startElementNS</code>,
<code>startPrefixMapping</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Martel.Dispatch.DispatchHandler-class.html">DispatchHandler</a></code></b>:
<code><a href="Martel.Dispatch.DispatchHandler-class.html#get_supported_features">get_supported_features</a></code>,
<code><a href="Martel.Dispatch.DispatchHandler-class.html#setCharacterSaver">setCharacterSaver</a></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 class="sig-arg">prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="sig-arg">remap</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.__init__">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="Martel.Dispatch.DispatchHandler-class.html#__init__">DispatchHandler.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="acquire"></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">acquire</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">obj</span>,
<span class="sig-arg">prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.acquire">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="Martel.Dispatch.DispatchHandler-class.html#acquire">DispatchHandler.acquire</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="startDocument"></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">startDocument</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.startDocument">source code</a></span>
</td>
</tr></table>
<p>Receive notification of the beginning of a document.</p>
<p>The SAX parser will invoke this method only once, before any other
methods in this interface or in DTDHandler (except for
setDocumentLocator).</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.startDocument
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="startElement"></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">startElement</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>,
<span class="sig-arg">attrs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.startElement">source code</a></span>
</td>
</tr></table>
<p>Signals the start of an element in non-namespace mode.</p>
<p>The name parameter contains the raw XML 1.0 name of the element type
as a string and the attrs parameter holds an instance of the Attributes
class containing the attributes of the element.</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.startElement
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="endElement"></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">endElement</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tag</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.endElement">source code</a></span>
</td>
</tr></table>
<p>Signals the end of an element in non-namespace mode.</p>
<p>The name parameter contains the name of the element type, just as with
the startElement event.</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.endElement
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="endDocument"></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">endDocument</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.endDocument">source code</a></span>
</td>
</tr></table>
<p>Receive notification of the end of a document.</p>
<p>The SAX parser will invoke this method only once, and it will be the
last method invoked during the parse. The parser shall not invoke this
method until it has either abandoned parsing (because of an unrecoverable
error) or reached the end of input.</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.endDocument
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="save_characters"></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">save_characters</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.save_characters">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="Martel.Dispatch.DispatchHandler-class.html#save_characters">DispatchHandler.save_characters</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="get_characters"></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">get_characters</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.get_characters">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="Martel.Dispatch.DispatchHandler-class.html#get_characters">DispatchHandler.get_characters</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="characters"></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">characters</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">s</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Dispatch-pysrc.html#Dispatcher.characters">source code</a></span>
</td>
</tr></table>
<p>Receive notification of character data.</p>
<p>The Parser will call this method to report each chunk of character
data. SAX parsers may return all contiguous character data in a single
chunk, or they may split it into several chunks; however, all of the
characters in any single event must come from the same external entity so
that the Locator provides useful information.</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.characters
<dd><em class="note">(inherited documentation)</em></dd>
</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>
