doc/api/python/configuration_model.DataModel-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>configuration_model.DataModel</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="configuration_model-module.html">Module&nbsp;configuration_model</a> ::
       
    38         Class&nbsp;DataModel
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="configuration_model.DataModel-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class DataModel</h1><span class="codelink"><a href="configuration_model-pysrc.html#DataModel">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 object --+
       
    58          |
       
    59         <strong class="uidshort">DataModel</strong>
       
    60 </pre>
       
    61 
       
    62 <hr />
       
    63 A model of the configuration properties.<br /><br />
       
    64 
       
    65 <!-- ==================== INSTANCE METHODS ==================== -->
       
    66 <a name="section-InstanceMethods"></a>
       
    67 <table class="summary" border="1" cellpadding="3"
       
    68        cellspacing="0" width="100%" bgcolor="white">
       
    69 <tr bgcolor="#70b0f0" class="table-header">
       
    70   <td colspan="2" class="table-header">
       
    71     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    72       <tr valign="top">
       
    73         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    74         <td align="right" valign="top"
       
    75          ><span class="options">[<a href="#section-InstanceMethods"
       
    76          class="privatelink" onclick="toggle_private();"
       
    77          >hide private</a>]</span></td>
       
    78       </tr>
       
    79     </table>
       
    80   </td>
       
    81 </tr>
       
    82 <tr>
       
    83     <td width="15%" align="right" valign="top" class="summary">
       
    84       <span class="summary-type">&nbsp;</span>
       
    85     </td><td class="summary">
       
    86       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    87         <tr>
       
    88           <td><span class="summary-sig"><a href="configuration_model.DataModel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    89         <span class="summary-sig-arg">modelpath</span>)</span><br />
       
    90       Initialization.</td>
       
    91           <td align="right" valign="top">
       
    92             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel.__init__">source&nbsp;code</a></span>
       
    93             
       
    94           </td>
       
    95         </tr>
       
    96       </table>
       
    97       
       
    98     </td>
       
    99   </tr>
       
   100 <tr>
       
   101     <td width="15%" align="right" valign="top" class="summary">
       
   102       <span class="summary-type">&nbsp;</span>
       
   103     </td><td class="summary">
       
   104       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   105         <tr>
       
   106           <td><span class="summary-sig"><a name="validate_config"></a><span class="summary-sig-name">validate_config</span>(<span class="summary-sig-arg">self</span>,
       
   107         <span class="summary-sig-arg">config</span>)</span><br />
       
   108       Validate the Ant configuration against the model.</td>
       
   109           <td align="right" valign="top">
       
   110             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel.validate_config">source&nbsp;code</a></span>
       
   111             
       
   112           </td>
       
   113         </tr>
       
   114       </table>
       
   115       
       
   116     </td>
       
   117   </tr>
       
   118 <tr>
       
   119     <td width="15%" align="right" valign="top" class="summary">
       
   120       <span class="summary-type">&nbsp;</span>
       
   121     </td><td class="summary">
       
   122       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   123         <tr>
       
   124           <td><span class="summary-sig"><a name="validate_config_at_startup"></a><span class="summary-sig-name">validate_config_at_startup</span>(<span class="summary-sig-arg">self</span>,
       
   125         <span class="summary-sig-arg">config</span>)</span><br />
       
   126       Validate the Ant configuration against the model at build startup.</td>
       
   127           <td align="right" valign="top">
       
   128             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel.validate_config_at_startup">source&nbsp;code</a></span>
       
   129             
       
   130           </td>
       
   131         </tr>
       
   132       </table>
       
   133       
       
   134     </td>
       
   135   </tr>
       
   136 <tr class="private">
       
   137     <td width="15%" align="right" valign="top" class="summary">
       
   138       <span class="summary-type">&nbsp;</span>
       
   139     </td><td class="summary">
       
   140       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   141         <tr>
       
   142           <td><span class="summary-sig"><a name="_check_deprecated_properties"></a><span class="summary-sig-name">_check_deprecated_properties</span>(<span class="summary-sig-arg">self</span>,
       
   143         <span class="summary-sig-arg">config</span>,
       
   144         <span class="summary-sig-arg">items</span>)</span><br />
       
   145       Check that deprecated properties not being used.</td>
       
   146           <td align="right" valign="top">
       
   147             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel._check_deprecated_properties">source&nbsp;code</a></span>
       
   148             
       
   149           </td>
       
   150         </tr>
       
   151       </table>
       
   152       
       
   153     </td>
       
   154   </tr>
       
   155 <tr class="private">
       
   156     <td width="15%" align="right" valign="top" class="summary">
       
   157       <span class="summary-type">&nbsp;</span>
       
   158     </td><td class="summary">
       
   159       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   160         <tr>
       
   161           <td><span class="summary-sig"><a name="_check_undefined_properties"></a><span class="summary-sig-name">_check_undefined_properties</span>(<span class="summary-sig-arg">self</span>,
       
   162         <span class="summary-sig-arg">config</span>,
       
   163         <span class="summary-sig-arg">items</span>)</span><br />
       
   164       Check for any defined properties that are not in the model.</td>
       
   165           <td align="right" valign="top">
       
   166             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel._check_undefined_properties">source&nbsp;code</a></span>
       
   167             
       
   168           </td>
       
   169         </tr>
       
   170       </table>
       
   171       
       
   172     </td>
       
   173   </tr>
       
   174 <tr class="private">
       
   175     <td width="15%" align="right" valign="top" class="summary">
       
   176       <span class="summary-type">&nbsp;</span>
       
   177     </td><td class="summary">
       
   178       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   179         <tr>
       
   180           <td><span class="summary-sig"><a name="_check_undefined_properties_in_groups"></a><span class="summary-sig-name">_check_undefined_properties_in_groups</span>(<span class="summary-sig-arg">self</span>,
       
   181         <span class="summary-sig-arg">config</span>,
       
   182         <span class="summary-sig-arg">items</span>)</span></td>
       
   183           <td align="right" valign="top">
       
   184             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel._check_undefined_properties_in_groups">source&nbsp;code</a></span>
       
   185             
       
   186           </td>
       
   187         </tr>
       
   188       </table>
       
   189       
       
   190     </td>
       
   191   </tr>
       
   192 <tr class="private">
       
   193     <td width="15%" align="right" valign="top" class="summary">
       
   194       <span class="summary-type">&nbsp;</span>
       
   195     </td><td class="summary">
       
   196       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   197         <tr>
       
   198           <td><span class="summary-sig"><a name="_check_defined_properties_not_in_groups"></a><span class="summary-sig-name">_check_defined_properties_not_in_groups</span>(<span class="summary-sig-arg">self</span>,
       
   199         <span class="summary-sig-arg">config</span>,
       
   200         <span class="summary-sig-arg">items</span>)</span></td>
       
   201           <td align="right" valign="top">
       
   202             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel._check_defined_properties_not_in_groups">source&nbsp;code</a></span>
       
   203             
       
   204           </td>
       
   205         </tr>
       
   206       </table>
       
   207       
       
   208     </td>
       
   209   </tr>
       
   210 <tr class="private">
       
   211     <td width="15%" align="right" valign="top" class="summary">
       
   212       <span class="summary-type">&nbsp;</span>
       
   213     </td><td class="summary">
       
   214       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   215         <tr>
       
   216           <td><span class="summary-sig"><a name="_check_type_validation"></a><span class="summary-sig-name">_check_type_validation</span>(<span class="summary-sig-arg">self</span>,
       
   217         <span class="summary-sig-arg">config</span>,
       
   218         <span class="summary-sig-arg">items</span>)</span></td>
       
   219           <td align="right" valign="top">
       
   220             <span class="codelink"><a href="configuration_model-pysrc.html#DataModel._check_type_validation">source&nbsp;code</a></span>
       
   221             
       
   222           </td>
       
   223         </tr>
       
   224       </table>
       
   225       
       
   226     </td>
       
   227   </tr>
       
   228   <tr>
       
   229     <td colspan="2" class="summary">
       
   230     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   231       <code>__delattr__</code>,
       
   232       <code>__getattribute__</code>,
       
   233       <code>__hash__</code>,
       
   234       <code>__new__</code>,
       
   235       <code>__reduce__</code>,
       
   236       <code>__reduce_ex__</code>,
       
   237       <code>__repr__</code>,
       
   238       <code>__setattr__</code>,
       
   239       <code>__str__</code>
       
   240       </p>
       
   241     </td>
       
   242   </tr>
       
   243 </table>
       
   244 <!-- ==================== PROPERTIES ==================== -->
       
   245 <a name="section-Properties"></a>
       
   246 <table class="summary" border="1" cellpadding="3"
       
   247        cellspacing="0" width="100%" bgcolor="white">
       
   248 <tr bgcolor="#70b0f0" class="table-header">
       
   249   <td colspan="2" class="table-header">
       
   250     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   251       <tr valign="top">
       
   252         <td align="left"><span class="table-header">Properties</span></td>
       
   253         <td align="right" valign="top"
       
   254          ><span class="options">[<a href="#section-Properties"
       
   255          class="privatelink" onclick="toggle_private();"
       
   256          >hide private</a>]</span></td>
       
   257       </tr>
       
   258     </table>
       
   259   </td>
       
   260 </tr>
       
   261   <tr>
       
   262     <td colspan="2" class="summary">
       
   263     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   264       <code>__class__</code>
       
   265       </p>
       
   266     </td>
       
   267   </tr>
       
   268 </table>
       
   269 <!-- ==================== METHOD DETAILS ==================== -->
       
   270 <a name="section-MethodDetails"></a>
       
   271 <table class="details" border="1" cellpadding="3"
       
   272        cellspacing="0" width="100%" bgcolor="white">
       
   273 <tr bgcolor="#70b0f0" class="table-header">
       
   274   <td colspan="2" class="table-header">
       
   275     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   276       <tr valign="top">
       
   277         <td align="left"><span class="table-header">Method Details</span></td>
       
   278         <td align="right" valign="top"
       
   279          ><span class="options">[<a href="#section-MethodDetails"
       
   280          class="privatelink" onclick="toggle_private();"
       
   281          >hide private</a>]</span></td>
       
   282       </tr>
       
   283     </table>
       
   284   </td>
       
   285 </tr>
       
   286 </table>
       
   287 <a name="__init__"></a>
       
   288 <div>
       
   289 <table class="details" border="1" cellpadding="3"
       
   290        cellspacing="0" width="100%" bgcolor="white">
       
   291 <tr><td>
       
   292   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   293   <tr valign="top"><td>
       
   294   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   295         <span class="sig-arg">modelpath</span>)</span>
       
   296     <br /><em class="fname">(Constructor)</em>
       
   297   </h3>
       
   298   </td><td align="right" valign="top"
       
   299     ><span class="codelink"><a href="configuration_model-pysrc.html#DataModel.__init__">source&nbsp;code</a></span>&nbsp;
       
   300     </td>
       
   301   </table>
       
   302   
       
   303   Initialization.
       
   304   <dl class="fields">
       
   305     <dt>Overrides:
       
   306       object.__init__
       
   307     </dt>
       
   308   </dl>
       
   309 </td></tr></table>
       
   310 </div>
       
   311 <br />
       
   312 <!-- ==================== NAVIGATION BAR ==================== -->
       
   313 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   314        bgcolor="#a0c0ff" cellspacing="0">
       
   315   <tr valign="middle">
       
   316 
       
   317   <!-- Tree link -->
       
   318       <th>&nbsp;&nbsp;&nbsp;<a
       
   319         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   320 
       
   321   <!-- Index link -->
       
   322       <th>&nbsp;&nbsp;&nbsp;<a
       
   323         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   324 
       
   325   <!-- Help link -->
       
   326       <th>&nbsp;&nbsp;&nbsp;<a
       
   327         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   328 
       
   329       <th class="navbar" width="100%"></th>
       
   330   </tr>
       
   331 </table>
       
   332 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   333   <tr>
       
   334     <td align="left" class="footer">
       
   335     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009
       
   336     </td>
       
   337     <td align="right" class="footer">
       
   338       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   339     </td>
       
   340   </tr>
       
   341 </table>
       
   342 
       
   343 <script type="text/javascript">
       
   344   <!--
       
   345   // Private objects are initially displayed (because if
       
   346   // javascript is turned off then we want them to be
       
   347   // visible); but by default, we want to hide them.  So hide
       
   348   // them unless we have a cookie that says to show them.
       
   349   checkCookie()
       
   350   // -->
       
   351 </script>
       
   352   
       
   353 </body>
       
   354 </html>