~openerp-commiter/openobject-addons/stable-sja-branch

« back to all changes in this revision

Viewing changes to etl/doc/etl.component.output.csv_out.csv_out-class.html

  • Committer: sja-axelor
  • Date: 2009-10-13 09:52:57 UTC
  • Revision ID: suniljagyasi@gmail.com-20091013095257-8u26ww0r20z9y6ey
add

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>etl.component.output.csv_out.csv_out</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
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="etl-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
      <th class="navbar" width="100%"></th>
 
34
  </tr>
 
35
</table>
 
36
<table width="100%" cellpadding="0" cellspacing="0">
 
37
  <tr valign="top">
 
38
    <td width="100%">
 
39
      <span class="breadcrumbs">
 
40
        etl ::
 
41
        component ::
 
42
        output ::
 
43
        csv_out ::
 
44
        csv_out ::
 
45
        Class&nbsp;csv_out
 
46
      </span>
 
47
    </td>
 
48
    <td>
 
49
      <table cellpadding="0" cellspacing="0">
 
50
        <!-- hide/show private -->
 
51
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 
52
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 
53
        <tr><td align="right"><span class="options"
 
54
            >[<a href="frames.html" target="_top">frames</a
 
55
            >]&nbsp;|&nbsp;<a href="etl.component.output.csv_out.csv_out-class.html"
 
56
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
57
      </table>
 
58
    </td>
 
59
  </tr>
 
60
</table>
 
61
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
62
<h1 class="epydoc">Class csv_out</h1><span class="codelink"><a href="etl.component.output.csv_out-pysrc.html#csv_out">source&nbsp;code</a></span><br /><br />
 
63
<pre class="base-tree">
 
64
etl.component.component --+
 
65
                          |
 
66
                         <strong class="uidshort">csv_out</strong>
 
67
</pre>
 
68
 
 
69
<hr />
 
70
<p>This is an ETL Component that writes data to csv file.</p>
 
71
  Type                   : Data Component. Computing Performance  : 
 
72
  Streamline. Input Flows            : 0-x. * .*                   : The 
 
73
  main data flow with input data. Output Flows           : 0-1. * main
 
74
  : Return all data.<br /><br />
 
75
 
 
76
<!-- ==================== INSTANCE METHODS ==================== -->
 
77
<a name="section-InstanceMethods"></a>
 
78
<table class="summary" border="1" cellpadding="3"
 
79
       cellspacing="0" width="100%" bgcolor="white">
 
80
<tr bgcolor="#70b0f0" class="table-header">
 
81
  <td colspan="2" class="table-header">
 
82
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
83
      <tr valign="top">
 
84
        <td align="left"><span class="table-header">Instance Methods</span></td>
 
85
        <td align="right" valign="top"
 
86
         ><span class="options">[<a href="#section-InstanceMethods"
 
87
         class="privatelink" onclick="toggle_private();"
 
88
         >hide private</a>]</span></td>
 
89
      </tr>
 
90
    </table>
 
91
  </td>
 
92
</tr>
 
93
<tr>
 
94
    <td width="15%" align="right" valign="top" class="summary">
 
95
      <span class="summary-type">&nbsp;</span>
 
96
    </td><td class="summary">
 
97
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
98
        <tr>
 
99
          <td><span class="summary-sig"><a href="etl.component.output.csv_out.csv_out-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 
100
        <span class="summary-sig-arg">fileconnector</span>,
 
101
        <span class="summary-sig-arg">csv_params</span>=<span class="summary-sig-default">{}</span>,
 
102
        <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">'component.output.csv_out'</span>,
 
103
        <span class="summary-sig-arg">transformer</span>=<span class="summary-sig-default">None</span>,
 
104
        <span class="summary-sig-arg">row_limit</span>=<span class="summary-sig-default">0</span>)</span><br />
 
105
      Required  Parameters fileconnector   :  Localfile connector.</td>
 
106
          <td align="right" valign="top">
 
107
            <span class="codelink"><a href="etl.component.output.csv_out-pysrc.html#csv_out.__init__">source&nbsp;code</a></span>
 
108
            
 
109
          </td>
 
110
        </tr>
 
111
      </table>
 
112
      
 
113
    </td>
 
114
  </tr>
 
115
<tr>
 
116
    <td width="15%" align="right" valign="top" class="summary">
 
117
      <span class="summary-type">&nbsp;</span>
 
118
    </td><td class="summary">
 
119
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
120
        <tr>
 
121
          <td><span class="summary-sig"><a name="__copy__"></a><span class="summary-sig-name">__copy__</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
122
          <td align="right" valign="top">
 
123
            <span class="codelink"><a href="etl.component.output.csv_out-pysrc.html#csv_out.__copy__">source&nbsp;code</a></span>
 
124
            
 
125
          </td>
 
126
        </tr>
 
127
      </table>
 
128
      
 
129
    </td>
 
130
  </tr>
 
131
<tr>
 
132
    <td width="15%" align="right" valign="top" class="summary">
 
133
      <span class="summary-type">&nbsp;</span>
 
134
    </td><td class="summary">
 
135
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
136
        <tr>
 
137
          <td><span class="summary-sig"><a name="end"></a><span class="summary-sig-name">end</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
