1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8 <title>Class: MCollective::DDL::DataDDL</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">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
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::DDL::DataDDL</td>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../../../files/lib/mcollective/ddl/dataddl_rb.html">
59 lib/mcollective/ddl/dataddl.rb
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
75 <!-- banner header -->
77 <div id="bodyContent">
81 <div id="contextContent">
83 <div id="description">
85 A <a href="../DDL.html">DDL</a> file for the data query plugins.
88 Query plugins can today take only one <a
89 href="DataDDL.html#M000161">input</a> by convention in the <a
90 href="../DDL.html">DDL</a> that is called :query, otherwise the <a
91 href="DataDDL.html#M000161">input</a> is identical to the standard <a
92 href="DataDDL.html#M000161">input</a>.
95 metadata :name => "<a href="../Agent.html">Agent</a>",
98 :description => "Meta data about installed MColletive Agents",
99 :author => "R.I.Pienaar <rip@devco.net>",
100 :license => "ASL 2.0",
101 :version => "1.0",
102 :url => "http://marionette-collective.org/",
106 <a href="DataDDL.html#M000160">dataquery</a> :description => "<a
107 href="../Agent.html">Agent</a> Meta <a href="../Data.html">Data</a>"
112 :prompt => "Agent Name",
113 :description => "Valid agent name",
115 :validation => /^[\w\_]+$/,
118 [:license, :timeout, :description, :url, :version, :author].each do |item|
120 :description => "Agent #{item}",
121 :display_as => item.to_s.capitalize
133 <div id="method-list">
134 <h3 class="section-bar">Methods</h3>
136 <div class="name-list">
137 <a href="#M000160">dataquery</a>
138 <a href="#M000162">dataquery_interface</a>
139 <a href="#M000161">input</a>
157 <!-- if method_list -->
159 <h3 class="section-bar">Public Instance methods</h3>
161 <div id="method-M000160" class="method-detail">
162 <a name="M000160"></a>
164 <div class="method-heading">
165 <a href="#M000160" class="method-signature">
166 <span class="method-name">dataquery</span><span class="method-args">(input, &block)</span>
170 <div class="method-description">
171 <p><a class="source-toggle" href="#"
172 onclick="toggleCode('M000160-source');return false;">[Source]</a></p>
173 <div class="method-source-code" id="M000160-source">
175 <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 31</span>
176 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>)
177 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>)
178 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>]
180 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>],
181 36: <span class="ruby-identifier">:input</span> =<span class="ruby-operator">></span> {},
182 37: <span class="ruby-identifier">:output</span> =<span class="ruby-operator">></span> {}}
184 39: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-identifier">:data</span>
185 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>
186 41: <span class="ruby-ivar">@current_entity</span> = <span class="ruby-keyword kw">nil</span>
187 42: <span class="ruby-keyword kw">end</span>
193 <div id="method-M000162" class="method-detail">
194 <a name="M000162"></a>
196 <div class="method-heading">
197 <a href="#M000162" class="method-signature">
198 <span class="method-name">dataquery_interface</span><span class="method-args">()</span>
202 <div class="method-description">
204 Returns the interface for the data query
206 <p><a class="source-toggle" href="#"
207 onclick="toggleCode('M000162-source');return false;">[Source]</a></p>
208 <div class="method-source-code" id="M000162-source">
210 <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 51</span>
211 51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dataquery_interface</span>
212 52: <span class="ruby-ivar">@entities</span>[<span class="ruby-identifier">:data</span>] <span class="ruby-operator">||</span> {}
213 53: <span class="ruby-keyword kw">end</span>
219 <div id="method-M000161" class="method-detail">
220 <a name="M000161"></a>
222 <div class="method-heading">
223 <a href="#M000161" class="method-signature">
224 <span class="method-name">input</span><span class="method-args">(argument, properties)</span>
228 <div class="method-description">
229 <p><a class="source-toggle" href="#"
230 onclick="toggleCode('M000161-source');return false;">[Source]</a></p>
231 <div class="method-source-code" id="M000161-source">
233 <span class="ruby-comment cmt"># File lib/mcollective/ddl/dataddl.rb, line 44</span>
234 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>)
235 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>
237 47: <span class="ruby-keyword kw">super</span>
238 48: <span class="ruby-keyword kw">end</span>
251 <div id="validator-badges">
252 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>