Refactored client class to accomodate new WS interface and reduce the complexity
[jabaws.git] / website / dm_javadoc / compbio / ws / client / Jws2Client.html
index dc8778a..85d990f 100644 (file)
@@ -2,12 +2,12 @@
 <!--NewPage-->\r
 <HTML>\r
 <HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:28 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_21) on Wed Nov 24 12:17:18 GMT 2010 -->\r
 <TITLE>\r
 Jws2Client\r
 </TITLE>\r
 \r
-<META NAME="date" CONTENT="2010-02-17">\r
+<META NAME="date" CONTENT="2010-11-24">\r
 \r
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
 \r
@@ -56,7 +56,7 @@ function windowTitle()
 <TR>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 &nbsp;PREV CLASS&nbsp;\r
-&nbsp;<A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
+&nbsp;<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
   <A HREF="../../../index.html?compbio/ws/client/Jws2Client.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 &nbsp;<A HREF="Jws2Client.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
@@ -76,7 +76,7 @@ function windowTitle()
 </TR>\r
 <TR>\r
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 </TR>\r
@@ -92,44 +92,29 @@ compbio.ws.client</FONT>
 <BR>\r
 Class Jws2Client</H2>\r
 <PRE>\r
-java.lang.Object\r
+<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
   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.ws.client.Jws2Client</B>\r
 </PRE>\r
 <HR>\r
 <DL>\r
-<DT><PRE>public class <B>Jws2Client</B><DT>extends java.lang.Object</DL>\r
+<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
 </PRE>\r
 \r
 <P>\r
-A command line client for Jalview Web Services version 2\r
+A command line client for JAva Bioinformatics Analysis Web Services\r
 <P>\r
 \r
 <P>\r
 <DL>\r
+<DT><B>Version:</B></DT>\r
+  <DD>1.0</DD>\r
 <DT><B>Author:</B></DT>\r
   <DD>pvtroshin</DD>\r
 </DL>\r
 <HR>\r
 \r
 <P>\r
-<!-- ======== NESTED CLASS SUMMARY ======== -->\r
 \r
-<A NAME="nested_class_summary"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
-<B>Nested Class Summary</B></FONT></TH>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>static&nbsp;class</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client">Jws2Client.Services</A></B></CODE>\r
-\r
-<BR>\r
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List of web services currently supported by JWS2</TD>\r
-</TR>\r
-</TABLE>\r
-&nbsp;\r
 <!-- ========== METHOD SUMMARY =========== -->\r
 \r
 <A NAME="method_summary"><!-- --></A>\r
@@ -144,28 +129,28 @@ A command line client for Jalview Web Services version 2
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">\r
 <TR ALIGN="right" VALIGN="">\r
 <TD NOWRAP><FONT SIZE="-1">\r
-<CODE>&lt;T&gt; compbio.data.msa.MsaWS&lt;T&gt;</CODE></FONT></TD>\r
+<CODE>&lt;T&gt; <A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;T&gt;</CODE></FONT></TD>\r
 </TR>\r
 </TABLE>\r
 </CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#connect(java.lang.String, compbio.ws.client.Jws2Client.Services)">connect</A></B>(java.lang.String&nbsp;host,\r
-        <A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client">Jws2Client.Services</A>&nbsp;service)</CODE>\r
+<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
+        <A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects to a web service by the host and the service name</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getHost(java.lang.String[])">getHost</A></B>(java.lang.String[]&nbsp;cmd)</CODE>\r
+<CODE>static&nbsp;<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></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getHost(java.lang.String[])">getHost</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;cmd)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts host name from the command line</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getServiceName(java.lang.String[])">getServiceName</A></B>(java.lang.String[]&nbsp;cmd)</CODE>\r
+<CODE>static&nbsp;<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></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#getServiceName(java.lang.String[])">getServiceName</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;cmd)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts service name from the command line</TD>\r
@@ -173,7 +158,7 @@ A command line client for Jalview Web Services version 2
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;void</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts command line client, if no parameter are supported print help.</TD>\r
@@ -181,7 +166,7 @@ A command line client for Jalview Web Services version 2
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../compbio/ws/client/Jws2Client.html#validURL(java.lang.String)">validURL</A></B>(java.lang.String&nbsp;urlstr)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempt to construct the URL object from the string</TD>\r
@@ -190,10 +175,10 @@ A command line client for Jalview Web Services version 2
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+<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
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
+<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <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#finalize()" title="class or interface in java.lang">finalize</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
 </TR>\r
 </TABLE>\r
 &nbsp;\r
