website/docs/full_javadoc/compbio/data/msa/Metadata.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:50 BST 2017 -->
   6 <title>Metadata</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>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="Metadata";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
  22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23 var altColor = "altColor";
  24 var rowColor = "rowColor";
  25 var tableTab = "tableTab";
  26 var activeTableTab = "activeTableTab";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  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/Metadata.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>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../../index.html?compbio/data/msa/Metadata.html" target="_top">Frames</a></li>
  57 <li><a href="Metadata.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li>Field&nbsp;|&nbsp;</li>
  79 <li>Constr&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li>Field&nbsp;|&nbsp;</li>
  85 <li>Constr&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.data.msa</div>
  96 <h2 title="Interface Metadata" class="title">Interface Metadata&lt;T&gt;</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <div class="description">
 100 <ul class="blockList">
 101 <li class="blockList">
 102 <dl>
 103 <dt>All Known Subinterfaces:</dt>
 104 <dd><a href="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</a>&lt;T&gt;, <a href="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa">SequenceAnnotation</a>&lt;T&gt;</dd>
 105 </dl>
 106 <dl>
 107 <dt>All Known Implementing Classes:</dt>
 108 <dd><a href="../../../compbio/ws/server/AAConWS.html" title="class in compbio.ws.server">AAConWS</a>, <a href="../../../compbio/ws/server/ClustalOWS.html" title="class in compbio.ws.server">ClustalOWS</a>, <a href="../../../compbio/ws/server/ClustalWS.html" title="class in compbio.ws.server">ClustalWS</a>, <a href="../../../compbio/ws/server/DisemblWS.html" title="class in compbio.ws.server">DisemblWS</a>, <a href="../../../compbio/ws/server/GlobPlotWS.html" title="class in compbio.ws.server">GlobPlotWS</a>, <a href="../../../compbio/ws/server/GLprobsWS.html" title="class in compbio.ws.server">GLprobsWS</a>, <a href="../../../compbio/ws/server/IUPredWS.html" title="class in compbio.ws.server">IUPredWS</a>, <a href="../../../compbio/ws/server/JronnWS.html" title="class in compbio.ws.server">JronnWS</a>, <a href="../../../compbio/ws/server/MafftWS.html" title="class in compbio.ws.server">MafftWS</a>, <a href="../../../compbio/ws/server/MSAprobsWS.html" title="class in compbio.ws.server">MSAprobsWS</a>, <a href="../../../compbio/ws/server/MuscleWS.html" title="class in compbio.ws.server">MuscleWS</a>, <a href="../../../compbio/ws/server/ProbconsWS.html" title="class in compbio.ws.server">ProbconsWS</a>, <a href="../../../compbio/ws/server/RNAalifoldWS.html" title="class in compbio.ws.server">RNAalifoldWS</a>, <a href="../../../compbio/ws/server/TcoffeeWS.html" title="class in compbio.ws.server">TcoffeeWS</a></dd>
 109 </dl>
 110 <hr>
 111 <br>
 112 <pre>public interface <span class="typeNameLabel">Metadata&lt;T&gt;</span></pre>
 113 </li>
 114 </ul>
 115 </div>
 116 <div class="summary">
 117 <ul class="blockList">
 118 <li class="blockList">
 119 <!-- ========== METHOD SUMMARY =========== -->
 120 <ul class="blockList">
 121 <li class="blockList"><a name="method.summary">
 122 <!--   -->
 123 </a>
 124 <h3>Method Summary</h3>
 125 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 126 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 127 <tr>
 128 <th class="colFirst" scope="col">Modifier and Type</th>
 129 <th class="colLast" scope="col">Method and Description</th>
 130 </tr>
 131 <tr id="i0" class="altColor">
 132 <td class="colFirst"><code><a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;</code></td>
 133 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/Metadata.html#getLimit-java.lang.String-">getLimit</a></span>(java.lang.String&nbsp;presetName)</code>
 134 <div class="block">Get a Limit for a preset.</div>
 135 </td>
 136 </tr>
 137 <tr id="i1" class="rowColor">
 138 <td class="colFirst"><code><a href="../../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;</code></td>
 139 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/Metadata.html#getLimits--">getLimits</a></span>()</code>
 140 <div class="block">List Limits supported by a web service.</div>
 141 </td>
 142 </tr>
 143 <tr id="i2" class="altColor">
 144 <td class="colFirst"><code><a href="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;</code></td>
 145 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/Metadata.html#getPresets--">getPresets</a></span>()</code>
 146 <div class="block">Get presets supported by a web service</div>
 147 </td>
 148 </tr>
 149 <tr id="i3" class="rowColor">
 150 <td class="colFirst"><code><a href="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;</code></td>
 151 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/Metadata.html#getRunnerOptions--">getRunnerOptions</a></span>()</code>
 152 <div class="block">Get options supported by a web service</div>
 153 </td>
 154 </tr>
 155 </table>
 156 </li>
 157 </ul>
 158 </li>
 159 </ul>
 160 </div>
 161 <div class="details">
 162 <ul class="blockList">
 163 <li class="blockList">
 164 <!-- ============ METHOD DETAIL ========== -->
 165 <ul class="blockList">
 166 <li class="blockList"><a name="method.detail">
 167 <!--   -->
 168 </a>
 169 <h3>Method Detail</h3>
 170 <a name="getRunnerOptions--">
 171 <!--   -->
 172 </a>
 173 <ul class="blockList">
 174 <li class="blockList">
 175 <h4>getRunnerOptions</h4>
 176 <pre><a href="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;&nbsp;getRunnerOptions()</pre>
 177 <div class="block">Get options supported by a web service</div>
 178 <dl>
 179 <dt><span class="returnLabel">Returns:</span></dt>
 180 <dd>RunnerConfig the list of options and parameters supported by a
 181          web service.</dd>
 182 </dl>
 183 </li>
 184 </ul>
 185 <a name="getPresets--">
 186 <!--   -->
 187 </a>
 188 <ul class="blockList">
 189 <li class="blockList">
 190 <h4>getPresets</h4>
 191 <pre><a href="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;&nbsp;getPresets()</pre>
 192 <div class="block">Get presets supported by a web service</div>
 193 <dl>
 194 <dt><span class="returnLabel">Returns:</span></dt>
 195 <dd>PresetManager the object contains information about presets
 196          supported by a web service</dd>
 197 </dl>
 198 </li>
 199 </ul>
 200 <a name="getLimit-java.lang.String-">
 201 <!--   -->
 202 </a>
 203 <ul class="blockList">
 204 <li class="blockList">
 205 <h4>getLimit</h4>
 206 <pre><a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;&nbsp;getLimit(java.lang.String&nbsp;presetName)</pre>
 207 <div class="block">Get a Limit for a preset.</div>
 208 <dl>
 209 <dt><span class="paramLabel">Parameters:</span></dt>
 210 <dd><code>presetName</code> - the name of the preset. if no name is provided, then the
 211             default preset is returned. If no limit for a particular
 212             preset is defined then the default preset is returned</dd>
 213 <dt><span class="returnLabel">Returns:</span></dt>
 214 <dd>Limit</dd>
 215 </dl>
 216 </li>
 217 </ul>
 218 <a name="getLimits--">
 219 <!--   -->
 220 </a>
 221 <ul class="blockListLast">
 222 <li class="blockList">
 223 <h4>getLimits</h4>
 224 <pre><a href="../../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager</a>&lt;<a href="../../../compbio/data/msa/Metadata.html" title="type parameter in Metadata">T</a>&gt;&nbsp;getLimits()</pre>
 225 <div class="block">List Limits supported by a web service.</div>
 226 <dl>
 227 <dt><span class="returnLabel">Returns:</span></dt>
 228 <dd>LimitManager</dd>
 229 </dl>
 230 </li>
 231 </ul>
 232 </li>
 233 </ul>
 234 </li>
 235 </ul>
 236 </div>
 237 </div>
 238 <!-- ========= END OF CLASS DATA ========= -->
 239 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 240 <div class="bottomNav"><a name="navbar.bottom">
 241 <!--   -->
 242 </a>
 243 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 244 <a name="navbar.bottom.firstrow">
 245 <!--   -->
 246 </a>
 247 <ul class="navList" title="Navigation">
 248 <li><a href="../../../overview-summary.html">Overview</a></li>
 249 <li><a href="package-summary.html">Package</a></li>
 250 <li class="navBarCell1Rev">Class</li>
 251 <li><a href="class-use/Metadata.html">Use</a></li>
 252 <li><a href="package-tree.html">Tree</a></li>
 253 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 254 <li><a href="../../../index-files/index-1.html">Index</a></li>
 255 <li><a href="../../../help-doc.html">Help</a></li>
 256 </ul>
 257 </div>
 258 <div class="subNav">
 259 <ul class="navList">
 260 <li><a href="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 261 <li><a href="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 262 </ul>
 263 <ul class="navList">
 264 <li><a href="../../../index.html?compbio/data/msa/Metadata.html" target="_top">Frames</a></li>
 265 <li><a href="Metadata.html" target="_top">No&nbsp;Frames</a></li>
 266 </ul>
 267 <ul class="navList" id="allclasses_navbar_bottom">
 268 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 269 </ul>
 270 <div>
 271 <script type="text/javascript"><!--
 272   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 273   if(window==top) {
 274     allClassesLink.style.display = "block";
 275   }
 276   else {
 277     allClassesLink.style.display = "none";
 278   }
 279   //-->
 280 </script>
 281 </div>
 282 <div>
 283 <ul class="subNavList">
 284 <li>Summary:&nbsp;</li>
 285 <li>Nested&nbsp;|&nbsp;</li>
 286 <li>Field&nbsp;|&nbsp;</li>
 287 <li>Constr&nbsp;|&nbsp;</li>
 288 <li><a href="#method.summary">Method</a></li>
 289 </ul>
 290 <ul class="subNavList">
 291 <li>Detail:&nbsp;</li>
 292 <li>Field&nbsp;|&nbsp;</li>
 293 <li>Constr&nbsp;|&nbsp;</li>
 294 <li><a href="#method.detail">Method</a></li>
 295 </ul>
 296 </div>
 297 <a name="skip.navbar.bottom">
 298 <!--   -->
 299 </a></div>
 300 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 301 </body>
 302 </html>