<?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.SeqIO.Interfaces.SequentialSequenceWriter</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.SeqIO-module.html">Package SeqIO</a> :: <a href="Bio.SeqIO.Interfaces-module.html">Module Interfaces</a> :: Class SequentialSequenceWriter </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.SeqIO.Interfaces.SequentialSequenceWriter-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class SequentialSequenceWriter</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter">source code</a></span></p> <pre class="base-tree"> <a href="Bio.SeqIO.Interfaces.SequenceWriter-class.html">SequenceWriter</a> --+ | <strong class="uidshort">SequentialSequenceWriter</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="Bio.SeqIO.StockholmIO.StockholmWriter-class.html">StockholmIO.StockholmWriter</a></li><li>, <a href="Bio.SeqIO.FastaIO.FastaWriter-class.html">FastaIO.FastaWriter</a></li> </ul> </dd></dl> <hr /> <p>This class should be subclassed.</p> <p>It is intended for sequential file formats with an (optional) header, repeated records, and an (optional) footer.</p> <p>In this case (as with interlaced file formats), the user may simply call the write_file() method and be done.</p> <p>However, they may also call the write_header(), followed by multiple calls to write_record() and/or write_records() followed finally by write_footer().</p> <p>Users must call write_header() and write_footer() even when the file format concerned doesn't have a header or footer. This is to try and make life as easy as possible when switching the output format.</p> <p>Note that write_header() cannot require any assumptions about the number of records.</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="Bio.SeqIO.Interfaces.SequentialSequenceWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">handle</span>)</span><br /> Creates the writer object.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.__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="Bio.SeqIO.Interfaces.SequentialSequenceWriter-class.html#write_file" class="summary-sig-name">write_file</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">records</span>)</span><br /> Use this to write an entire file containing the given records.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_file">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="write_footer"></a><span class="summary-sig-name">write_footer</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_footer">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="write_header"></a><span class="summary-sig-name">write_header</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_header">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.SeqIO.Interfaces.SequentialSequenceWriter-class.html#write_record" class="summary-sig-name">write_record</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">record</span>)</span><br /> Write a single record to the output file.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_record">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.SeqIO.Interfaces.SequentialSequenceWriter-class.html#write_records" class="summary-sig-name">write_records</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">records</span>)</span><br /> Write multiple record to the output file.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_records">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Bio.SeqIO.Interfaces.SequenceWriter-class.html">SequenceWriter</a></code></b>: <code><a href="Bio.SeqIO.Interfaces.SequenceWriter-class.html#clean">clean</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">handle</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.__init__">source code</a></span> </td> </tr></table> <p>Creates the writer object.</p> <p>Use the method write_file() to actually record your sequence records.</p> <dl class="fields"> <dt>Overrides: <a href="Bio.SeqIO.Interfaces.SequenceWriter-class.html#__init__">SequenceWriter.__init__</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="write_file"></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">write_file</span>(<span class="sig-arg">self</span>, <span class="sig-arg">records</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_file">source code</a></span> </td> </tr></table> <p>Use this to write an entire file containing the given records.</p> <p>records - A list or iterator returning SeqRecord objects</p> <p>This method can only be called once.</p> <dl class="fields"> <dt>Overrides: <a href="Bio.SeqIO.Interfaces.SequenceWriter-class.html#write_file">SequenceWriter.write_file</a> </dt> </dl> </td></tr></table> </div> <a name="write_record"></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">write_record</span>(<span class="sig-arg">self</span>, <span class="sig-arg">record</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_record">source code</a></span> </td> </tr></table> <p>Write a single record to the output file.</p> <p>record - a SeqRecord object</p> <p>Once you have called write_header() you can call write_record() and/or write_records() as many times as needed. Then call write_footer() and close().</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="write_records"></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">write_records</span>(<span class="sig-arg">self</span>, <span class="sig-arg">records</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.SeqIO.Interfaces-pysrc.html#SequentialSequenceWriter.write_records">source code</a></span> </td> </tr></table> <p>Write multiple record to the output file.</p> <p>records - A list or iterator returning SeqRecord objects</p> <p>Once you have called write_header() you can call write_record() and/or write_records() as many times as needed. Then call write_footer() and close().</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:38 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>