1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:08:24 GMT 2011 -->
\r
10 <META NAME="date" CONTENT="2011-12-07">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="FastaReader";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FastaReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../compbio/data/sequence/DisorderMethod.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../../index.html?compbio/data/sequence/FastaReader.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="FastaReader.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.data.sequence</FONT>
\r
93 Class FastaReader</H2>
\r
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.data.sequence.FastaReader</B>
\r
99 <DT><B>All Implemented Interfaces:</B> <DD>java.util.Iterator<<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>></DD>
\r
103 <DT><PRE>public class <B>FastaReader</B><DT>extends java.lang.Object<DT>implements java.util.Iterator<<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>></DL>
\r
107 Reads files with FASTA formatted sequences. All the information in the FASTA
108 header is preserved including trailing white spaces. All the white spaces are
109 removed from the sequence.
111 Examples of the correct input:
116 GCQDKNNIAELNEIMGTTRSPSDWQHMKGASPRAEIGLTGKKDSWWRHCCSKEFNKTPPPIHPDMKRWGWMWNRENFEKFLIDNFLNPPCPRLMLTKGTWWRHEDLCHEIFWSTLRWLCLGNQSFSAMIWGHLCECHRMIWWESNEHMFWLKFRRALKKMNSNGPCMGPDNREWMITNRMGKEFCGPAFAGDCQSCWRKCHKTNKICFNEKKGTPTKIDHEQKDIMDILKDIDNHRNWKQCQLWLLTSKSTDQESTTMLTWSTWRDFFIIIKQPFDHKCRGALDANGDFQIAAELKWPAPMIILRQNQKTMHDKSCHHFFTNRCPLMHTTRANDKQCSWHTRKQFICQQDFTTWQHRPDTHRILPSWCMSTRRKNHIKNTPALAFSTCEMGDLPNGWAPGTIILQRQFTQAIKLPQETTGWPRCDPKFDHWNMSKWLRQLLGRDDEMIPPQCD
119 CPLSKWWNRRAFLSHTANHWMILMTWEGPHDGESKMRIAMMKWSPCKPTMSHFRCGLDAWAEPIRQIACESTFRM
120 FCTTPRPIHKLTEMWGHMNGWTGAFCRQLECEWMMPPRHPHPCTSTFNNNKKRLIGQIPNEGKQLFINFQKPQHG
121 FSESDIWIWKDNPTAWHEGLTIAGIGDGQHCWNWMPMPWSGAPTSNALIEFWTWLGMIGTRCKTQGMWWDAMNHH
122 DQFELSANAHIAAHHMEKKMILKPDDRNLGDDTWMPPGKIWMRMFAKNTNACWPEGCRDDNEEDDCGTHNLHRMC
125 CGCKIF D D NMKDNNRHG TDIKKHGFMH IRHPE KRDDC FDNHCIMPKHRRWGLWD
126 EASINM AQQWRSLPPSRIMKLNG HGCDCMHSHMEAD DTKQSGIKGTFWNG HDAQWLCRWG
127 EFITEA WWGRWGAITFFHAH ENKNEIQECSDQNLKE SRTTCEIID TCHLFTRHLDGW
128 RCEKCQANATHMTW ACTKSCAEQW FCAKELMMN
129 W KQMGWRCKIFRKLFRDNCWID FELPWWPICFCCKGLSTKSHSAHDGDQCRRW WPDCARDWLGPGIRGEF
130 FCTHICQQLQRNFWCGCFRWNIEKRMFEIFDDNMAAHWKKCMHFKFLIRIHRHGPITMKMTWCRSGCCFGKTRRLPDSSFISAFLDPKHHRDGSGMMMWSSEMRSCAIPDPQQAWNQGKWIGQIKDWNICFAWPIRENQQCWATPHEMPSGFHFILEKWDALAHPHMHIRQKKCWAWAFLSLMSSTHSDMATFQWAIPGHNIWSNWDNIICGWPRI
137 CCDQCQSWEAENWCASMRKAILF
144 <DT><B>Version:</B></DT>
\r
145 <DD>1.0 April 2011</DD>
\r
146 <DT><B>Author:</B></DT>
\r
147 <DD>Peter Troshin</DD>
\r
153 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
155 <A NAME="constructor_summary"><!-- --></A>
\r
156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
158 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
159 <B>Constructor Summary</B></FONT></TH>
\r
161 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
162 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#FastaReader(java.io.InputStream)">FastaReader</A></B>(java.io.InputStream inputStream)</CODE>
\r
165 This class will not close the incoming stream! So the client should do
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#FastaReader(java.lang.String)">FastaReader</A></B>(java.lang.String inputFile)</CODE>
\r
172 Header data can contain non-ASCII symbols and read in UTF8</TD>
\r
176 <!-- ========== METHOD SUMMARY =========== -->
\r
178 <A NAME="method_summary"><!-- --></A>
\r
179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
180 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
181 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
182 <B>Method Summary</B></FONT></TH>
\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
186 <CODE> void</CODE></FONT></TD>
\r
187 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#close()">close</A></B>()</CODE>
\r
190 Call this method to close the connection to the input file if you want to
191 free up the resources.</TD>
\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
195 <CODE> boolean</CODE></FONT></TD>
\r
196 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#hasNext()">hasNext</A></B>()</CODE>
\r
199 </TD>
\r
201 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
203 <CODE> <A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A></CODE></FONT></TD>
\r
204 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#next()">next</A></B>()</CODE>
\r
207 Reads the next FastaSequence from the input</TD>
\r
209 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
211 <CODE> void</CODE></FONT></TD>
\r
212 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#remove()">remove</A></B>()</CODE>
\r
215 Not implemented</TD>
\r
218 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
219 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
220 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
221 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
224 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
230 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
232 <A NAME="constructor_detail"><!-- --></A>
\r
233 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
234 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
235 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
236 <B>Constructor Detail</B></FONT></TH>
\r
240 <A NAME="FastaReader(java.lang.String)"><!-- --></A><H3>
\r
243 public <B>FastaReader</B>(java.lang.String inputFile)
\r
244 throws java.io.FileNotFoundException</PRE>
\r
246 <DD>Header data can contain non-ASCII symbols and read in UTF8
\r
249 <DT><B>Parameters:</B><DD><CODE>inputFile</CODE> - the file containing the list of FASTA formatted sequences to
252 <DD><CODE>java.io.FileNotFoundException</CODE> - if the input file is not found
\r
253 <DD><CODE>java.lang.IllegalStateException</CODE> - if the close method was called on this instance</DL>
\r
257 <A NAME="FastaReader(java.io.InputStream)"><!-- --></A><H3>
\r
260 public <B>FastaReader</B>(java.io.InputStream inputStream)
\r
261 throws java.io.FileNotFoundException</PRE>
\r
263 <DD>This class will not close the incoming stream! So the client should do
267 <DT><B>Parameters:</B><DD><CODE>inputStream</CODE> -
\r
269 <DD><CODE>java.io.FileNotFoundException</CODE></DL>
\r
272 <!-- ============ METHOD DETAIL ========== -->
\r
274 <A NAME="method_detail"><!-- --></A>
\r
275 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
276 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
277 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
278 <B>Method Detail</B></FONT></TH>
\r
282 <A NAME="hasNext()"><!-- --></A><H3>
\r
285 public boolean <B>hasNext</B>()</PRE>
\r
290 <DT><B>Specified by:</B><DD><CODE>hasNext</CODE> in interface <CODE>java.util.Iterator<<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>></CODE></DL>
\r
295 <DD><CODE>java.lang.IllegalStateException</CODE> - if the close method was called on this instance</DL>
\r
300 <A NAME="next()"><!-- --></A><H3>
\r
303 public <A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A> <B>next</B>()</PRE>
\r
305 <DD>Reads the next FastaSequence from the input
\r
308 <DT><B>Specified by:</B><DD><CODE>next</CODE> in interface <CODE>java.util.Iterator<<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>></CODE></DL>
\r
313 <DD><CODE>java.lang.AssertionError</CODE> - if the header or the sequence is missing
\r
314 <DD><CODE>java.lang.IllegalStateException</CODE> - if the close method was called on this instance</DL>
\r
319 <A NAME="remove()"><!-- --></A><H3>
\r
322 public void <B>remove</B>()</PRE>
\r
324 <DD>Not implemented
\r
327 <DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>java.util.Iterator<<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>></CODE></DL>
\r
335 <A NAME="close()"><!-- --></A><H3>
\r
338 public void <B>close</B>()</PRE>
\r
340 <DD>Call this method to close the connection to the input file if you want to
341 free up the resources. The connection will be closed on the JVM shutdown
342 if this method was not called explicitly. No further reading on this
343 instance of the FastaReader will be possible after calling this method.
\r
352 <!-- ========= END OF CLASS DATA ========= -->
\r
356 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
357 <A NAME="navbar_bottom"><!-- --></A>
\r
358 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
359 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
361 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
362 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
363 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
364 <TR ALIGN="center" VALIGN="top">
\r
365 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
366 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
367 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
368 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FastaReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
369 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
370 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
371 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
372 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
376 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
382 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
383 <A HREF="../../../compbio/data/sequence/DisorderMethod.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>
\r
384 <A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>
\r
385 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
386 <A HREF="../../../index.html?compbio/data/sequence/FastaReader.html" target="_top"><B>FRAMES</B></A>
\r
387 <A HREF="FastaReader.html" target="_top"><B>NO FRAMES</B></A>
\r
388 <SCRIPT type="text/javascript">
\r
391 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
396 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
403 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
404 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
405 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
406 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
409 <A NAME="skip-navbar_bottom"></A>
\r
410 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r