updated javadoc
[jabaws.git] / website / 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">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
6 <TITLE>\r
7 Metadata\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="Metadata";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \r
31 <!-- ========= START OF TOP NAVBAR ======= -->\r
32 <A NAME="navbar_top"><!-- --></A>\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
35 <TR>\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
39   <TR ALIGN="center" VALIGN="top">\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Metadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/data/msa/Metadata.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="Metadata.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.data.msa</FONT>\r
92 <BR>\r
93 Interface Metadata&lt;T&gt;</H2>\r
94 <DL>\r
95 <DT><B>All Known Subinterfaces:</B> <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>\r
96 </DL>\r
97 <DL>\r
98 <DT><B>All Known Implementing Classes:</B> <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/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/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/TcoffeeWS.html" title="class in compbio.ws.server">TcoffeeWS</A></DD>\r
99 </DL>\r
100 <HR>\r
101 <DL>\r
102 <DT><PRE>public interface <B>Metadata&lt;T&gt;</B></DL>\r
103 </PRE>\r
104 \r
105 <P>\r
106 <HR>\r
107 \r
108 <P>\r
109 \r
110 <!-- ========== METHOD SUMMARY =========== -->\r
111 \r
112 <A NAME="method_summary"><!-- --></A>\r
113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
116 <B>Method Summary</B></FONT></TH>\r
117 </TR>\r
118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
119 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
120 <CODE>&nbsp;<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></FONT></TD>\r
121 <TD><CODE><B><A HREF="../../../compbio/data/msa/Metadata.html#getLimit(java.lang.String)">getLimit</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;presetName)</CODE>\r
122 \r
123 <BR>\r
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a Limit for a preset.</TD>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
128 <CODE>&nbsp;<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></FONT></TD>\r
129 <TD><CODE><B><A HREF="../../../compbio/data/msa/Metadata.html#getLimits()">getLimits</A></B>()</CODE>\r
130 \r
131 <BR>\r
132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List Limits supported by a web service.</TD>\r
133 </TR>\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
136 <CODE>&nbsp;<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></FONT></TD>\r
137 <TD><CODE><B><A HREF="../../../compbio/data/msa/Metadata.html#getPresets()">getPresets</A></B>()</CODE>\r
138 \r
139 <BR>\r
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get presets supported by a web service</TD>\r
141 </TR>\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
144 <CODE>&nbsp;<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></FONT></TD>\r
145 <TD><CODE><B><A HREF="../../../compbio/data/msa/Metadata.html#getRunnerOptions()">getRunnerOptions</A></B>()</CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get options supported by a web service</TD>\r
149 </TR>\r
150 </TABLE>\r
151 &nbsp;\r
152 <P>\r
153 \r
154 <!-- ============ METHOD DETAIL ========== -->\r
155 \r
156 <A NAME="method_detail"><!-- --></A>\r
157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
159 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
160 <B>Method Detail</B></FONT></TH>\r
161 </TR>\r
162 </TABLE>\r
163 \r
164 <A NAME="getRunnerOptions()"><!-- --></A><H3>\r
165 getRunnerOptions</H3>\r
166 <PRE>\r
167 <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; <B>getRunnerOptions</B>()</PRE>\r
168 <DL>\r
169 <DD>Get options supported by a web service\r
170 <P>\r
171 <DD><DL>\r
172 \r
173 <DT><B>Returns:</B><DD>RunnerConfig the list of options and parameters supported by a
174          web service.</DL>\r
175 </DD>\r
176 </DL>\r
177 <HR>\r
178 \r
179 <A NAME="getPresets()"><!-- --></A><H3>\r
180 getPresets</H3>\r
181 <PRE>\r
182 <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; <B>getPresets</B>()</PRE>\r
183 <DL>\r
184 <DD>Get presets supported by a web service\r
185 <P>\r
186 <DD><DL>\r
187 \r
188 <DT><B>Returns:</B><DD>PresetManager the object contains information about presets
189          supported by a web service</DL>\r
190 </DD>\r
191 </DL>\r
192 <HR>\r
193 \r
194 <A NAME="getLimit(java.lang.String)"><!-- --></A><H3>\r
195 getLimit</H3>\r
196 <PRE>\r
197 <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; <B>getLimit</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;presetName)</PRE>\r
198 <DL>\r
199 <DD>Get a Limit for a preset.\r
200 <P>\r
201 <DD><DL>\r
202 <DT><B>Parameters:</B><DD><CODE>presetName</CODE> - the name of the preset. if no name is provided, then the
203             default preset is returned. If no limit for a particular
204             preset is defined then the default preset is returned\r
205 <DT><B>Returns:</B><DD>Limit</DL>\r
206 </DD>\r
207 </DL>\r
208 <HR>\r
209 \r
210 <A NAME="getLimits()"><!-- --></A><H3>\r
211 getLimits</H3>\r
212 <PRE>\r
213 <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; <B>getLimits</B>()</PRE>\r
214 <DL>\r
215 <DD>List Limits supported by a web service.\r
216 <P>\r
217 <DD><DL>\r
218 \r
219 <DT><B>Returns:</B><DD>LimitManager</DL>\r
220 </DD>\r
221 </DL>\r
222 <!-- ========= END OF CLASS DATA ========= -->\r
223 <HR>\r
224 \r
225 \r
226 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
227 <A NAME="navbar_bottom"><!-- --></A>\r
228 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
229 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
230 <TR>\r
231 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
232 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
233 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
234   <TR ALIGN="center" VALIGN="top">\r
235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
237   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
238   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Metadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
241   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
243   </TR>\r
244 </TABLE>\r
245 </TD>\r
246 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
247 </EM>\r
248 </TD>\r
249 </TR>\r
250 \r
251 <TR>\r
252 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
253 &nbsp;<A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
254 &nbsp;<A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><B>NEXT CLASS</B></A></FONT></TD>\r
255 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
256   <A HREF="../../../index.html?compbio/data/msa/Metadata.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
257 &nbsp;<A HREF="Metadata.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
258 &nbsp;<SCRIPT type="text/javascript">\r
259   <!--\r
260   if(window==top) {\r
261     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
262   }\r
263   //-->\r
264 </SCRIPT>\r
265 <NOSCRIPT>\r
266   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
267 </NOSCRIPT>\r
268 \r
269 \r
270 </FONT></TD>\r
271 </TR>\r
272 <TR>\r
273 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
274   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
275 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
276 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
277 </TR>\r
278 </TABLE>\r
279 <A NAME="skip-navbar_bottom"></A>\r
280 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
281 \r
282 <HR>\r
283 \r
284 </BODY>\r
285 </HTML>\r