Replacing web site content with fresh version from JWS2 (JABAWS production ) branch
[jabaws.git] / website / full_javadoc / compbio / data / sequence / SequenceUtil.html
diff --git a/website/full_javadoc/compbio/data/sequence/SequenceUtil.html b/website/full_javadoc/compbio/data/sequence/SequenceUtil.html
new file mode 100644 (file)
index 0000000..a7bdf1a
--- /dev/null
@@ -0,0 +1,624 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:49 GMT 2010 -->\r
+<TITLE>\r
+SequenceUtil\r
+</TITLE>\r
+\r
+<META NAME="date" CONTENT="2010-02-17">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+    if (location.href.indexOf('is-external=true') == -1) {\r
+        parent.document.title="SequenceUtil";\r
+    }\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+<HR>\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SequenceUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../../compbio/data/sequence/UnknownFileFormatException.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../../index.html?compbio/data/sequence/SequenceUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="SequenceUtil.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+compbio.data.sequence</FONT>\r
+<BR>\r
+Class SequenceUtil</H2>\r
+<PRE>\r
+java.lang.Object\r
+  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.data.sequence.SequenceUtil</B>\r
+</PRE>\r
+<HR>\r
+<DL>\r
+<DT><PRE>public final class <B>SequenceUtil</B><DT>extends java.lang.Object</DL>\r
+</PRE>\r
+\r
+<P>\r
+Utility class for operations on sequences\r
+<P>\r
+\r
+<P>\r
+<DL>\r
+<DT><B>Author:</B></DT>\r
+  <DD>pvtroshin
+         Date September 2009</DD>\r
+</DL>\r
+<HR>\r
+\r
+<P>\r
+<!-- =========== FIELD SUMMARY =========== -->\r
+\r
+<A NAME="field_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>Field 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;java.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#AA">AA</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Valid Amino acids</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#AMBIGUOUS_AA">AMBIGUOUS_AA</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Same as AA pattern but with two additional letters - XU</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#AMBIGUOUS_NUCLEOTIDE">AMBIGUOUS_NUCLEOTIDE</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ambiguous nucleotide</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#DIGIT">DIGIT</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A digit</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#NON_AA">NON_AA</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;inversion of AA pattern</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#NON_NUCLEOTIDE">NON_NUCLEOTIDE</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Non nucleotide</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#NONWORD">NONWORD</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Non word</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#NUCLEOTIDE">NUCLEOTIDE</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Nucleotides a, t, g, c, u</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.util.regex.Pattern</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#WHITE_SPACE">WHITE_SPACE</A></B></CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A whitespace character: [\t\n\x0B\f\r]</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_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>Method 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;java.lang.String</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#cleanSequence(java.lang.String)">cleanSequence</A></B>(java.lang.String&nbsp;sequence)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all whitespace chars in the sequence string</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/data/sequence/SequenceUtil.html#deepCleanSequence(java.lang.String)">deepCleanSequence</A></B>(java.lang.String&nbsp;sequence)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all special characters and digits as well as whitespace chars
+ from the sequence</TD>\r
+</TR>\r
+<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/data/sequence/SequenceUtil.html#isAmbiguosProtein(java.lang.String)">isAmbiguosProtein</A></B>(java.lang.String&nbsp;sequence)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether the sequence confirms to amboguous protein sequence</TD>\r
+</TR>\r
+<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/data/sequence/SequenceUtil.html#isNonAmbNucleotideSequence(java.lang.String)">isNonAmbNucleotideSequence</A></B>(java.lang.String&nbsp;sequence)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ambiguous DNA chars : AGTCRYMKSWHBVDN // differs from protein in only one
+ (!) - B char</TD>\r
+</TR>\r
+<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/data/sequence/SequenceUtil.html#isNucleotideSequence(compbio.data.sequence.FastaSequence)">isNucleotideSequence</A></B>(<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&nbsp;s)</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>static&nbsp;boolean</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/sequence/SequenceUtil.html#isProteinSequence(java.lang.String)">isProteinSequence</A></B>(java.lang.String&nbsp;sequence)</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 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><A HREF="../../../compbio/data/sequence/SequenceUtil.html#readFasta(java.io.InputStream)">readFasta</A></B>(java.io.InputStream&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
+ objects</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><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
+\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
+</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><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
+           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
+</TABLE>\r
+&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
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
+\r
+<!-- ============ FIELD DETAIL =========== -->\r
+\r
+<A NAME="field_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Field Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="WHITE_SPACE"><!-- --></A><H3>\r
+WHITE_SPACE</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>WHITE_SPACE</B></PRE>\r
+<DL>\r
+<DD>A whitespace character: [\t\n\x0B\f\r]\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="DIGIT"><!-- --></A><H3>\r
+DIGIT</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>DIGIT</B></PRE>\r
+<DL>\r
+<DD>A digit\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NONWORD"><!-- --></A><H3>\r
+NONWORD</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>NONWORD</B></PRE>\r
+<DL>\r
+<DD>Non word\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="AA"><!-- --></A><H3>\r
+AA</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>AA</B></PRE>\r
+<DL>\r
+<DD>Valid Amino acids\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NON_AA"><!-- --></A><H3>\r
+NON_AA</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>NON_AA</B></PRE>\r
+<DL>\r
+<DD>inversion of AA pattern\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="AMBIGUOUS_AA"><!-- --></A><H3>\r
+AMBIGUOUS_AA</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>AMBIGUOUS_AA</B></PRE>\r
+<DL>\r
+<DD>Same as AA pattern but with two additional letters - XU\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NUCLEOTIDE"><!-- --></A><H3>\r
+NUCLEOTIDE</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>NUCLEOTIDE</B></PRE>\r
+<DL>\r
+<DD>Nucleotides a, t, g, c, u\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="AMBIGUOUS_NUCLEOTIDE"><!-- --></A><H3>\r
+AMBIGUOUS_NUCLEOTIDE</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>AMBIGUOUS_NUCLEOTIDE</B></PRE>\r
+<DL>\r
+<DD>Ambiguous nucleotide\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="NON_NUCLEOTIDE"><!-- --></A><H3>\r
+NON_NUCLEOTIDE</H3>\r
+<PRE>\r
+public static final java.util.regex.Pattern <B>NON_NUCLEOTIDE</B></PRE>\r
+<DL>\r
+<DD>Non nucleotide\r
+<P>\r
+<DL>\r
+</DL>\r
+</DL>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="isNucleotideSequence(compbio.data.sequence.FastaSequence)"><!-- --></A><H3>\r
+isNucleotideSequence</H3>\r
+<PRE>\r
+public static boolean <B>isNucleotideSequence</B>(<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&nbsp;s)</PRE>\r
+<DL>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>true is the sequence contains only letters a,c, t, g, u</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="isNonAmbNucleotideSequence(java.lang.String)"><!-- --></A><H3>\r
+isNonAmbNucleotideSequence</H3>\r
+<PRE>\r
+public static boolean <B>isNonAmbNucleotideSequence</B>(java.lang.String&nbsp;sequence)</PRE>\r
+<DL>\r
+<DD>Ambiguous DNA chars : AGTCRYMKSWHBVDN // differs from protein in only one
+ (!) - B char\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="cleanSequence(java.lang.String)"><!-- --></A><H3>\r
+cleanSequence</H3>\r
+<PRE>\r
+public static java.lang.String <B>cleanSequence</B>(java.lang.String&nbsp;sequence)</PRE>\r
+<DL>\r
+<DD>Removes all whitespace chars in the sequence string\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - \r
+<DT><B>Returns:</B><DD>cleaned up sequence</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="deepCleanSequence(java.lang.String)"><!-- --></A><H3>\r
+deepCleanSequence</H3>\r
+<PRE>\r
+public static java.lang.String <B>deepCleanSequence</B>(java.lang.String&nbsp;sequence)</PRE>\r
+<DL>\r
+<DD>Removes all special characters and digits as well as whitespace chars
+ from the sequence\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - \r
+<DT><B>Returns:</B><DD>cleaned up sequence</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="isProteinSequence(java.lang.String)"><!-- --></A><H3>\r
+isProteinSequence</H3>\r
+<PRE>\r
+public static boolean <B>isProteinSequence</B>(java.lang.String&nbsp;sequence)</PRE>\r
+<DL>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - \r
+<DT><B>Returns:</B><DD>true is the sequence is a protein sequence, false overwise</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="isAmbiguosProtein(java.lang.String)"><!-- --></A><H3>\r
+isAmbiguosProtein</H3>\r
+<PRE>\r
+public static boolean <B>isAmbiguosProtein</B>(java.lang.String&nbsp;sequence)</PRE>\r
+<DL>\r
+<DD>Check whether the sequence confirms to amboguous protein sequence\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - \r
+<DT><B>Returns:</B><DD>return true only if the sequence if ambiguous protein sequence
+         Return false otherwise. e.g. if the sequence is non-ambiguous
+         protein or DNA</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="writeFasta(java.io.OutputStream, java.util.List, int)"><!-- --></A><H3>\r
+writeFasta</H3>\r
+<PRE>\r
+public static void <B>writeFasta</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
+                              int&nbsp;width)\r
+                       throws java.io.IOException</PRE>\r
+<DL>\r
+<DD>Writes list of FastaSequeces into the outstream formatting the sequence
+ so that it contains width chars on each line\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>outstream</CODE> - <DD><CODE>sequences</CODE> - <DD><CODE>width</CODE> - - the maximum number of characters to write in one line\r
+<DT><B>Throws:</B>\r
+<DD><CODE>java.io.IOException</CODE></DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="readFasta(java.io.InputStream)"><!-- --></A><H3>\r
+readFasta</H3>\r
+<PRE>\r
+public static java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt; <B>readFasta</B>(java.io.InputStream&nbsp;inStream)\r
+                                               throws java.io.IOException</PRE>\r
+<DL>\r
+<DD>Reads fasta sequences from inStream into the list of FastaSequence
+ objects\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>inStream</CODE> - from\r
+<DT><B>Returns:</B><DD>list of FastaSequence objects\r
+<DT><B>Throws:</B>\r
+<DD><CODE>java.io.IOException</CODE></DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="writeFasta(java.io.OutputStream, java.util.List)"><!-- --></A><H3>\r
+writeFasta</H3>\r
+<PRE>\r
+public static void <B>writeFasta</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)\r
+                       throws java.io.IOException</PRE>\r
+<DL>\r
+<DD>Writes FastaSequence in the file, each sequence will take one line only\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>os</CODE> - <DD><CODE>sequences</CODE> - \r
+<DT><B>Throws:</B>\r
+<DD><CODE>java.io.IOException</CODE></DL>\r
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SequenceUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../../compbio/data/sequence/UnknownFileFormatException.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../../index.html?compbio/data/sequence/SequenceUtil.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="SequenceUtil.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r