doc/classes/MCollective/Aggregate/Base.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::Aggregate::Base</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::Aggregate::Base</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../../files/lib/mcollective/aggregate/base_rb.html">
  59                 lib/mcollective/aggregate/base.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                 Object
  69             </td>
  70         </tr>
  71         </table>
  72     </div>
  73   <!-- banner header -->
  74
  75   <div id="bodyContent">
  76
  77
  78
  79   <div id="contextContent">
  80
  81
  82
  83    </div>
  84
  85     <div id="method-list">
  86       <h3 class="section-bar">Methods</h3>
  87
  88       <div class="name-list">
  89       <a href="#M000420">new</a>&nbsp;&nbsp;
  90       <a href="#M000422">result_class</a>&nbsp;&nbsp;
  91       <a href="#M000421">summarize</a>&nbsp;&nbsp;
  92       </div>
  93     </div>
  94
  95   </div>
  96
  97
  98     <!-- if includes -->
  99
 100     <div id="section">
 101
 102
 103
 104
 105
 106     <div id="attribute-list">
 107       <h3 class="section-bar">Attributes</h3>
 108
 109       <div class="name-list">
 110         <table>
 111         <tr class="top-aligned-row context-row">
 112           <td class="context-item-name">action</td>
 113           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 114           <td class="context-item-desc"></td>
 115         </tr>
 116         <tr class="top-aligned-row context-row">
 117           <td class="context-item-name">aggregate_format</td>
 118           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 119           <td class="context-item-desc"></td>
 120         </tr>
 121         <tr class="top-aligned-row context-row">
 122           <td class="context-item-name">arguments</td>
 123           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 124           <td class="context-item-desc"></td>
 125         </tr>
 126         <tr class="top-aligned-row context-row">
 127           <td class="context-item-name">name</td>
 128           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 129           <td class="context-item-desc"></td>
 130         </tr>
 131         <tr class="top-aligned-row context-row">
 132           <td class="context-item-name">output_name</td>
 133           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 134           <td class="context-item-desc"></td>
 135         </tr>
 136         <tr class="top-aligned-row context-row">
 137           <td class="context-item-name">result</td>
 138           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 139           <td class="context-item-desc"></td>
 140         </tr>
 141         </table>
 142       </div>
 143     </div>
 144
 145
 146
 147     <!-- if method_list -->
 148     <div id="methods">
 149       <h3 class="section-bar">Public Class methods</h3>
 150
 151       <div id="method-M000420" class="method-detail">
 152         <a name="M000420"></a>
 153
 154         <div class="method-heading">
 155           <a href="#M000420" class="method-signature">
 156           <span class="method-name">new</span><span class="method-args">(output_name, arguments, aggregate_format, action)</span>
 157           </a>
 158         </div>
 159
 160         <div class="method-description">
 161           <p><a class="source-toggle" href="#"
 162             onclick="toggleCode('M000420-source');return false;">[Source]</a></p>
 163           <div class="method-source-code" id="M000420-source">
 164 <pre>
 165     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 6</span>
 166  6:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">output_name</span>, <span class="ruby-identifier">arguments</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
 167  7:         <span class="ruby-ivar">@name</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>
 168  8:         <span class="ruby-ivar">@output_name</span> = <span class="ruby-identifier">output_name</span>
 169  9:
 170 10:         <span class="ruby-comment cmt"># Any additional arguments passed in the ddl after the output field will</span>
 171 11:         <span class="ruby-comment cmt"># be stored in the arguments array which can be used in the function</span>
 172 12:         <span class="ruby-ivar">@arguments</span> = <span class="ruby-identifier">arguments</span>
 173 13:         <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
 174 14:         <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
 175 15:         <span class="ruby-ivar">@result</span> = {<span class="ruby-identifier">:value</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">:output</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">output_name</span>}
 176 16:
 177 17:         <span class="ruby-identifier">startup_hook</span>
 178 18:       <span class="ruby-keyword kw">end</span>
 179 </pre>
 180           </div>
 181         </div>
 182       </div>
 183
 184       <h3 class="section-bar">Public Instance methods</h3>
 185
 186       <div id="method-M000422" class="method-detail">
 187         <a name="M000422"></a>
 188
 189         <div class="method-heading">
 190           <a href="#M000422" class="method-signature">
 191           <span class="method-name">result_class</span><span class="method-args">(type)</span>
 192           </a>
 193         </div>
 194
 195         <div class="method-description">
 196           <p><a class="source-toggle" href="#"
 197             onclick="toggleCode('M000422-source');return false;">[Source]</a></p>
 198           <div class="method-source-code" id="M000422-source">
 199 <pre>
 200     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 35</span>
 201 35:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_class</span>(<span class="ruby-identifier">type</span>)
 202 36:         <span class="ruby-constant">Result</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">&quot;#{type.to_s.capitalize}Result&quot;</span>)
 203 37:       <span class="ruby-keyword kw">end</span>
 204 </pre>
 205           </div>
 206         </div>
 207       </div>
 208
 209       <div id="method-M000421" class="method-detail">
 210         <a name="M000421"></a>
 211
 212         <div class="method-heading">
 213           <a href="#M000421" class="method-signature">
 214           <span class="method-name">summarize</span><span class="method-args">()</span>
 215           </a>
 216         </div>
 217
 218         <div class="method-description">
 219           <p>
 220 Stops execution of the function and returns a specific ResultObject,
 221 aggregate functions will most likely override this but this is the simplest
 222 case so we might as well default to that
 223 </p>
 224           <p><a class="source-toggle" href="#"
 225             onclick="toggleCode('M000421-source');return false;">[Source]</a></p>
 226           <div class="method-source-code" id="M000421-source">
 227 <pre>
 228     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/base.rb, line 29</span>
 229 29:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">summarize</span>
 230 30:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Result type is not set while trying to summarize aggregate function results&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
 231 31:
 232 32:         <span class="ruby-identifier">result_class</span>(<span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]).<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@result</span>, <span class="ruby-ivar">@aggregate_format</span>, <span class="ruby-ivar">@action</span>)
 233 33:       <span class="ruby-keyword kw">end</span>
 234 </pre>
 235           </div>
 236         </div>
 237       </div>
 238
 239
 240     </div>
 241
 242
 243   </div>
 244
 245
 246 <div id="validator-badges">
 247   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 248 </div>
 249
 250 </body>
 251 </html>