doc/MCollective/Aggregate/Result/CollectionResult.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Class: MCollective::Aggregate::Result::CollectionResult</title>
   9
  10         <link rel="stylesheet" href="../../../rdoc.css" type="text/css" media="screen" />
  11
  12         <script src="../../../js/jquery.js" type="text/javascript"
  13                 charset="utf-8"></script>
  14         <script src="../../../js/thickbox-compressed.js" type="text/javascript"
  15                 charset="utf-8"></script>
  16         <script src="../../../js/quicksearch.js" type="text/javascript"
  17                 charset="utf-8"></script>
  18         <script src="../../../js/darkfish.js" type="text/javascript"
  19                 charset="utf-8"></script>
  20
  21 </head>
  22 <body class="class">
  23
  24         <div id="metadata">
  25                 <div id="file-metadata">
  26                         <div id="file-list-section" class="section">
  27                                 <h3 class="section-header">In Files</h3>
  28                                 <div class="section-body">
  29                                         <ul>
  30
  31                                                 <li><a href="../../../lib/mcollective/aggregate/result/collection_result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link">Base</p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000255">#to_s</a></li>
  63
  64                                 </ul>
  65                         </div>
  66
  67
  68                         <!-- Included Modules -->
  69
  70                 </div>
  71
  72                 <div id="project-metadata">
  73
  74
  75                         <div id="fileindex-section" class="section project-section">
  76                                 <h3 class="section-header">Files</h3>
  77                                 <ul>
  78
  79                                         <li class="file"><a href="../../../COPYING.html">COPYING</a></li>
  80
  81                                         <li class="file"><a href="../../../Gemfile.html">Gemfile</a></li>
  82
  83                                         <li class="file"><a href="../../../README.html">README</a></li>
  84
  85                                         <li class="file"><a href="../../../Rakefile.html">Rakefile</a></li>
  86
  87                                         <li class="file"><a href="../../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  88
  89                                         <li class="file"><a href="../../../etc/data-help_erb.html">data-help.erb</a></li>
  90
  91                                         <li class="file"><a href="../../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  92
  93                                         <li class="file"><a href="../../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  94
  95                                         <li class="file"><a href="../../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
  96
  97                                         <li class="file"><a href="../../../etc/msg-help_erb.html">msg-help.erb</a></li>
  98
  99                                         <li class="file"><a href="../../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 100
 101                                         <li class="file"><a href="../../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 102
 103                                         <li class="file"><a href="../../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 104
 105                                         <li class="file"><a href="../../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 106
 107                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 108
 109                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 110
 111                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 112
 113                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 114
 115                                         <li class="file"><a href="../../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 116
 117                                         <li class="file"><a href="../../../mcollective_init.html">mcollective.init</a></li>
 118
 119                                 </ul>
 120                         </div>
 121
 122
 123                         <div id="classindex-section" class="section project-section">
 124                                 <h3 class="section-header">Class Index
 125                                         <span class="search-toggle"><img src="../../../images/find.png"
 126                                                 height="16" width="16" alt="[+]"
 127                                                 title="show/hide quicksearch" /></span></h3>
 128                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 129                                 <fieldset>
 130                                         <legend>Quicksearch</legend>
 131                                         <input type="text" name="quicksearch" value=""
 132                                                 class="quicksearch-field" />
 133                                 </fieldset>
 134                                 </form>
 135
 136                                 <ul class="link-list">
 137
 138                                         <li><a href="../../../MCollective.html">MCollective</a></li>
 139
 140                                         <li><a href="../../../MCollective/Agent.html">MCollective::Agent</a></li>
 141
 142                                         <li><a href="../../../MCollective/Agents.html">MCollective::Agents</a></li>
 143
 144                                         <li><a href="../../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 145
 146                                         <li><a href="../../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 147
 148                                         <li><a href="../../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 149
 150                                         <li><a href="../../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 151
 152                                         <li><a href="../../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 153
 154                                         <li><a href="../../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 155
 156                                         <li><a href="../../../MCollective/Application.html">MCollective::Application</a></li>
 157
 158                                         <li><a href="../../../MCollective/Applications.html">MCollective::Applications</a></li>
 159
 160                                         <li><a href="../../../MCollective/Cache.html">MCollective::Cache</a></li>
 161
 162                                         <li><a href="../../../MCollective/Client.html">MCollective::Client</a></li>
 163
 164                                         <li><a href="../../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 165
 166                                         <li><a href="../../../MCollective/Config.html">MCollective::Config</a></li>
 167
 168                                         <li><a href="../../../MCollective/Connector.html">MCollective::Connector</a></li>
 169
 170                                         <li><a href="../../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 171
 172                                         <li><a href="../../../MCollective/DDL.html">MCollective::DDL</a></li>
 173
 174                                         <li><a href="../../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 175
 176                                         <li><a href="../../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 177
 178                                         <li><a href="../../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 179
 180                                         <li><a href="../../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 181
 182                                         <li><a href="../../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 183
 184                                         <li><a href="../../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 185
 186                                         <li><a href="../../../MCollective/Data.html">MCollective::Data</a></li>
 187
 188                                         <li><a href="../../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 189
 190                                         <li><a href="../../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 191
 192                                         <li><a href="../../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 193
 194                                         <li><a href="../../../MCollective/Facts.html">MCollective::Facts</a></li>
 195
 196                                         <li><a href="../../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 197
 198                                         <li><a href="../../../MCollective/Generators.html">MCollective::Generators</a></li>
 199
 200                                         <li><a href="../../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 201
 202                                         <li><a href="../../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 203
 204                                         <li><a href="../../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 205
 206                                         <li><a href="../../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 207
 208                                         <li><a href="../../../MCollective/Log.html">MCollective::Log</a></li>
 209
 210                                         <li><a href="../../../MCollective/Logger.html">MCollective::Logger</a></li>
 211
 212                                         <li><a href="../../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 213
 214                                         <li><a href="../../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 215
 216                                         <li><a href="../../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 217
 218                                         <li><a href="../../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 219
 220                                         <li><a href="../../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 221
 222                                         <li><a href="../../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 223
 224                                         <li><a href="../../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 225
 226                                         <li><a href="../../../MCollective/Message.html">MCollective::Message</a></li>
 227
 228                                         <li><a href="../../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 229
 230                                         <li><a href="../../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 231
 232                                         <li><a href="../../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 233
 234                                         <li><a href="../../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 235
 236                                         <li><a href="../../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 237
 238                                         <li><a href="../../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 239
 240                                         <li><a href="../../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 241
 242                                         <li><a href="../../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 243
 244                                         <li><a href="../../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 245
 246                                         <li><a href="../../../MCollective/RPC.html">MCollective::RPC</a></li>
 247
 248                                         <li><a href="../../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 249
 250                                         <li><a href="../../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 251
 252                                         <li><a href="../../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 253
 254                                         <li><a href="../../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 255
 256                                         <li><a href="../../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 257
 258                                         <li><a href="../../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 259
 260                                         <li><a href="../../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 261
 262                                         <li><a href="../../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 263
 264                                         <li><a href="../../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 265
 266                                         <li><a href="../../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 267
 268                                         <li><a href="../../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 269
 270                                         <li><a href="../../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 271
 272                                         <li><a href="../../../MCollective/Registration.html">MCollective::Registration</a></li>
 273
 274                                         <li><a href="../../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 275
 276                                         <li><a href="../../../MCollective/Runner.html">MCollective::Runner</a></li>
 277
 278                                         <li><a href="../../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 279
 280                                         <li><a href="../../../MCollective/SSL.html">MCollective::SSL</a></li>
 281
 282                                         <li><a href="../../../MCollective/Security.html">MCollective::Security</a></li>
 283
 284                                         <li><a href="../../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 285
 286                                         <li><a href="../../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 287
 288                                         <li><a href="../../../MCollective/Shell.html">MCollective::Shell</a></li>
 289
 290                                         <li><a href="../../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 291
 292                                         <li><a href="../../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 293
 294                                         <li><a href="../../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 295
 296                                         <li><a href="../../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 297
 298                                         <li><a href="../../../MCollective/Util.html">MCollective::Util</a></li>
 299
 300                                         <li><a href="../../../MCollective/Validator.html">MCollective::Validator</a></li>
 301
 302                                         <li><a href="../../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 303
 304                                         <li><a href="../../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 305
 306                                         <li><a href="../../../Array.html">Array</a></li>
 307
 308                                         <li><a href="../../../Dir.html">Dir</a></li>
 309
 310                                         <li><a href="../../../Object.html">Object</a></li>
 311
 312                                         <li><a href="../../../String.html">String</a></li>
 313
 314                                         <li><a href="../../../Symbol.html">Symbol</a></li>
 315
 316                                 </ul>
 317                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 318                         </div>
 319
 320
 321                 </div>
 322         </div>
 323
 324         <div id="documentation">
 325                 <h1 class="class">MCollective::Aggregate::Result::CollectionResult</h1>
 326
 327                 <div id="description">
 328
 329                 </div>
 330
 331                 <!-- Constants -->
 332
 333
 334                 <!-- Attributes -->
 335
 336
 337                 <!-- Methods -->
 338
 339                 <div id="public-instance-method-details" class="method-section section">
 340                         <h3 class="section-header">Public Instance Methods</h3>
 341
 342
 343                         <div id="to-s-method" class="method-detail ">
 344                                 <a name="M000255"></a>
 345
 346                                 <div class="method-heading">
 347
 348                                         <span class="method-name">to_s</span><span
 349                                                 class="method-args">()</span>
 350                                         <span class="method-click-advice">click to toggle source</span>
 351
 352                                 </div>
 353
 354                                 <div class="method-description">
 355
 356                                         <p class="missing-docs">(Not documented)</p>
 357
 358
 359
 360                                         <div class="method-source-code"
 361                                                 id="to-s-source">
 362 <pre>
 363     <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/collection_result.rb, line 5</span>
 364  5:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 365  6:           <span class="ruby-keyword kw">return</span> <span class="ruby-value str">&quot;&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">nil</span>)
 366  7:
 367  8:           <span class="ruby-identifier">result</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>
 368  9:
 369 10:           <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:value</span>].<span class="ruby-identifier">sort</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span>,<span class="ruby-identifier">y</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">y</span>[<span class="ruby-value">1</span>]}.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
 370 11:             <span class="ruby-identifier">result</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@aggregate_format</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">value</span>[<span class="ruby-value">0</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">1</span>]]
 371 12:           <span class="ruby-keyword kw">end</span>
 372 13:
 373 14:           <span class="ruby-identifier">result</span>.<span class="ruby-identifier">string</span>.<span class="ruby-identifier">chomp</span>
 374 15:         <span class="ruby-keyword kw">end</span></pre>
 375                                         </div>
 376
 377                                 </div>
 378
 379
 380                         </div>
 381
 382
 383                 </div>
 384
 385
 386         </div>
 387
 388
 389         <div id="rdoc-debugging-section-dump" class="debugging-section">
 390
 391                 <p>Disabled; run with --debug to generate this.</p>
 392
 393         </div>
 394
 395         <div id="validator-badges">
 396                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 397                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 398                         Rdoc Generator</a> 1.1.6</small>.</p>
 399         </div>
 400
 401 </body>
 402 </html>
 403