website/dm_javadoc/compbio/ws/client/Jws2Client.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_21) on Thu Dec 09 12:00:28 GMT 2010 -->\r
   6 <TITLE>\r
   7 Jws2Client\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-12-09">\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="Jws2Client";\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/Jws2Client.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/ws/client/IOHelper.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../../compbio/ws/client/MetadataHelper.html" title="class in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../../index.html?compbio/ws/client/Jws2Client.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="Jws2Client.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.ws.client</FONT>\r
  92 <BR>\r
  93 Class Jws2Client</H2>\r
  94 <PRE>\r
  95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
  96   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.ws.client.Jws2Client</B>\r
  97 </PRE>\r
  98 <HR>\r
  99 <DL>\r
 100 <DT><PRE>public class <B>Jws2Client</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
 101 </PRE>\r
 102 \r
 103 <P>\r
 104 A command line client for JAva Bioinformatics Analysis Web Services\r
 105 <P>\r
 106 \r
 107 <P>\r
 108 <DL>\r
 109 <DT><B>Version:</B></DT>\r
 110   <DD>1.0</DD>\r
 111 <DT><B>Author:</B></DT>\r
 112   <DD>pvtroshin</DD>\r
 113 </DL>\r
 114 <HR>\r
 115 \r
 116 <P>\r
 117 \r
 118 <!-- ========== METHOD SUMMARY =========== -->\r
 119 \r
 120 <A NAME="method_summary"><!-- --></A>\r
 121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 124 <B>Method Summary</B></FONT></TH>\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>static&nbsp;<A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A></CODE></FONT></TD>\r
 129 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#connect(java.lang.String, compbio.ws.client.Services)">connect</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;host,\r
 130         <A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)</CODE>\r
 131 \r
 132 <BR>\r
 133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects to a web service by the host and the service name</TD>\r
 134 </TR>\r
 135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 137 <CODE>static&nbsp;void</CODE></FONT></TD>\r
 138 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#main(java.lang.String[])">main</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;args)</CODE>\r
 139 \r
 140 <BR>\r
 141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts command line client, if no parameter are supported print help.</TD>\r
 142 </TR>\r
 143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 145 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
 146 <TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#validURL(java.lang.String)">validURL</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;urlstr)</CODE>\r
 147 \r
 148 <BR>\r
 149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to construct the URL object from the string</TD>\r
 150 </TR>\r
 151 </TABLE>\r
 152 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 153 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 154 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 155 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
 159 </TR>\r
 160 </TABLE>\r
 161 &nbsp;\r
 162 <P>\r
 163 \r
 164 <!-- ============ METHOD DETAIL ========== -->\r
 165 \r
 166 <A NAME="method_detail"><!-- --></A>\r
 167 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 168 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 169 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 170 <B>Method Detail</B></FONT></TH>\r
 171 </TR>\r
 172 </TABLE>\r
 173 \r
 174 <A NAME="validURL(java.lang.String)"><!-- --></A><H3>\r
 175 validURL</H3>\r
 176 <PRE>\r
 177 public static boolean <B>validURL</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;urlstr)</PRE>\r
 178 <DL>\r
 179 <DD>Attempt to construct the URL object from the string\r
 180 <P>\r
 181 <DD><DL>\r
 182 <DT><B>Parameters:</B><DD><CODE>urlstr</CODE> - \r
 183 <DT><B>Returns:</B><DD>true if it succeed false otherwise</DL>\r
 184 </DD>\r
 185 </DL>\r
 186 <HR>\r
 187 \r
 188 <A NAME="connect(java.lang.String, compbio.ws.client.Services)"><!-- --></A><H3>\r
 189 connect</H3>\r
 190 <PRE>\r
 191 public static <A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A> <B>connect</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;host,\r
 192                                   <A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)\r
 193                            throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</A></PRE>\r
 194 <DL>\r
 195 <DD>Connects to a web service by the host and the service name\r
 196 <P>\r
 197 <DD><DL>\r
 198 <DT><B>Type Parameters:</B><DD><CODE>T</CODE> - web service type<DT><B>Parameters:</B><DD><CODE>host</CODE> - <DD><CODE>service</CODE> - \r
 199 <DT><B>Returns:</B><DD>MsaWS<T>\r
 200 <DT><B>Throws:</B>\r
 201 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws">WebServiceException</A></CODE></DL>\r
 202 </DD>\r
 203 </DL>\r
 204 <HR>\r
 205 \r
 206 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
 207 main</H3>\r
 208 <PRE>\r
 209 public static void <B>main</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;args)</PRE>\r
 210 <DL>\r
 211 <DD>Starts command line client, if no parameter are supported print help. Two
 212  parameters are required for successfull call the JWS2 host name and a
 213  service name.\r
 214 <P>\r
 215 <DD><DL>\r
 216 <DT><B>Parameters:</B><DD><CODE>args</CODE> - Usage: <Class or Jar file name> -h=host_and_context
 217             -s=serviceName ACTION [OPTIONS]
 218
 219             -h=<host_and_context> - a full URL to the JWS2 web server
 220             including context path e.g. http://10.31.1.159:8080/ws
 221
 222             -s=<ServiceName> - one of [MafftWS, MuscleWS, ClustalWS,
 223             TcoffeeWS, ProbconsWS] ACTIONS:
 224
 225             -i=<inputFile> - full path to fasta formatted sequence file,
 226             from which to align sequences
 227
 228             -parameters - lists parameters supported by web service
 229
 230             -presets - lists presets supported by web service
 231
 232             -limits - lists web services limits Please note that if input
 233             file is specified other actions are ignored
 234
 235             OPTIONS: (only for use with -i action):
 236
 237             -r=<presetName> - name of the preset to use
 238
 239             -o=<outputFile> - full path to the file where to write an
 240             alignment -f=<parameterInputFile> - the name of the file with
 241             the list of parameters to use. Please note that -r and -f
 242             options cannot be used together. Alignment is done with either
 243             preset or a parameters from the file, but not both!</DL>\r
 244 </DD>\r
 245 </DL>\r
 246 <!-- ========= END OF CLASS DATA ========= -->\r
 247 <HR>\r
 248 \r
 249 \r
 250 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 251 <A NAME="navbar_bottom"><!-- --></A>\r
 252 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 253 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 254 <TR>\r
 255 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 256 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 257 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 258   <TR ALIGN="center" VALIGN="top">\r
 259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 260   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 261   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 262   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Jws2Client.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 263   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 264   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 265   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 266   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 267   </TR>\r
 268 </TABLE>\r
 269 </TD>\r
 270 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 271 </EM>\r
 272 </TD>\r
 273 </TR>\r
 274 \r
 275 <TR>\r
 276 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 277 &nbsp;<A HREF="../../../compbio/ws/client/IOHelper.html" title="class in compbio.ws.client"><B>PREV CLASS</B></A>&nbsp;\r
 278 &nbsp;<A HREF="../../../compbio/ws/client/MetadataHelper.html" title="class in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
 279 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 280   <A HREF="../../../index.html?compbio/ws/client/Jws2Client.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 281 &nbsp;<A HREF="Jws2Client.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 282 &nbsp;<SCRIPT type="text/javascript">\r
 283   <!--\r
 284   if(window==top) {\r
 285     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 286   }\r
 287   //-->\r
 288 </SCRIPT>\r
 289 <NOSCRIPT>\r
 290   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 291 </NOSCRIPT>\r
 292 \r
 293 \r
 294 </FONT></TD>\r
 295 </TR>\r
 296 <TR>\r
 297 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 298   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 299 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 300 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 301 </TR>\r
 302 </TABLE>\r
 303 <A NAME="skip-navbar_bottom"></A>\r
 304 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 305 \r
 306 <HR>\r
 307 \r
 308 </BODY>\r
 309 </HTML>\r