|
18
|
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>commons.IComponentWrapper</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> <a
|
|
|
20 href="module-tree.html">Trees</a> </th>
|
|
|
21
|
|
|
22 <!-- Index link -->
|
|
|
23 <th> <a
|
|
|
24 href="identifier-index.html">Indices</a> </th>
|
|
|
25
|
|
|
26 <!-- Help link -->
|
|
|
27 <th> <a
|
|
|
28 href="help.html">Help</a> </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 Package commons ::
|
|
|
38 Module IComponentWrapper
|
|
|
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 private</a>]</span></td></tr>
|
|
|
46 <tr><td align="right"><span class="options"
|
|
|
47 >[<a href="frames.html" target="_top">frames</a
|
|
|
48 >] | <a href="commons.IComponentWrapper-pysrc.html"
|
|
|
49 target="_top">no frames</a>]</span></td></tr>
|
|
|
50 </table>
|
|
|
51 </td>
|
|
|
52 </tr>
|
|
|
53 </table>
|
|
|
54 <h1 class="epydoc">Source Code for <a href="commons.IComponentWrapper-module.html">Module commons.IComponentWrapper</a></h1>
|
|
|
55 <pre class="py-src">
|
|
|
56 <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"> </tt>
|
|
|
57 <a name="IComponentWrapper"></a><div id="IComponentWrapper-def"><a name="L2"></a><tt class="py-lineno"> 2</tt> <a class="py-toggle" href="#" id="IComponentWrapper-toggle" onclick="return toggle('IComponentWrapper');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html">IComponentWrapper</a><tt class="py-op">:</tt> </tt>
|
|
|
58 </div><div id="IComponentWrapper-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="IComponentWrapper-expanded"><a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
|
59 <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring"> A interface wrapper for all pipelines component</tt> </tt>
|
|
|
60 <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
|
61 <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"> </tt>
|
|
|
62 <a name="IComponentWrapper.run"></a><div id="IComponentWrapper.run-def"><a name="L7"></a><tt class="py-lineno"> 7</tt> <a class="py-toggle" href="#" id="IComponentWrapper.run-toggle" onclick="return toggle('IComponentWrapper.run');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#run">run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
|
63 </div><div id="IComponentWrapper.run-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.run-expanded"><a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
|
64 <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> run the component</tt> </tt>
|
|
|
65 <a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
|
66 <a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
|
67 </div><a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"> </tt>
|
|
|
68 <a name="IComponentWrapper.loadConfig"></a><div id="IComponentWrapper.loadConfig-def"><a name="L13"></a><tt class="py-lineno">13</tt> <a class="py-toggle" href="#" id="IComponentWrapper.loadConfig-toggle" onclick="return toggle('IComponentWrapper.loadConfig');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#loadConfig">loadConfig</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">configParserInstance</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
|
69 </div><div id="IComponentWrapper.loadConfig-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.loadConfig-expanded"><a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
|
70 <a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring"> load component config</tt> </tt>
|
|
|
71 <a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
|
|
|
72 <a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-docstring"> @param configParserInstance: config parser where config file is loaded</tt> </tt>
|
|
|
73 <a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-docstring"> @type configParserInstance: class ConfigParser</tt> </tt>
|
|
|
74 <a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
|
75 <a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
|
76 </div><a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"> </tt>
|
|
|
77 <a name="IComponentWrapper.clean"></a><div id="IComponentWrapper.clean-def"><a name="L22"></a><tt class="py-lineno">22</tt> <a class="py-toggle" href="#" id="IComponentWrapper.clean-toggle" onclick="return toggle('IComponentWrapper.clean');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#clean">clean</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
|
78 </div><div id="IComponentWrapper.clean-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.clean-expanded"><a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
|
79 <a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-docstring"> clean files generated by run method</tt> </tt>
|
|
|
80 <a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
|
81 <a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
|
|
|
82 </div><a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"> </tt>
|
|
|
83 <a name="IComponentWrapper.getComponent"></a><div id="IComponentWrapper.getComponent-def"><a name="L28"></a><tt class="py-lineno">28</tt> <a class="py-toggle" href="#" id="IComponentWrapper.getComponent-toggle" onclick="return toggle('IComponentWrapper.getComponent');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#getComponent">getComponent</a> <tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
|
|
|
84 </div><div id="IComponentWrapper.getComponent-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.getComponent-expanded"><a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
|
|
|
85 <a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring"> return component wrapped</tt> </tt>
|
|
|
86 <a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
|
|
|
87 </div></div><a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"> </tt><script type="text/javascript">
|
|
|
88 <!--
|
|
|
89 expandto(location.href);
|
|
|
90 // -->
|
|
|
91 </script>
|
|
|
92 </pre>
|
|
|
93 <br />
|
|
|
94 <!-- ==================== NAVIGATION BAR ==================== -->
|
|
|
95 <table class="navbar" border="0" width="100%" cellpadding="0"
|
|
|
96 bgcolor="#a0c0ff" cellspacing="0">
|
|
|
97 <tr valign="middle">
|
|
|
98
|
|
|
99 <!-- Tree link -->
|
|
|
100 <th> <a
|
|
|
101 href="module-tree.html">Trees</a> </th>
|
|
|
102
|
|
|
103 <!-- Index link -->
|
|
|
104 <th> <a
|
|
|
105 href="identifier-index.html">Indices</a> </th>
|
|
|
106
|
|
|
107 <!-- Help link -->
|
|
|
108 <th> <a
|
|
|
109 href="help.html">Help</a> </th>
|
|
|
110
|
|
|
111 <th class="navbar" width="100%"></th>
|
|
|
112 </tr>
|
|
|
113 </table>
|
|
|
114 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
|
115 <tr>
|
|
|
116 <td align="left" class="footer">
|
|
|
117 Generated by Epydoc 3.0.1 on Fri Apr 10 16:39:01 2009
|
|
|
118 </td>
|
|
|
119 <td align="right" class="footer">
|
|
|
120 <a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
|
121 >http://epydoc.sourceforge.net</a>
|
|
|
122 </td>
|
|
|
123 </tr>
|
|
|
124 </table>
|
|
|
125
|
|
|
126 <script type="text/javascript">
|
|
|
127 <!--
|
|
|
128 // Private objects are initially displayed (because if
|
|
|
129 // javascript is turned off then we want them to be
|
|
|
130 // visible); but by default, we want to hide them. So hide
|
|
|
131 // them unless we have a cookie that says to show them.
|
|
|
132 checkCookie();
|
|
|
133 // -->
|
|
|
134 </script>
|
|
|
135 </body>
|
|
|
136 </html>
|
