1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:49 BST 2017 -->
6 <title>MetadataHelper</title>
7 <meta name="date" content="2017-04-21">
8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../script.js"></script>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="MetadataHelper";
21 var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/MetadataHelper.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../../index-files/index-1.html">Index</a></li>
47 <li><a href="../../../help-doc.html">Help</a></li>
52 <li><a href="../../../compbio/ws/client/Jws2Client.html" title="class in compbio.ws.client"><span class="typeNameLink">Prev Class</span></a></li>
53 <li><a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client"><span class="typeNameLink">Next Class</span></a></li>
56 <li><a href="../../../index.html?compbio/ws/client/MetadataHelper.html" target="_top">Frames</a></li>
57 <li><a href="MetadataHelper.html" target="_top">No Frames</a></li>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
63 <script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
66 allClassesLink.style.display = "block";
69 allClassesLink.style.display = "none";
75 <ul class="subNavList">
76 <li>Summary: </li>
77 <li>Nested | </li>
78 <li>Field | </li>
79 <li><a href="#constructor.summary">Constr</a> | </li>
80 <li><a href="#method.summary">Method</a></li>
82 <ul class="subNavList">
83 <li>Detail: </li>
84 <li>Field | </li>
85 <li><a href="#constructor.detail">Constr</a> | </li>
86 <li><a href="#method.detail">Method</a></li>
89 <a name="skip.navbar.top">
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
95 <div class="subTitle">compbio.ws.client</div>
96 <h2 title="Class MetadataHelper" class="title">Class MetadataHelper</h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li>compbio.ws.client.MetadataHelper</li>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
112 <pre>public class <span class="typeNameLabel">MetadataHelper</span>
113 extends java.lang.Object</pre>
117 <div class="summary">
118 <ul class="blockList">
119 <li class="blockList">
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
121 <ul class="blockList">
122 <li class="blockList"><a name="constructor.summary">
125 <h3>Constructor Summary</h3>
126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
127 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
129 <th class="colOne" scope="col">Constructor and Description</th>
131 <tr class="altColor">
132 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#MetadataHelper--">MetadataHelper</a></span>()</code> </td>
137 <!-- ========== METHOD SUMMARY =========== -->
138 <ul class="blockList">
139 <li class="blockList"><a name="method.summary">
142 <h3>Method Summary</h3>
143 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
144 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
146 <th class="colFirst" scope="col">Modifier and Type</th>
147 <th class="colLast" scope="col">Method and Description</th>
149 <tr id="i0" class="altColor">
150 <td class="colFirst"><code>(package private) static <T> java.util.List<<a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T>></code></td>
151 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getLimits-compbio.data.msa.Metadata-">getLimits</a></span>(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws)</code>
152 <div class="block">Returns a list of limits supported by web service Each limit correspond
153 to a particular preset.</div>
156 <tr id="i1" class="rowColor">
157 <td class="colFirst"><code>(package private) static <T> java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>></code></td>
158 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getParametersList-compbio.data.msa.Metadata-">getParametersList</a></span>(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws)</code>
159 <div class="block">Returns a list of options supported by web service</div>
162 <tr id="i2" class="altColor">
163 <td class="colFirst"><code>(package private) static <T> java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>></code></td>
164 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getParametersList-compbio.data.msa.Metadata-java.lang.String-">getParametersList</a></span>(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws,
165 java.lang.String host)</code>
166 <div class="block">Returns a list of options supported by web service</div>
169 <tr id="i3" class="rowColor">
170 <td class="colFirst"><code>(package private) static java.lang.String</code></td>
171 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getParamName-java.lang.String-">getParamName</a></span>(java.lang.String fullName)</code> </td>
173 <tr id="i4" class="altColor">
174 <td class="colFirst"><code>(package private) static java.lang.String</code></td>
175 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getParamValue-java.lang.String-">getParamValue</a></span>(java.lang.String fullName)</code> </td>
177 <tr id="i5" class="rowColor">
178 <td class="colFirst"><code>(package private) static <T> <a href="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</a><T></code></td>
179 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getPreset-compbio.data.msa.Metadata-java.lang.String-">getPreset</a></span>(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws,
180 java.lang.String presetName)</code>
181 <div class="block">Returns <code>Preset</code> by its name</div>
184 <tr id="i6" class="altColor">
185 <td class="colFirst"><code>(package private) static <T> <a href="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</a><T></code></td>
186 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#getPresetList-compbio.data.msa.Metadata-">getPresetList</a></span>(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws)</code>
187 <div class="block">Returns an objects from which the list of presets supported by web
188 service <T> can be obtained</div>
191 <tr id="i7" class="rowColor">
192 <td class="colFirst"><code>(package private) static boolean</code></td>
193 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#isParameter-java.lang.String-">isParameter</a></span>(java.lang.String param)</code> </td>
195 <tr id="i8" class="altColor">
196 <td class="colFirst"><code>(package private) static <T> java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>></code></td>
197 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/MetadataHelper.html#processParameters-java.util.List-compbio.metadata.RunnerConfig-">processParameters</a></span>(java.util.List<java.lang.String> params,
198 <a href="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</a><T> options)</code>
199 <div class="block">Converts options supplied via parameters file into <code>Option</code> objects</div>
203 <ul class="blockList">
204 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
207 <h3>Methods inherited from class java.lang.Object</h3>
208 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
215 <div class="details">
216 <ul class="blockList">
217 <li class="blockList">
218 <!-- ========= CONSTRUCTOR DETAIL ======== -->
219 <ul class="blockList">
220 <li class="blockList"><a name="constructor.detail">
223 <h3>Constructor Detail</h3>
224 <a name="MetadataHelper--">
227 <ul class="blockListLast">
228 <li class="blockList">
229 <h4>MetadataHelper</h4>
230 <pre>public MetadataHelper()</pre>
235 <!-- ============ METHOD DETAIL ========== -->
236 <ul class="blockList">
237 <li class="blockList"><a name="method.detail">
240 <h3>Method Detail</h3>
241 <a name="getParametersList-compbio.data.msa.Metadata-">
244 <ul class="blockList">
245 <li class="blockList">
246 <h4>getParametersList</h4>
247 <pre>static <T> java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>> getParametersList(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws)</pre>
248 <div class="block">Returns a list of options supported by web service</div>
250 <dt><span class="paramLabel">Type Parameters:</span></dt>
251 <dd><code>T</code> - web service type</dd>
252 <dt><span class="paramLabel">Parameters:</span></dt>
253 <dd><code>msaws</code> - web service proxy</dd>
254 <dt><span class="returnLabel">Returns:</span></dt>
255 <dd>List of options supported by a web service</dd>
259 <a name="getParametersList-compbio.data.msa.Metadata-java.lang.String-">
262 <ul class="blockList">
263 <li class="blockList">
264 <h4>getParametersList</h4>
265 <pre>static <T> java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>> getParametersList(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws,
266 java.lang.String host)
267 throws java.net.MalformedURLException</pre>
268 <div class="block">Returns a list of options supported by web service</div>
270 <dt><span class="paramLabel">Type Parameters:</span></dt>
271 <dd><code>T</code> - web service type</dd>
272 <dt><span class="paramLabel">Parameters:</span></dt>
273 <dd><code>msaws</code> - web service proxy</dd>
274 <dd><code>host</code> - the server URL, as a string</dd>
275 <dt><span class="returnLabel">Returns:</span></dt>
276 <dd>List of options supported by a web service</dd>
277 <dt><span class="throwsLabel">Throws:</span></dt>
278 <dd><code>java.net.MalformedURLException</code></dd>
282 <a name="getPresetList-compbio.data.msa.Metadata-">
285 <ul class="blockList">
286 <li class="blockList">
287 <h4>getPresetList</h4>
288 <pre>static <T> <a href="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</a><T> getPresetList(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws)</pre>
289 <div class="block">Returns an objects from which the list of presets supported by web
290 service <T> can be obtained</div>
292 <dt><span class="paramLabel">Type Parameters:</span></dt>
293 <dd><code>T</code> - web service type</dd>
294 <dt><span class="paramLabel">Parameters:</span></dt>
295 <dd><code>msaws</code> - web service proxy</dd>
296 <dt><span class="returnLabel">Returns:</span></dt>
297 <dd>PresetManager, object which operates on presets</dd>
301 <a name="getLimits-compbio.data.msa.Metadata-">
304 <ul class="blockList">
305 <li class="blockList">
307 <pre>static <T> java.util.List<<a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T>> getLimits(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws)</pre>
308 <div class="block">Returns a list of limits supported by web service Each limit correspond
309 to a particular preset.</div>
311 <dt><span class="paramLabel">Type Parameters:</span></dt>
312 <dd><code>T</code> - web service type</dd>
313 <dt><span class="paramLabel">Parameters:</span></dt>
314 <dd><code>msaws</code> - web service proxy</dd>
315 <dt><span class="returnLabel">Returns:</span></dt>
316 <dd>List of limits supported by a web service</dd>
320 <a name="getPreset-compbio.data.msa.Metadata-java.lang.String-">
323 <ul class="blockList">
324 <li class="blockList">
326 <pre>static <T> <a href="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</a><T> getPreset(<a href="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</a><T> msaws,
327 java.lang.String presetName)</pre>
328 <div class="block">Returns <code>Preset</code> by its name</div>
330 <dt><span class="paramLabel">Type Parameters:</span></dt>
331 <dd><code>T</code> - </dd>
332 <dt><span class="paramLabel">Parameters:</span></dt>
333 <dd><code>msaws</code> - </dd>
334 <dd><code>presetName</code> - </dd>
335 <dt><span class="returnLabel">Returns:</span></dt>
336 <dd>Return a Preset by its optionName</dd>
337 <dt><span class="seeLabel">See Also:</span></dt>
338 <dd><a href="../../../compbio/metadata/Preset.html" title="class in compbio.metadata"><code>Preset</code></a></dd>
342 <a name="processParameters-java.util.List-compbio.metadata.RunnerConfig-">
345 <ul class="blockList">
346 <li class="blockList">
347 <h4>processParameters</h4>
348 <pre>static <T> java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>> processParameters(java.util.List<java.lang.String> params,
349 <a href="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</a><T> options)</pre>
350 <div class="block">Converts options supplied via parameters file into <code>Option</code> objects</div>
352 <dt><span class="paramLabel">Type Parameters:</span></dt>
353 <dd><code>T</code> - web service type</dd>
354 <dt><span class="paramLabel">Parameters:</span></dt>
355 <dd><code>params</code> - </dd>
356 <dd><code>options</code> - </dd>
357 <dt><span class="returnLabel">Returns:</span></dt>
358 <dd>List of Options of type T</dd>
362 <a name="getParamName-java.lang.String-">
365 <ul class="blockList">
366 <li class="blockList">
367 <h4>getParamName</h4>
368 <pre>static java.lang.String getParamName(java.lang.String fullName)</pre>
371 <a name="getParamValue-java.lang.String-">
374 <ul class="blockList">
375 <li class="blockList">
376 <h4>getParamValue</h4>
377 <pre>static java.lang.String getParamValue(java.lang.String fullName)</pre>
380 <a name="isParameter-java.lang.String-">
383 <ul class="blockListLast">
384 <li class="blockList">
386 <pre>static boolean isParameter(java.lang.String param)</pre>
395 <!-- ========= END OF CLASS DATA ========= -->
396 <!-- ======= START OF BOTTOM NAVBAR ====== -->
397 <div class="bottomNav"><a name="navbar.bottom">
400 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
401 <a name="navbar.bottom.firstrow">
404 <ul class="navList" title="Navigation">
405 <li><a href="../../../overview-summary.html">Overview</a></li>
406 <li><a href="package-summary.html">Package</a></li>
407 <li class="navBarCell1Rev">Class</li>
408 <li><a href="class-use/MetadataHelper.html">Use</a></li>
409 <li><a href="package-tree.html">Tree</a></li>
410 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
411 <li><a href="../../../index-files/index-1.html">Index</a></li>
412 <li><a href="../../../help-doc.html">Help</a></li>
417 <li><a href="../../../compbio/ws/client/Jws2Client.html" title="class in compbio.ws.client"><span class="typeNameLink">Prev Class</span></a></li>
418 <li><a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client"><span class="typeNameLink">Next Class</span></a></li>
421 <li><a href="../../../index.html?compbio/ws/client/MetadataHelper.html" target="_top">Frames</a></li>
422 <li><a href="MetadataHelper.html" target="_top">No Frames</a></li>
424 <ul class="navList" id="allclasses_navbar_bottom">
425 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
428 <script type="text/javascript"><!--
429 allClassesLink = document.getElementById("allclasses_navbar_bottom");
431 allClassesLink.style.display = "block";
434 allClassesLink.style.display = "none";
440 <ul class="subNavList">
441 <li>Summary: </li>
442 <li>Nested | </li>
443 <li>Field | </li>
444 <li><a href="#constructor.summary">Constr</a> | </li>
445 <li><a href="#method.summary">Method</a></li>
447 <ul class="subNavList">
448 <li>Detail: </li>
449 <li>Field | </li>
450 <li><a href="#constructor.detail">Constr</a> | </li>
451 <li><a href="#method.detail">Method</a></li>
454 <a name="skip.navbar.bottom">
457 <!-- ======== END OF BOTTOM NAVBAR ======= -->