doc/classes/MCollective/Generators/DataGenerator.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Class: MCollective::Generators::DataGenerator</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Class</strong></td>
  53           <td class="class-name-in-header">MCollective::Generators::DataGenerator</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../../files/lib/mcollective/generators/data_generator_rb.html">
  59                 lib/mcollective/generators/data_generator.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         <tr class="top-aligned-row">
  66             <td><strong>Parent:</strong></td>
  67             <td>
  68                 <a href="Base.html">
  69                 Base
  70                </a>
  71             </td>
  72         </tr>
  73         </table>
  74     </div>
  75   <!-- banner header -->
  76
  77   <div id="bodyContent">
  78
  79
  80
  81   <div id="contextContent">
  82
  83
  84
  85    </div>
  86
  87     <div id="method-list">
  88       <h3 class="section-bar">Methods</h3>
  89
  90       <div class="name-list">
  91       <a href="#M000254">create_ddl</a>&nbsp;&nbsp;
  92       <a href="#M000255">create_plugin_content</a>&nbsp;&nbsp;
  93       <a href="#M000253">new</a>&nbsp;&nbsp;
  94       </div>
  95     </div>
  96
  97   </div>
  98
  99
 100     <!-- if includes -->
 101
 102     <div id="section">
 103
 104
 105
 106
 107
 108     <div id="attribute-list">
 109       <h3 class="section-bar">Attributes</h3>
 110
 111       <div class="name-list">
 112         <table>
 113         <tr class="top-aligned-row context-row">
 114           <td class="context-item-name">content</td>
 115           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 116           <td class="context-item-desc"></td>
 117         </tr>
 118         <tr class="top-aligned-row context-row">
 119           <td class="context-item-name">ddl</td>
 120           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 121           <td class="context-item-desc"></td>
 122         </tr>
 123         </table>
 124       </div>
 125     </div>
 126
 127
 128
 129     <!-- if method_list -->
 130     <div id="methods">
 131       <h3 class="section-bar">Public Class methods</h3>
 132
 133       <div id="method-M000253" class="method-detail">
 134         <a name="M000253"></a>
 135
 136         <div class="method-heading">
 137           <a href="#M000253" class="method-signature">
 138           <span class="method-name">new</span><span class="method-args">(plugin_name, outputs = [], name = nil, description = nil, author = nil , license = nil, version = nil, url = nil, timeout = nil)</span>
 139           </a>
 140         </div>
 141
 142         <div class="method-description">
 143           <p><a class="source-toggle" href="#"
 144             onclick="toggleCode('M000253-source');return false;">[Source]</a></p>
 145           <div class="method-source-code" id="M000253-source">
 146 <pre>
 147     <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 7</span>
 148  7:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">plugin_name</span>, <span class="ruby-identifier">outputs</span> = [],  <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">description</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">author</span> = <span class="ruby-keyword kw">nil</span> ,
 149  8:                      <span class="ruby-identifier">license</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">version</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">url</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">timeout</span> = <span class="ruby-keyword kw">nil</span>)
 150  9:
 151 10:         <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
 152 11:         <span class="ruby-ivar">@mod_name</span> = <span class="ruby-value str">&quot;Data&quot;</span>
 153 12:         <span class="ruby-ivar">@pclass</span> = <span class="ruby-value str">&quot;Base&quot;</span>
 154 13:         <span class="ruby-ivar">@plugin_name</span> = <span class="ruby-identifier">plugin_name</span>
 155 14:         <span class="ruby-ivar">@outputs</span> = <span class="ruby-identifier">outputs</span>
 156 15:         <span class="ruby-ivar">@ddl</span> = <span class="ruby-identifier">create_ddl</span>
 157 16:         <span class="ruby-ivar">@content</span> = <span class="ruby-identifier">create_plugin_content</span>
 158 17:         <span class="ruby-ivar">@plugin</span> = <span class="ruby-identifier">create_plugin_string</span>
 159 18:         <span class="ruby-identifier">write_plugins</span>
 160 19:       <span class="ruby-keyword kw">end</span>
 161 </pre>
 162           </div>
 163         </div>
 164       </div>
 165
 166       <h3 class="section-bar">Public Instance methods</h3>
 167
 168       <div id="method-M000254" class="method-detail">
 169         <a name="M000254"></a>
 170
 171         <div class="method-heading">
 172           <a href="#M000254" class="method-signature">
 173           <span class="method-name">create_ddl</span><span class="method-args">()</span>
 174           </a>
 175         </div>
 176
 177         <div class="method-description">
 178           <p><a class="source-toggle" href="#"
 179             onclick="toggleCode('M000254-source');return false;">[Source]</a></p>
 180           <div class="method-source-code" id="M000254-source">
 181 <pre>
 182     <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 21</span>
 183 21:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_ddl</span>
 184 22:         <span class="ruby-identifier">query_text</span> = <span class="ruby-value str">&quot;dataquery :description =&gt; \&quot;Query information\&quot; do\n&quot;</span>
 185 23:         <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">&quot;templates&quot;</span>, <span class="ruby-value str">&quot;data_input_snippet.erb&quot;</span>))).<span class="ruby-identifier">result</span>
 186 24:
 187 25:         <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
 188 26:           <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;%2s%s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-node">&quot;output :#{output},\n&quot;</span>]
 189 27:           <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;%9s%s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-value str">&quot;:description =&gt; \&quot;%DESCRIPTION%\&quot;,\n&quot;</span>]
 190 28:           <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;%9s%s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-value str">&quot;:display_as =&gt; \&quot;%DESCRIPTION%\&quot;\n&quot;</span>]
 191 29:           <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;\n&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
 192 30:         <span class="ruby-keyword kw">end</span>
 193 31:
 194 32:         <span class="ruby-identifier">query_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;end&quot;</span>
 195 33:
 196 34:         <span class="ruby-comment cmt"># Use inherited method to create metadata part of the ddl</span>
 197 35:         <span class="ruby-identifier">create_metadata_string</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">query_text</span>
 198 36:       <span class="ruby-keyword kw">end</span>
 199 </pre>
 200           </div>
 201         </div>
 202       </div>
 203
 204       <div id="method-M000255" class="method-detail">
 205         <a name="M000255"></a>
 206
 207         <div class="method-heading">
 208           <a href="#M000255" class="method-signature">
 209           <span class="method-name">create_plugin_content</span><span class="method-args">()</span>
 210           </a>
 211         </div>
 212
 213         <div class="method-description">
 214           <p><a class="source-toggle" href="#"
 215             onclick="toggleCode('M000255-source');return false;">[Source]</a></p>
 216           <div class="method-source-code" id="M000255-source">
 217 <pre>
 218     <span class="ruby-comment cmt"># File lib/mcollective/generators/data_generator.rb, line 38</span>
 219 38:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_content</span>
 220 39:         <span class="ruby-identifier">content_text</span> = <span class="ruby-value str">&quot;%6s%s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-value str">&quot;query do |what|\n&quot;</span>]
 221 40:
 222 41:         <span class="ruby-ivar">@outputs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
 223 42:            <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;%8s%s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-node">&quot;result[:#{output}] = nil\n&quot;</span>]
 224 43:         <span class="ruby-keyword kw">end</span>
 225 44:         <span class="ruby-identifier">content_text</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">&quot;%6s%s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-value str">&quot; &quot;</span>, <span class="ruby-value str">&quot;end\n&quot;</span>]
 226 45:
 227 46:         <span class="ruby-comment cmt"># Add actions to agent file</span>
 228 47:         <span class="ruby-identifier">content_text</span>
 229 48:       <span class="ruby-keyword kw">end</span>
 230 </pre>
 231           </div>
 232         </div>
 233       </div>
 234
 235
 236     </div>
 237
 238
 239   </div>
 240
 241
 242 <div id="validator-badges">
 243   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 244 </div>
 245
 246 </body>
 247 </html>