Moved getSidebarLinks to sitemap.sidebar
This is the fourth, and final patch, that attempts to
improve the cohesion in the base.View class.
Patch by: Sverre Rabbelier
<?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>graph.readwrite</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"> <!-- Home link --> <th> <a href="graph-module.html">Home</a> </th> <!-- 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> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://code.google.com/p/python-graph/">python-graph</a></th> </tr></table></th> </tr></table><table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="graph-module.html">Package graph</a> :: Module readwrite </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> </table> </td> </tr></table><!-- ==================== MODULE DESCRIPTION ==================== --><h1 class="epydoc">Module readwrite</h1><p class="nomargin-top"></p><p>Functions for reading and writing graphs.</p><!-- ==================== 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 align="left" colspan="2" class="table-header"> <span class="table-header">Functions</span></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="graph.readwrite-module.html#read_xml" class="summary-sig-name">read_xml</a>(<span class="summary-sig-arg">graph</span>, <span class="summary-sig-arg">string</span>)</span><br /> Read a graph from a XML document.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr><tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_xml" class="summary-sig-name">write_xml</a>(<span class="summary-sig-arg">graph</span>)</span><br /> Return a string specifying the given graph as a XML document.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr><tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_dot_graph" class="summary-sig-name">write_dot_graph</a>(<span class="summary-sig-arg">graph</span>, <span class="summary-sig-arg">wt</span>)</span><br /> Return a string specifying the given graph in DOT Language.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr><tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_dot_digraph" class="summary-sig-name">write_dot_digraph</a>(<span class="summary-sig-arg">graph</span>, <span class="summary-sig-arg">wt</span>)</span><br /> Return a string specifying the given digraph in DOT Language.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr><tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_dot_hypergraph" class="summary-sig-name">write_dot_hypergraph</a>(<span class="summary-sig-arg">hypergraph</span>, <span class="summary-sig-arg">coloured</span>=<span class="summary-sig-default">False</span>)</span><br /> Return a string specifying the given hypergraph in DOT Language.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr><tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="graph.readwrite-module.html#write_xml_hypergraph" class="summary-sig-name">write_xml_hypergraph</a>(<span class="summary-sig-arg">hypergraph</span>)</span><br /> Return a string specifying the given hypergraph as a XML document.</td> <td align="right" valign="top"> </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="graph.readwrite-module.html#read_xml_hypergraph" class="summary-sig-name">read_xml_hypergraph</a>(<span class="summary-sig-arg">hypergraph</span>, <span class="summary-sig-arg">string</span>)</span><br /> Read a graph from a XML document.</td> <td align="right" valign="top"> </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 align="left" colspan="2" class="table-header"> <span class="table-header">Variables</span></td></tr><tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="graph.readwrite-module.html#colors" class="summary-name">colors</a> = <code title="['aquamarine4', 'blue4', 'brown4', 'cornflowerblue', 'cyan4', 'darkgreen', 'darkorange3', 'darkorchid4',..."><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">aquamarine4</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">blue4</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">brown4</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">cornflowerblue</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-ellipsis">...</code></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 align="left" colspan="2" class="table-header"> <span class="table-header">Function Details</span></td></tr></table><a name="read_xml"></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">read_xml</span>(<span class="sig-arg">graph</span>, <span class="sig-arg">string</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Read a graph from a XML document. Nodes and edges specified in the input will be added to the current graph.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>graph</code></strong> (graph) - Graph</li> <li><strong class="pname"><code>string</code></strong> (string) - Input string in XML format specifying a graph.</li> </ul></dd> </dl></td></tr></table></div><a name="write_xml"></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_xml</span>(<span class="sig-arg">graph</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a string specifying the given graph as a XML document.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>graph</code></strong> (graph) - Graph.</li> </ul></dd> <dt>Returns: string</dt> <dd>String specifying the graph as a XML document.</dd> </dl></td></tr></table></div><a name="write_dot_graph"></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_dot_graph</span>(<span class="sig-arg">graph</span>, <span class="sig-arg">wt</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a string specifying the given graph in DOT Language.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>graph</code></strong> (graph) - Graph.</li> <li><strong class="pname"><code>wt</code></strong> (boolean) - Whether edges should be labelled with its weight.</li> </ul></dd> <dt>Returns: string</dt> <dd>String specifying the graph in DOT Language.</dd> </dl></td></tr></table></div><a name="write_dot_digraph"></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_dot_digraph</span>(<span class="sig-arg">graph</span>, <span class="sig-arg">wt</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a string specifying the given digraph in DOT Language.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>graph</code></strong> (graph) - Graph.</li> <li><strong class="pname"><code>wt</code></strong> (boolean) - Whether arrows should be labelled with its weight.</li> </ul></dd> <dt>Returns: string</dt> <dd>String specifying the graph in DOT Language.</dd> </dl></td></tr></table></div><a name="write_dot_hypergraph"></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_dot_hypergraph</span>(<span class="sig-arg">hypergraph</span>, <span class="sig-arg">coloured</span>=<span class="sig-default">False</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a string specifying the given hypergraph in DOT Language.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>hypergraph</code></strong> (hypergraph) - Hypergraph.</li> <li><strong class="pname"><code>coloured</code></strong> (boolean) - Whether hyperedges should be coloured.</li> </ul></dd> <dt>Returns: string</dt> <dd>String specifying the hypergraph in DOT Language.</dd> </dl></td></tr></table></div><a name="write_xml_hypergraph"></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_xml_hypergraph</span>(<span class="sig-arg">hypergraph</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Return a string specifying the given hypergraph as a XML document.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>hypergraph</code></strong> (hypergraph) - Hypergraph.</li> </ul></dd> <dt>Returns: string</dt> <dd>String specifying the graph as a XML document.</dd> </dl></td></tr></table></div><a name="read_xml_hypergraph"></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">read_xml_hypergraph</span>(<span class="sig-arg">hypergraph</span>, <span class="sig-arg">string</span>)</span> </h3> </td><td align="right" valign="top" > </td> </tr></table> <p>Read a graph from a XML document. Nodes and hyperedges specified in the input will be added to the current graph.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>hypergraph</code></strong> (hypergraph) - Hypergraph</li> <li><strong class="pname"><code>string</code></strong> (string) - Input string in XML format specifying a graph.</li> </ul></dd> </dl></td></tr></table></div><br /><!-- ==================== VARIABLES DETAILS ==================== --><a name="section-VariablesDetails"></a><table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"><tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Variables Details</span></td></tr></table><a name="colors"></a><div><table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"><tr><td> <h3 class="epydoc">colors</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">aquamarine4</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">blue4</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">brown4</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">cornflowerblue</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">cyan4</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">darkgreen</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">darkorange3</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">darkorchid4</code><code class="variable-quote">'</code><code class="variable-op">,</code><code class="variable-ellipsis">...</code></pre></td></tr></table></dd> </dl></td></tr></table></div><br /><!-- ==================== NAVIGATION BAR ==================== --><table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="graph-module.html">Home</a> </th> <!-- 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> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://code.google.com/p/python-graph/">python-graph</a></th> </tr></table></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 Oct 27 20:36:37 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>