--- /dev/null
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: MCollective::DDL::DataDDL</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">MCollective::DDL::DataDDL</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../../files/lib/mcollective/ddl/dataddl_rb.html">
+ lib/mcollective/ddl/dataddl.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ <a href="Base.html">
+ Base
+ </a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+A <a href="../DDL.html">DDL</a> file for the data query plugins.
+</p>
+<p>
+Query plugins can today take only one <a
+href="DataDDL.html#M000161">input</a> by convention in the <a
+href="../DDL.html">DDL</a> that is called :query, otherwise the <a
+href="DataDDL.html#M000161">input</a> is identical to the standard <a
+href="DataDDL.html#M000161">input</a>.
+</p>
+<p>
+metadata :name => "<a href="../Agent.html">Agent</a>",
+</p>
+<pre>
+ :description => "Meta data about installed MColletive Agents",
+ :author => "R.I.Pienaar <rip@devco.net>",
+ :license => "ASL 2.0",
+ :version => "1.0",
+ :url => "http://marionette-collective.org/",
+ :timeout => 1
+</pre>
+<p>
+<a href="DataDDL.html#M000160">dataquery</a> :description => "<a
+href="../Agent.html">Agent</a> Meta <a href="../Data.html">Data</a>"
+do
+</p>
+<pre>
+ input :query,
+ :prompt => "Agent Name",
+ :description => "Valid agent name",
+ :type => :string,
+ :validation => /^[\w\_]+$/,
+ :maxlength => 20
+
+ [:license, :timeout, :description, :url, :version, :author].each do |item|
+ output item,
+ :description => "Agent #{item}",
+ :display_as => item.to_s.capitalize
+ end
+</pre>
+<p>
+end
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000160">dataquery</a>
+ <a href="#M000162">dataquery_interface</a>
+ <a href="#M000161">input</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000160" class="method-detail">
+ <a name="M000160"></a>
+
+ <div class="method-heading">
+ <a href="#M000160" class="method-signature">
+ <span class="method-name">dataquery</span><span class="method-args">(input, &block)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000160-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000160-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery</span>(<span class="ruby-identifier">input</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+32: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Data queries need a :description"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">:description</span>)
+33: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Data queries can only have one definition"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>]
+34:
+35: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] = {<span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">input</span>[<span class="ruby-identifier">:description</span>],
+36: <span class="ruby-identifier">:input</span> =<span class="ruby-operator">></span> {},
+37: <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> {}}
+38:
+39: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:data</span>
+40: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+41: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
+42: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000162" class="method-detail">
+ <a name="M000162"></a>
+
+ <div class="method-heading">
+ <a href="#M000162" class="method-signature">
+ <span class="method-name">dataquery_interface</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Returns the interface for the data query
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000162-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000162-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 51</span>
+51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery_interface</span>
+52: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] <span class="ruby-operator">||</span> {}
+53: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000161" class="method-detail">
+ <a name="M000161"></a>
+
+ <div class="method-heading">
+ <a href="#M000161" class="method-signature">
+ <span class="method-name">input</span><span class="method-args">(argument, properties)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000161-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000161-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 44</span>
+44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">input</span>(<span class="ruby-identifier">argument</span>, <span class="ruby-identifier">properties</span>)
+45: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"The only valid input name for a data query is 'query'"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:query</span>
+46:
+47: <span class="ruby-keyword kw">super</span>
+48: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file