website/full_javadoc/compbio/ws/client/AAConClient.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:34 BST 2011 -->\r
   6 <TITLE>\r
   7 AAConClient\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="AAConClient";\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/AAConClient.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;PREV CLASS&nbsp;\r
  59 &nbsp;<A HREF="../../../compbio/ws/client/IOHelper.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/AAConClient.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="AAConClient.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 AAConClient</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.AAConClient</B>\r
  97 </PRE>\r
  98 <HR>\r
  99 <DL>\r
 100 <DT><PRE>public class <B>AAConClient</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 AACon web service\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/SequenceAnnotation.html" title="interface in compbio.data.msa">SequenceAnnotation</A>&lt;<A HREF="../../../compbio/ws/server/AAConWS.html" title="class in compbio.ws.server">AAConWS</A>&gt;</CODE></FONT></TD>\r
 129 <TD><CODE><B><A HREF="../../../compbio/ws/client/AAConClient.html#connect()">connect</A></B>()</CODE>\r
 130 \r
 131 <BR>\r
 132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects to a AACon web service by the host and the service name</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>static&nbsp;void</CODE></FONT></TD>\r
 137 <TD><CODE><B><A HREF="../../../compbio/ws/client/AAConClient.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
 138 \r
 139 <BR>\r
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts command line client, if no parameters are supplied prints help.</TD>\r
 141 </TR>\r
 142 </TABLE>\r
 143 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 145 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 146 <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
 147 </TR>\r
 148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 149 <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
 150 </TR>\r
 151 </TABLE>\r
 152 &nbsp;\r
 153 <P>\r
 154 \r
 155 <!-- ============ METHOD DETAIL ========== -->\r
 156 \r
 157 <A NAME="method_detail"><!-- --></A>\r
 158 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 159 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 160 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 161 <B>Method Detail</B></FONT></TH>\r
 162 </TR>\r
 163 </TABLE>\r
 164 \r
 165 <A NAME="connect()"><!-- --></A><H3>\r
 166 connect</H3>\r
 167 <PRE>\r
 168 public static <A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa">SequenceAnnotation</A>&lt;<A HREF="../../../compbio/ws/server/AAConWS.html" title="class in compbio.ws.server">AAConWS</A>&gt; <B>connect</B>()\r
 169                                            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
 170 <DL>\r
 171 <DD>Connects to a AACon web service by the host and the service name\r
 172 <P>\r
 173 <DD><DL>\r
 174 \r
 175 <DT><B>Returns:</B><DD><CODE>AlignmentAnnotation</CODE>\r
 176 <DT><B>Throws:</B>\r
 177 <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> - if cannot connect to a web service</DL>\r
 178 </DD>\r
 179 </DL>\r
 180 <HR>\r
 181 \r
 182 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
 183 main</H3>\r
 184 <PRE>\r
 185 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
 186 <DL>\r
 187 <DD>Starts command line client, if no parameters are supplied prints help.\r
 188 <P>\r
 189 <DD><DL>\r
 190 <DT><B>Parameters:</B><DD><CODE>args</CODE> - Usage: <Class or Jar file name> ACTION [OPTIONS]
 191
 192             -i=<inputFile> - full path to fasta or Clustal formatted
 193             alignment file
 194
 195             -parameters - lists parameters supported by web service
 196
 197             -presets - lists presets supported by web service
 198
 199             -limits - lists web services limits. Please note that if input
 200             file is specified other actions are ignored
 201
 202             OPTIONS: (only for use with -i action):
 203
 204             -r=<presetName> - name of the preset to use
 205
 206             -o=<outputFile> - full path to the file where to write results
 207             -f=<parameterInputFile> - the name of the file with the list
 208             of parameters to use. Please note that -r and -f options
 209             cannot be used together. Conservation is calculated with
 210             either a preset or parameters from the file, but not both!</DL>\r
 211 </DD>\r
 212 </DL>\r
 213 <!-- ========= END OF CLASS DATA ========= -->\r
 214 <HR>\r
 215 \r
 216 \r
 217 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 218 <A NAME="navbar_bottom"><!-- --></A>\r
 219 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 220 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 221 <TR>\r
 222 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 223 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 224 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 225   <TR ALIGN="center" VALIGN="top">\r
 226   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 227   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 228   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AAConClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 230   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 231   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 232   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 234   </TR>\r
 235 </TABLE>\r
 236 </TD>\r
 237 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 238 </EM>\r
 239 </TD>\r
 240 </TR>\r
 241 \r
 242 <TR>\r
 243 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 244 &nbsp;PREV CLASS&nbsp;\r
 245 &nbsp;<A HREF="../../../compbio/ws/client/IOHelper.html" title="class in compbio.ws.client"><B>NEXT CLASS</B></A></FONT></TD>\r
 246 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 247   <A HREF="../../../index.html?compbio/ws/client/AAConClient.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 248 &nbsp;<A HREF="AAConClient.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 249 &nbsp;<SCRIPT type="text/javascript">\r
 250   <!--\r
 251   if(window==top) {\r
 252     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 253   }\r
 254   //-->\r
 255 </SCRIPT>\r
 256 <NOSCRIPT>\r
 257   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 258 </NOSCRIPT>\r
 259 \r
 260 \r
 261 </FONT></TD>\r
 262 </TR>\r
 263 <TR>\r
 264 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 265   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 266 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 267 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 268 </TR>\r
 269 </TABLE>\r
 270 <A NAME="skip-navbar_bottom"></A>\r
 271 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 272 \r
 273 <HR>\r
 274 \r
 275 </BODY>\r
 276 </HTML>\r