delete old javadoc to update
[jabaws.git] / website / dm_javadoc / compbio / data / sequence / class-use / FastaSequence.html
index 763d648..4b31821 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:19 GMT 2010 -->\r
 <TITLE>\r
 Uses of Class compbio.data.sequence.FastaSequence\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
@@ -90,9 +90,13 @@ function windowTitle()
 Packages that use <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A></FONT></TH>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><A HREF="#compbio.data.msa"><B>compbio.data.msa</B></A></TD>\r
+<TD>Web Service interfaces for JAva Bioinformatics Analysis Web Services.&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD><A HREF="#compbio.data.sequence"><B>compbio.data.sequence</B></A></TD>\r
-<TD>A data model for multiple sequence alignment web services 
- Classes in this package have no dependencies to other sources in the project.&nbsp;</TD>\r
+<TD>A data model for multiple sequence alignment web services and utility methods
+ that work on the objects of this model.&nbsp;</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD><A HREF="#compbio.metadata"><B>compbio.metadata</B></A></TD>\r
@@ -102,6 +106,49 @@ Packages that use <A HREF="../../../../compbio/data/sequence/FastaSequence.html"
 </TABLE>\r
 &nbsp;\r
 <P>\r
+<A NAME="compbio.data.msa"><!-- --></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
+Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A> in <A HREF="../../../../compbio/data/msa/package-summary.html">compbio.data.msa</A></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
+\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2">Method parameters in <A HREF="../../../../compbio/data/msa/package-summary.html">compbio.data.msa</A> with type arguments of type <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&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>MsaWS.</B><B><A HREF="../../../../compbio/data/msa/MsaWS.html#align(java.util.List)">align</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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with default settings.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&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>MsaWS.</B><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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;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>&lt;<A HREF="../../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;&gt;&nbsp;options)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with options.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&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>MsaWS.</B><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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
+            <A HREF="../../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;&nbsp;preset)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with preset.</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
 <A NAME="compbio.data.sequence"><!-- --></A>\r
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
@@ -118,7 +165,7 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>&nbsp;java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></FONT></TD>\r
+<CODE>&nbsp;<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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></FONT></TD>\r
 <TD><CODE><B>Alignment.</B><B><A HREF="../../../../compbio/data/sequence/Alignment.html#getSequences()">getSequences</A></B>()</CODE>\r
 \r
 <BR>\r
@@ -126,8 +173,8 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>static&nbsp;java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></FONT></TD>\r
-<TD><CODE><B>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#readFasta(java.io.InputStream)">readFasta</A></B>(java.io.InputStream&nbsp;inStream)</CODE>\r
+<CODE>static&nbsp;<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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></FONT></TD>\r
+<TD><CODE><B>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#readFasta(java.io.InputStream)">readFasta</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A>&nbsp;inStream)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads fasta sequences from inStream into the list of FastaSequence
@@ -160,8 +207,8 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 <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>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#writeFasta(java.io.OutputStream, java.util.List)">writeFasta</A></B>(java.io.OutputStream&nbsp;os,\r
-           java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)</CODE>\r
+<TD><CODE><B>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#writeFasta(java.io.OutputStream, java.util.List)">writeFasta</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;os,\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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes FastaSequence in the file, each sequence will take one line only</TD>\r
@@ -169,14 +216,24 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 <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>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#writeFasta(java.io.OutputStream, java.util.List, int)">writeFasta</A></B>(java.io.OutputStream&nbsp;outstream,\r
-           java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
+<TD><CODE><B>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#writeFasta(java.io.OutputStream, java.util.List, int)">writeFasta</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;outstream,\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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
            int&nbsp;width)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes list of FastaSequeces into the outstream formatting the sequence
  so that it contains width chars on each 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;void</CODE></FONT></TD>\r
+<TD><CODE><B>SequenceUtil.</B><B><A HREF="../../../../compbio/data/sequence/SequenceUtil.html#writeFastaKeepTheStream(java.io.OutputStream, java.util.List, int)">writeFastaKeepTheStream</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;outstream,\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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
+                        int&nbsp;width)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
 </TABLE>\r
 &nbsp;\r
 <P>\r
@@ -186,14 +243,14 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 <TH ALIGN="left" COLSPAN="2">Constructor parameters in <A HREF="../../../../compbio/data/sequence/package-summary.html">compbio.data.sequence</A> with type arguments of type <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A></FONT></TH>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE><B><A HREF="../../../../compbio/data/sequence/Alignment.html#Alignment(java.util.List, compbio.data.sequence.AlignmentMetadata)">Alignment</A></B>(java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
+<TD><CODE><B><A HREF="../../../../compbio/data/sequence/Alignment.html#Alignment(java.util.List, compbio.data.sequence.AlignmentMetadata)">Alignment</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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
           <A HREF="../../../../compbio/data/sequence/AlignmentMetadata.html" title="class in compbio.data.sequence">AlignmentMetadata</A>&nbsp;metadata)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE><B><A HREF="../../../../compbio/data/sequence/Alignment.html#Alignment(java.util.List, compbio.data.sequence.Program, char)">Alignment</A></B>(java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
+<TD><CODE><B><A HREF="../../../../compbio/data/sequence/Alignment.html#Alignment(java.util.List, compbio.data.sequence.Program, char)">Alignment</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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
           <A HREF="../../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</A>&nbsp;program,\r
           char&nbsp;gapchar)</CODE>\r
 \r
@@ -220,7 +277,7 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;int</CODE></FONT></TD>\r
-<TD><CODE><B>Limit.</B><B><A HREF="../../../../compbio/metadata/Limit.html#getAvgSequenceLength(java.util.List)">getAvgSequenceLength</A></B>(java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;data)</CODE>\r
+<TD><CODE><B>Limit.</B><B><A HREF="../../../../compbio/metadata/Limit.html#getAvgSequenceLength(java.util.List)">getAvgSequenceLength</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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;data)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calculates an average sequence length of the dataset</TD>\r
@@ -228,17 +285,17 @@ Uses of <A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="cl
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
-<TD><CODE><B>Limit.</B><B><A HREF="../../../../compbio/metadata/Limit.html#isExceeded(java.util.List)">isExceeded</A></B>(java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;data)</CODE>\r
+<TD><CODE><B>Limit.</B><B><A HREF="../../../../compbio/metadata/Limit.html#isExceeded(java.util.List)">isExceeded</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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;data)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the number of sequences or their average length in the dataset
- exceeds limits the values defined by this Limit</TD>\r
+ exceeds this limit.</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;<A HREF="../../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE></FONT></TD>\r
 <TD><CODE><B>LimitExceededException.</B><B><A HREF="../../../../compbio/metadata/LimitExceededException.html#newLimitExceeded(compbio.metadata.Limit, java.util.List)">newLimitExceeded</A></B>(<A HREF="../../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;?&gt;&nbsp;limit,\r
-                 java.util.List&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;seqs)</CODE>\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>&lt;<A HREF="../../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;seqs)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r