<?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.Entrez.Parser.DataHandler</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.Entrez-module.html">Package Entrez</a> ::
<a href="Bio.Entrez.Parser-module.html">Module Parser</a> ::
Class DataHandler
</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.Entrez.Parser.DataHandler-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DataHandler</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler">source code</a></span></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 name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">dtd_dir</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.__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="run"></a><span class="summary-sig-name">run</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">handle</span>)</span><br />
Set up the parser and let it parse the XML results</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.run">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="startElement"></a><span class="summary-sig-name">startElement</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">attrs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.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 name="endElement"></a><span class="summary-sig-name">endElement</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.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 name="characters"></a><span class="summary-sig-name">characters</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">content</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.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="Bio.Entrez.Parser.DataHandler-class.html#elementDecl" class="summary-sig-name">elementDecl</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">model</span>)</span><br />
This callback function is called for each element declaration:
<!ELEMENT name (...)> encountered in a DTD.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.elementDecl">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="Bio.Entrez.Parser.DataHandler-class.html#external_entity_ref_handler" class="summary-sig-name">external_entity_ref_handler</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">context</span>,
<span class="summary-sig-arg">base</span>,
<span class="summary-sig-arg">systemId</span>,
<span class="summary-sig-arg">publicId</span>)</span><br />
The purpose of this function is to load the DTD locally, instead of
downloading it from the URL specified in the XML.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.external_entity_ref_handler">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="Bio.Entrez.Parser.DataHandler-class.html#load_definitions" class="summary-sig-name">load_definitions</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">filename</span>)</span><br />
This function is only needed if the XML does not specify a DTD.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.load_definitions">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="elementDecl"></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">elementDecl</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">model</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.elementDecl">source code</a></span>
</td>
</tr></table>
<p>This callback function is called for each element declaration:
<!ELEMENT name (...)> encountered in a DTD. The
purpose of this function is to determine whether this element should be
regarded as a string, integer, list dictionary, structure, or error.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="external_entity_ref_handler"></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">external_entity_ref_handler</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">context</span>,
<span class="sig-arg">base</span>,
<span class="sig-arg">systemId</span>,
<span class="sig-arg">publicId</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.external_entity_ref_handler">source code</a></span>
</td>
</tr></table>
<p>The purpose of this function is to load the DTD locally, instead of
downloading it from the URL specified in the XML. Using the local DTD
results in much faster parsing. If the DTD is not found locally, we try
to download it. In practice, this may fail though, if the XML relies on
many interrelated DTDs. If new DTDs appear, putting them in
Bio/Entrez/DTDs will allow the parser to see them.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="load_definitions"></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">load_definitions</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">filename</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.Entrez.Parser-pysrc.html#DataHandler.load_definitions">source code</a></span>
</td>
</tr></table>
<p>This function is only needed if the XML does not specify a DTD. As far
as I can tell, this only occurs for EFetch results from the Journals
database. Use a hand-written set of definitions instead.</p>
<dl class="fields">
</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:34 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>