@@ -212,7 +197,7 @@ A command line client for Jalview Web Services version 2
 <A NAME="validURL(java.lang.String)"><!-- --></A><H3>\r
 validURL</H3>\r
 <PRE>\r
-public static boolean <B>validURL</B>(java.lang.String&nbsp;urlstr)</PRE>\r
+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
 <DL>\r
 <DD>Attempt to construct the URL object from the string\r
 <P>\r
@@ -226,7 +211,7 @@ public static boolean <B>validURL</B>(java.lang.String&nbsp;urlstr)</PRE>
 <A NAME="getServiceName(java.lang.String[])"><!-- --></A><H3>\r
 getServiceName</H3>\r
 <PRE>\r
-public static java.lang.String <B>getServiceName</B>(java.lang.String[]&nbsp;cmd)</PRE>\r
+public static <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> <B>getServiceName</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;cmd)</PRE>\r
 <DL>\r
 <DD>Extracts service name from the command line\r
 <P>\r
@@ -240,7 +225,7 @@ public static java.lang.String <B>getServiceName</B>(java.lang.String[]&nbsp;cmd
 <A NAME="getHost(java.lang.String[])"><!-- --></A><H3>\r
 getHost</H3>\r
 <PRE>\r
-public static java.lang.String <B>getHost</B>(java.lang.String[]&nbsp;cmd)</PRE>\r
+public static <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> <B>getHost</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;cmd)</PRE>\r
 <DL>\r
 <DD>Extracts host name from the command line\r
 <P>\r
@@ -251,12 +236,12 @@ public static java.lang.String <B>getHost</B>(java.lang.String[]&nbsp;cmd)</PRE>
 </DL>\r
 <HR>\r
 \r
-<A NAME="connect(java.lang.String, compbio.ws.client.Jws2Client.Services)"><!-- --></A><H3>\r
+<A NAME="connect(java.lang.String, compbio.ws.client.Services)"><!-- --></A><H3>\r
 connect</H3>\r
 <PRE>\r
-public static &lt;T&gt; compbio.data.msa.MsaWS&lt;T&gt; <B>connect</B>(java.lang.String&nbsp;host,\r
-                                                    <A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client">Jws2Client.Services</A>&nbsp;service)\r
-                                         throws javax.xml.ws.WebServiceException</PRE>\r
+public static &lt;T&gt; <A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;T&gt; <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
+                                   <A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>&nbsp;service)\r
+                        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
 <DL>\r
 <DD>Connects to a web service by the host and the service name\r
 <P>\r
@@ -264,7 +249,7 @@ public static &lt;T&gt; compbio.data.msa.MsaWS&lt;T&gt; <B>connect</B>(java.lang
 <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
 <DT><B>Returns:</B><DD>MsaWS<T>\r
 <DT><B>Throws:</B>\r
-<DD><CODE>javax.xml.ws.WebServiceException</CODE></DL>\r
+<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
 </DD>\r
 </DL>\r
 <HR>\r
@@ -272,7 +257,7 @@ public static &lt;T&gt; compbio.data.msa.MsaWS&lt;T&gt; <B>connect</B>(java.lang
 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
 main</H3>\r
 <PRE>\r
-public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
+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
 <DL>\r
 <DD>Starts command line client, if no parameter are supported print help. Two
  parameters are required for successfull call the JWS2 host name and a
@@ -341,7 +326,7 @@ public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
 <TR>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 &nbsp;PREV CLASS&nbsp;\r
-&nbsp;<A HREF="../../../compbio/ws/client/Jws2Client.Services.html" title="enum in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
+&nbsp;<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
   <A HREF="../../../index.html?compbio/ws/client/Jws2Client.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 &nbsp;<A HREF="Jws2Client.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
@@ -361,7 +346,7 @@ public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
 </TR>\r
 <TR>\r
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 </TR>\r