<?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.EUtils.Datatypes</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.EUtils-module.html">Package EUtils</a> :: Module Datatypes </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.EUtils.Datatypes-module.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== MODULE DESCRIPTION ==================== --> <h1 class="epydoc">Module Datatypes</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.EUtils.Datatypes-pysrc.html">source code</a></span></p> <p>various EUtils datatypes</p> <!-- ==================== CLASSES ==================== --> <a name="section-Classes"></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">Classes</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Classes" 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"> <a href="Bio.EUtils.Datatypes.EUtilsError-class.html" class="summary-name">EUtilsError</a><br /> Base class for all EUtils-specific errors </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.EUtilsSearchError-class.html" class="summary-name">EUtilsSearchError</a><br /> Used when the ESearch XML says there is an ERROR </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.DBIds-class.html" class="summary-name">DBIds</a><br /> Store a list of identifiers for a database </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.WithinNDays-class.html" class="summary-name">WithinNDays</a><br /> Restrict a search to matches in the last N days </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.DateRange-class.html" class="summary-name">DateRange</a><br /> Restrict a search to matches within a date range </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Expression-class.html" class="summary-name">Expression</a><br /> Base class for the Expression given in the eSearch output </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Term-class.html" class="summary-name">Term</a><br /> Information about an Expression Term, which is the leaf node </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.BinaryOp-class.html" class="summary-name">BinaryOp</a><br /> Base class for binary expressions. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.And-class.html" class="summary-name">And</a><br /> intersection of two subexpressions </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Or-class.html" class="summary-name">Or</a><br /> union two subexpressions </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Not-class.html" class="summary-name">Not</a><br /> the set of the left child without elements from the right child </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Range-class.html" class="summary-name">Range</a><br /> Used to store a date range </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.SearchResult-class.html" class="summary-name">SearchResult</a><br /> Store results from a database search </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.PostResult-class.html" class="summary-name">PostResult</a><br /> Store the results of a Post </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Summary-class.html" class="summary-name">Summary</a><br /> Store information from calling eSummary </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Date-class.html" class="summary-name">Date</a><br /> Allow simple Date storage </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Problem-class.html" class="summary-name">Problem</a><br /> Base class for Search Errors or Warnings </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.ErrorProblem-class.html" class="summary-name">ErrorProblem</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.WarningProblem-class.html" class="summary-name">WarningProblem</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.PhraseNotFound-class.html" class="summary-name">PhraseNotFound</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.FieldNotFound-class.html" class="summary-name">FieldNotFound</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.PhraseIgnored-class.html" class="summary-name">PhraseIgnored</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.QuotedPhraseNotFound-class.html" class="summary-name">QuotedPhraseNotFound</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.OutputMessage-class.html" class="summary-name">OutputMessage</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Link-class.html" class="summary-name">Link</a><br /> Store neighbor Link information for a given record </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.IdCheck-class.html" class="summary-name">IdCheck</a><br /> Store results from an lcheck link </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.LinkSetDb-class.html" class="summary-name">LinkSetDb</a><br /> Used in eLink with cmd == neighbor </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.NeighborLinkSet-class.html" class="summary-name">NeighborLinkSet</a><br /> Results from an eLink neighbor search </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.CheckLinkSet-class.html" class="summary-name">CheckLinkSet</a><br /> Results from 'ncheck' and 'lcheck' searches </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.Provider-class.html" class="summary-name">Provider</a><br /> The Provider, as listed in 'llinks' (LinkOut) </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.ObjUrl-class.html" class="summary-name">ObjUrl</a><br /> The ObjUrl containing LinkOut information for a record </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.IdUrlSet-class.html" class="summary-name">IdUrlSet</a><br /> Set of ObjUrls for the record with the given 'id' </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.Datatypes.LinksLinkSet-class.html" class="summary-name">LinksLinkSet</a><br /> Results of an 'llink' (LinkOut) search </td> </tr> </table> <!-- ==================== FUNCTIONS ==================== --> <a name="section-Functions"></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">Functions</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Functions" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr class="private"> <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.EUtils.Datatypes-module.html#_date_re_match" class="summary-sig-name" onclick="show_private();">_date_re_match</a>(<span class="summary-sig-arg">...</span>)</span><br /> match(string[, pos[, endpos]]) --> match object or None.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.Datatypes-pysrc.html#_date_re_match">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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="_build_problem_mapping"></a><span class="summary-sig-name">_build_problem_mapping</span>()</span><br /> Internal: make a map from category name (in XML) to the right class</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.Datatypes-pysrc.html#_build_problem_mapping">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== VARIABLES ==================== --> <a name="section-Variables"></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">Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Variables" 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"> <a name="problem_category_mapping"></a><span class="summary-name">problem_category_mapping</span> = <code title="_build_problem_mapping()">_build_problem_mapping()</code> </td> </tr> </table> <!-- ==================== FUNCTION DETAILS ==================== --> <a name="section-FunctionDetails"></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">Function Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-FunctionDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="_date_re_match"></a> <div class="private"> <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">_date_re_match</span>(<span class="sig-arg">...</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.EUtils.Datatypes-pysrc.html#_date_re_match">source code</a></span> </td> </tr></table> <p>match(string[, pos[, endpos]]) --> match object or None. Matches zero or more characters at the beginning of the string</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:23 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>