138
          <td align="right" valign="top">
 
139
            <span class="codelink"><a href="etl.component.output.csv_out-pysrc.html#csv_out.end">source&nbsp;code</a></span>
 
140
            
 
141
          </td>
 
142
        </tr>
 
143
      </table>
 
144
      
 
145
    </td>
 
146
  </tr>
 
147
<tr>
 
148
    <td width="15%" align="right" valign="top" class="summary">
 
149
      <span class="summary-type">&nbsp;</span>
 
150
    </td><td class="summary">
 
151
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
152
        <tr>
 
153
          <td><span class="summary-sig"><a name="process"></a><span class="summary-sig-name">process</span>(<span class="summary-sig-arg">self</span>)</span></td>
 
154
          <td align="right" valign="top">
 
155
            <span class="codelink"><a href="etl.component.output.csv_out-pysrc.html#csv_out.process">source&nbsp;code</a></span>
 
156
            
 
157
          </td>
 
158
        </tr>
 
159
      </table>
 
160
      
 
161
    </td>
 
162
  </tr>
 
163
</table>
 
164
<!-- ==================== METHOD DETAILS ==================== -->
 
165
<a name="section-MethodDetails"></a>
 
166
<table class="details" border="1" cellpadding="3"
 
167
       cellspacing="0" width="100%" bgcolor="white">
 
168
<tr bgcolor="#70b0f0" class="table-header">
 
169
  <td colspan="2" class="table-header">
 
170
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 
171
      <tr valign="top">
 
172
        <td align="left"><span class="table-header">Method Details</span></td>
 
173
        <td align="right" valign="top"
 
174
         ><span class="options">[<a href="#section-MethodDetails"
 
175
         class="privatelink" onclick="toggle_private();"
 
176
         >hide private</a>]</span></td>
 
177
      </tr>
 
178
    </table>
 
179
  </td>
 
180
</tr>
 
181
</table>
 
182
<a name="__init__"></a>
 
183
<div>
 
184
<table class="details" border="1" cellpadding="3"
 
185
       cellspacing="0" width="100%" bgcolor="white">
 
186
<tr><td>
 
187
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
188
  <tr valign="top"><td>
 
189
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
190
        <span class="sig-arg">fileconnector</span>,
 
191
        <span class="sig-arg">csv_params</span>=<span class="sig-default">{}</span>,
 
192
        <span class="sig-arg">name</span>=<span class="sig-default">'component.output.csv_out'</span>,
 
193
        <span class="sig-arg">transformer</span>=<span class="sig-default">None</span>,
 
194
        <span class="sig-arg">row_limit</span>=<span class="sig-default">0</span>)</span>
 
195
    <br /><em class="fname">(Constructor)</em>
 
196
  </h3>
 
197
  </td><td align="right" valign="top"
 
198
    ><span class="codelink"><a href="etl.component.output.csv_out-pysrc.html#csv_out.__init__">source&nbsp;code</a></span>&nbsp;
 
199
    </td>
 
200
  </table>
 
201
  
 
202
  <p>Required  Parameters fileconnector   :  Localfile connector.</p>
 
203
  Extra Parameters name            : Name of Component. transformer     
 
204
  : Transformer object to transform string data into  particular object. 
 
205
  row_limit       : Limited records are sent to destination if row limit is
 
206
  specified. If row limit is 0, all records are sent. csv_param       : To 
 
207
  specify other csv parameter like fieldnames , restkey , restval etc.
 
208
  <dl class="fields">
 
209
  </dl>
 
210
</td></tr></table>
 
211
</div>
 
212
<br />
 
213
<!-- ==================== NAVIGATION BAR ==================== -->
 
214
<table class="navbar" border="0" width="100%" cellpadding="0"
 
215
       bgcolor="#a0c0ff" cellspacing="0">
 
216
  <tr valign="middle">
 
217
  <!-- Home link -->
 
218
      <th>&nbsp;&nbsp;&nbsp;<a
 
219
        href="etl-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
220
 
 
221
  <!-- Tree link -->
 
222
      <th>&nbsp;&nbsp;&nbsp;<a
 
223
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
224
 
 
225
  <!-- Index link -->
 
226
      <th>&nbsp;&nbsp;&nbsp;<a
 
227
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
228
 
 
229
  <!-- Help link -->
 
230
      <th>&nbsp;&nbsp;&nbsp;<a
 
231
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
232
 
 
233
      <th class="navbar" width="100%"></th>
 
234
  </tr>
 
235
</table>
 
236
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
237
  <tr>
 
238
    <td align="left" class="footer">
 
239
    Generated by Epydoc 3.0beta1 on Wed Apr 29 20:27:00 2009
 
240
    </td>
 
241
    <td align="right" class="footer">
 
242
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
243
    </td>
 
244
  </tr>
 
245
</table>
 
246
 
 
247
<script type="text/javascript">
 
248
  <!--
 
249
  // Private objects are initially displayed (because if
 
250
  // javascript is turned off then we want them to be
 
251
  // visible); but by default, we want to hide them.  So hide
 
252
  // them unless we have a cookie that says to show them.
 
253
  checkCookie()
 
254
  // -->
 
255
</script>
 
256
  
 
257
</body>
 
258
</html>