<!--NewPage-->\r
<HTML>\r
<HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_21) on Thu Dec 09 12:00:29 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_21) on Wed Nov 24 12:17:18 GMT 2010 -->\r
<TITLE>\r
MsaWS\r
</TITLE>\r
\r
-<META NAME="date" CONTENT="2010-12-09">\r
+<META NAME="date" CONTENT="2010-11-24">\r
\r
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
\r
\r
<TR>\r
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A> \r
+ PREV CLASS \r
NEXT CLASS</FONT></TD>\r
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
<A HREF="../../../index.html?compbio/data/msa/MsaWS.html" target="_top"><B>FRAMES</B></A> \r
Interface MsaWS<T></H2>\r
<DL>\r
<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type / web service type</DL>\r
-<DL>\r
-<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A>, <A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A>, <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A><T></DD>\r
-</DL>\r
<HR>\r
<DL>\r
-<DT><PRE>public interface <B>MsaWS<T></B><DT>extends <A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A>, <A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A>, <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A><T></DL>\r
+<DT><PRE>public interface <B>MsaWS<T></B></DL>\r
</PRE>\r
\r
<P>\r
\r
<P>\r
<DL>\r
+<DT><B>Version:</B></DT>\r
+ <DD>1.0 September 2009</DD>\r
<DT><B>Author:</B></DT>\r
- <DD>pvtroshin
-
- Date November 2010</DD>\r
+ <DD>pvtroshin</DD>\r
</DL>\r
<HR>\r
\r
</TR>\r
<TR BGCOLOR="white" CLASS="TableRowColor">\r
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> boolean</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#cancelJob(java.lang.String)">cancelJob</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> jobId)</CODE>\r
+\r
+<BR>\r
+ Stop running the job <code>jobId</code> but leave its output untouched</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
<CODE> <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/data/msa/MsaWS.html#customAlign(java.util.List, java.util.List)">customAlign</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences,\r
<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>>> options)</CODE>\r
</TR>\r
<TR BGCOLOR="white" CLASS="TableRowColor">\r
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getJobStatus(java.lang.String)">getJobStatus</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> jobId)</CODE>\r
+\r
+<BR>\r
+ Return the status of the job.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.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> presetName)</CODE>\r
+\r
+<BR>\r
+ Get a Limit for a preset.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getLimits()">getLimits</A></B>()</CODE>\r
+\r
+<BR>\r
+ List Limits supported by a web service.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getPresets()">getPresets</A></B>()</CODE>\r
+\r
+<BR>\r
+ Get presets supported by a web service</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
<CODE> <A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A></CODE></FONT></TD>\r
<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getResult(java.lang.String)">getResult</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> jobId)</CODE>\r
\r
</TR>\r
<TR BGCOLOR="white" CLASS="TableRowColor">\r
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getRunnerOptions()">getRunnerOptions</A></B>()</CODE>\r
+\r
+<BR>\r
+ Get options supported by a web service</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
<CODE> <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/data/msa/MsaWS.html#presetAlign(java.util.List, compbio.metadata.Preset)">presetAlign</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences,\r
<A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>> preset)</CODE>\r
<BR>\r
Align a list of sequences with preset.</TD>\r
</TR>\r
-</TABLE>\r
- <A NAME="methods_inherited_from_class_compbio.data.msa.JManagement"><!-- --></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 interface compbio.data.msa.<A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A></B></TH>\r
-</TR>\r
<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE><A HREF="../../../compbio/data/msa/JManagement.html#cancelJob(java.lang.String)">cancelJob</A>, <A HREF="../../../compbio/data/msa/JManagement.html#getJobStatus(java.lang.String)">getJobStatus</A>, <A HREF="../../../compbio/data/msa/JManagement.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</A></CODE></TD>\r
-</TR>\r
-</TABLE>\r
- <A NAME="methods_inherited_from_class_compbio.data.msa.Metadata"><!-- --></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 interface compbio.data.msa.<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A></B></TH>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE><A HREF="../../../compbio/data/msa/Metadata.html#getLimit(java.lang.String)">getLimit</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getLimits()">getLimits</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getPresets()">getPresets</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getRunnerOptions()">getRunnerOptions</A></CODE></TD>\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</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> jobId,\r
+ long position)</CODE>\r
+\r
+<BR>\r
+ Reads 1kb chunk from the statistics file which is specific to a given web
+ service from the <code>position</code>.</TD>\r
</TR>\r
</TABLE>\r
\r
JobSubmissionException will be thrown.\r
<P>\r
<DD><DL>\r
-</DL>\r
-</DD>\r
-<DD><DL>\r
<DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
any sequence validity checks. Nor does it checks whether the
sequences names are unique. It is responsibility of the caller
<DD>Align a list of sequences with options.\r
<P>\r
<DD><DL>\r
-</DL>\r
-</DD>\r
-<DD><DL>\r
<DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
any sequence validity checks. Nor does it checks whether the
sequences names are unique. It is responsibility of the caller
is used.\r
<P>\r
<DD><DL>\r
-</DL>\r
-</DD>\r
-<DD><DL>\r
<DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
any sequence validity checks. Nor does it checks whether the
sequences names are unique. It is responsibility of the caller
<code>jobId</code> to complete before return.\r
<P>\r
<DD><DL>\r
-</DL>\r
-</DD>\r
-<DD><DL>\r
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
<DT><B>Returns:</B><DD>Alignment\r
<DT><B>Throws:</B>\r
format</DL>\r
</DD>\r
</DL>\r
+<HR>\r
+\r
+<A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
+cancelJob</H3>\r
+<PRE>\r
+boolean <B>cancelJob</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> jobId)</PRE>\r
+<DL>\r
+<DD>Stop running the job <code>jobId</code> but leave its output untouched\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - is thrown if jobId is empty or cannot be recognised e.g. in
+ invalid format</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
+getJobStatus</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</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> jobId)</PRE>\r
+<DL>\r
+<DD>Return the status of the job.\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier\r
+<DT><B>Returns:</B><DD>JobStatus - status of the job\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - is thrown if jobId is empty or cannot be recognised e.g. in
+ invalid format<DT><B>See Also:</B><DD><A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata"><CODE>JobStatus</CODE></A></DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="pullExecStatistics(java.lang.String, long)"><!-- --></A><H3>\r
+pullExecStatistics</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pullExecStatistics</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> jobId,\r
+ long position)</PRE>\r
+<DL>\r
+<DD>Reads 1kb chunk from the statistics file which is specific to a given web
+ service from the <code>position</code>. If in time of a request less then
+ 1kb data is available from the position to the end of the file, then it
+ returns all the data available from the position to the end of the file.\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier<DD><CODE>position</CODE> - - next position within the file to read\r
+<DT><B>Returns:</B><DD>ChunkHolder - which contains a chunk of data and a next position
+ within the file from which no data has been read\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - thrown if jobId is empty or cannot be recognised e.g. in
+ invalid format and also if the position value is negative<DT><B>See Also:</B><DD><A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata"><CODE>ChunkHolder</CODE></A></DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getRunnerOptions()"><!-- --></A><H3>\r
+getRunnerOptions</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>> <B>getRunnerOptions</B>()</PRE>\r
+<DL>\r
+<DD>Get options supported by a web service\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>RunnerConfig the list of options and parameters supported by a
+ web service.</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getPresets()"><!-- --></A><H3>\r
+getPresets</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>> <B>getPresets</B>()</PRE>\r
+<DL>\r
+<DD>Get presets supported by a web service\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>PresetManager the object contains information about presets
+ supported by a web service</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getLimit(java.lang.String)"><!-- --></A><H3>\r
+getLimit</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>> <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> presetName)</PRE>\r
+<DL>\r
+<DD>Get a Limit for a preset.\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>presetName</CODE> - the name of the preset. if no name is provided, then the
+ default preset is returned. If no limit for a particular
+ preset is defined then the default preset is returned\r
+<DT><B>Returns:</B><DD>Limit</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getLimits()"><!-- --></A><H3>\r
+getLimits</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager</A><<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>> <B>getLimits</B>()</PRE>\r
+<DL>\r
+<DD>List Limits supported by a web service.\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>LimitManager</DL>\r
+</DD>\r
+</DL>\r
<!-- ========= END OF CLASS DATA ========= -->\r
<HR>\r
\r
\r
<TR>\r
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A> \r
+ PREV CLASS \r
NEXT CLASS</FONT></TD>\r
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
<A HREF="../../../index.html?compbio/data/msa/MsaWS.html" target="_top"><B>FRAMES</B></A> \r
git://source.jalview.org / jabaws.git / blobdiff