<?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>flumotion.manager.config.PlanetConfigParser</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"> Package flumotion :: <a href="flumotion.manager-module.html">Package manager</a> :: <a href="flumotion.manager.config-module.html">Module config</a> :: Class PlanetConfigParser </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> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class PlanetConfigParser</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser">source code</a></span></p> <pre class="base-tree"> <a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+ | <a href="flumotion.common.fxml.Parser-class.html">common.fxml.Parser</a> --+ | <a href="flumotion.common.config.BaseConfigParser-class.html">common.config.BaseConfigParser</a> --+ | <a href="flumotion.manager.config.FlumotionConfigParser-class.html">FlumotionConfigParser</a> --+ | <strong class="uidshort">PlanetConfigParser</strong> </pre> <hr /> <p>I represent a planet configuration file for Flumotion.</p> <!-- ==================== NESTED CLASSES ==================== --> <a name="section-NestedClasses"></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">Nested Classes</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-NestedClasses" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.config.BaseConfigParser-class.html">common.config.BaseConfigParser</a></code></b>: <code><a href="flumotion.common.errors.ConfigError-class.html">parserError</a></code> </p> </td> </tr> </table> <!-- ==================== 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="flumotion.manager.config.PlanetConfigParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">file</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser.__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="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser.parse">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="_parseAtmosphere"></a><span class="summary-sig-name">_parseAtmosphere</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">node</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser._parseAtmosphere">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="_parseFlow"></a><span class="summary-sig-name">_parseFlow</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">node</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser._parseFlow">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">dictionary of /parent/name -> <a href="flumotion.manager.config.ConfigEntryComponent-class.html" class="link">ConfigEntryComponent</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="getComponentEntries"></a><span class="summary-sig-name">getComponentEntries</span>(<span class="summary-sig-arg">self</span>)</span><br /> Get all component entries from both atmosphere and all flows from the configuration.</td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser.getComponentEntries">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="flumotion.manager.config.FlumotionConfigParser-class.html">FlumotionConfigParser</a></code></b>: <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html#parseComponent">parseComponent</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html">FlumotionConfigParser</a></code></b> (private): <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html#_parseEater" onclick="show_private();">_parseEater</a></code>, <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html#_parseFeed" onclick="show_private();">_parseFeed</a></code>, <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html#_parseFeedId" onclick="show_private();">_parseFeedId</a></code>, <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html#_parseSource" onclick="show_private();">_parseSource</a></code>, <code><a href="flumotion.manager.config.FlumotionConfigParser-class.html#_parseVirtualFeed" onclick="show_private();">_parseVirtualFeed</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.config.BaseConfigParser-class.html">common.config.BaseConfigParser</a></code></b>: <code><a href="flumotion.common.config.BaseConfigParser-class.html#add">add</a></code>, <code><a href="flumotion.common.config.BaseConfigParser-class.html#getPath">getPath</a></code>, <code><a href="flumotion.common.config.BaseConfigParser-class.html#parsePlugs">parsePlugs</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.config.BaseConfigParser-class.html">common.config.BaseConfigParser</a></code></b> (private): <code><a href="flumotion.common.config.BaseConfigParser-class.html#_parseCompoundProperty" onclick="show_private();">_parseCompoundProperty</a></code>, <code><a href="flumotion.common.config.BaseConfigParser-class.html#_parseProperty" onclick="show_private();">_parseProperty</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.common.fxml.Parser-class.html">common.fxml.Parser</a></code></b>: <code><a href="flumotion.common.fxml.Parser-class.html#checkAttributes">checkAttributes</a></code>, <code><a href="flumotion.common.fxml.Parser-class.html#getRoot">getRoot</a></code>, <code><a href="flumotion.common.fxml.Parser-class.html#parseAttributes">parseAttributes</a></code>, <code><a href="flumotion.common.fxml.Parser-class.html#parseFromTable">parseFromTable</a></code>, <code><a href="flumotion.common.fxml.Parser-class.html#parseTextNode">parseTextNode</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>: <code><a href="flumotion.extern.log.log.Loggable-class.html#debug">debug</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>, <code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></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">Class Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariables" 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="logCategory"></a><span class="summary-name">logCategory</span> = <code title="'config'">'config'</code><br /> Implementors can provide a category to log their messages under. </td> </tr> </table> <!-- ==================== INSTANCE VARIABLES ==================== --> <a name="section-InstanceVariables"></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 Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceVariables" 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="atmosphere"></a><span class="summary-name">atmosphere</span><br /> A <a href="flumotion.manager.config.ConfigEntryAtmosphere-class.html" class="link">ConfigEntryAtmosphere</a>, filled in when parse() is called. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="flows"></a><span class="summary-name">flows</span><br /> A list of <a href="flumotion.manager.config.ConfigEntryFlow-class.html" class="link">ConfigEntryFlow</a>, filled in when parse() is called. </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">file</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="flumotion.manager.config-pysrc.html#PlanetConfigParser.__init__">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>file</code></strong> - The file to parse, either as an open file object, or as the name of a file to open.</li> </ul></dd> <dt>Overrides: <a href="flumotion.common.config.BaseConfigParser-class.html#__init__">common.config.BaseConfigParser.__init__</a> <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 Sun Sep 13 13:14:15 2009 </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>