1 /* Copyright (c) 2011 Peter Troshin
\r
3 * JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0
\r
5 * This library is free software; you can redistribute it and/or modify it under the terms of the
\r
6 * Apache License version 2 as published by the Apache Software Foundation
\r
8 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
\r
9 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache
\r
10 * License for more details.
\r
12 * A copy of the license is in apache_license.txt. It is also available here:
\r
13 * @see: http://www.apache.org/licenses/LICENSE-2.0.txt
\r
15 * Any republication or derived work distributed in source code form
\r
16 * must include this copyright and license notice.
\r
18 package compbio.data.sequence;
\r
20 import java.io.File;
\r
21 import java.io.FileNotFoundException;
\r
22 import java.util.Iterator;
\r
23 import java.util.Scanner;
\r
25 import compbio.util.Util;
\r
28 * Reads files with FASTA formatted sequences. All the information in the FASTA
\r
29 * header is preserved including trailing white spaces. All the white spaces are
\r
30 * removed from the sequence.
\r
32 * Examples of the correct input:
\r
37 * GCQDKNNIAELNEIMGTTRSPSDWQHMKGASPRAEIGLTGKKDSWWRHCCSKEFNKTPPPIHPDMKRWGWMWNRENFEKFLIDNFLNPPCPRLMLTKGTWWRHEDLCHEIFWSTLRWLCLGNQSFSAMIWGHLCECHRMIWWESNEHMFWLKFRRALKKMNSNGPCMGPDNREWMITNRMGKEFCGPAFAGDCQSCWRKCHKTNKICFNEKKGTPTKIDHEQKDIMDILKDIDNHRNWKQCQLWLLTSKSTDQESTTMLTWSTWRDFFIIIKQPFDHKCRGALDANGDFQIAAELKWPAPMIILRQNQKTMHDKSCHHFFTNRCPLMHTTRANDKQCSWHTRKQFICQQDFTTWQHRPDTHRILPSWCMSTRRKNHIKNTPALAFSTCEMGDLPNGWAPGTIILQRQFTQAIKLPQETTGWPRCDPKFDHWNMSKWLRQLLGRDDEMIPPQCD
\r
40 * CPLSKWWNRRAFLSHTANHWMILMTWEGPHDGESKMRIAMMKWSPCKPTMSHFRCGLDAWAEPIRQIACESTFRM
\r
41 * FCTTPRPIHKLTEMWGHMNGWTGAFCRQLECEWMMPPRHPHPCTSTFNNNKKRLIGQIPNEGKQLFINFQKPQHG
\r
42 * FSESDIWIWKDNPTAWHEGLTIAGIGDGQHCWNWMPMPWSGAPTSNALIEFWTWLGMIGTRCKTQGMWWDAMNHH
\r
43 * DQFELSANAHIAAHHMEKKMILKPDDRNLGDDTWMPPGKIWMRMFAKNTNACWPEGCRDDNEEDDCGTHNLHRMC
\r
46 * CGCKIF D D NMKDNNRHG TDIKKHGFMH IRHPE KRDDC FDNHCIMPKHRRWGLWD
\r
47 * EASINM AQQWRSLPPSRIMKLNG HGCDCMHSHMEAD DTKQSGIKGTFWNG HDAQWLCRWG
\r
48 * EFITEA WWGRWGAITFFHAH ENKNEIQECSDQNLKE SRTTCEIID TCHLFTRHLDGW
\r
49 * RCEKCQANATHMTW ACTKSCAEQW FCAKELMMN
\r
50 * W KQMGWRCKIFRKLFRDNCWID FELPWWPICFCCKGLSTKSHSAHDGDQCRRW WPDCARDWLGPGIRGEF
\r
51 * FCTHICQQLQRNFWCGCFRWNIEKRMFEIFDDNMAAHWKKCMHFKFLIRIHRHGPITMKMTWCRSGCCFGKTRRLPDSSFISAFLDPKHHRDGSGMMMWSSEMRSCAIPDPQQAWNQGKWIGQIKDWNICFAWPIRENQQCWATPHEMPSGFHFILEKWDALAHPHMHIRQKKCWAWAFLSLMSSTHSDMATFQWAIPGHNIWSNWDNIICGWPRI
\r
53 * > 12 d t y wi k jbke
\r
57 * HSKCTEPHCGNSHQMLHRDP
\r
58 * CCDQCQSWEAENWCASMRKAILF
\r
62 * @author Peter Troshin
\r
63 * @version 1.0 April 2011
\r
66 public class FastaReader implements Iterator<FastaSequence> {
\r
68 private final Scanner input;
\r
71 * Header data can contain non-ASCII symbols and read in UTF8
\r
74 * the file containing the list of FASTA formatted sequences to
\r
76 * @throws FileNotFoundException
\r
77 * if the input file is not found
\r
78 * @throws IllegalStateException
\r
79 * if the close method was called on this instance
\r
82 public FastaReader(final String inputFile) throws FileNotFoundException {
\r
83 input = new Scanner(new File(inputFile), "UTF8");
\r
84 input.useDelimiter("\\s*>");
\r
85 Runtime.getRuntime().addShutdownHook(new Thread() {
\r
89 if (input != null) {
\r
98 * @throws IllegalStateException
\r
99 * if the close method was called on this instance
\r
102 public boolean hasNext() {
\r
103 return input.hasNext();
\r
107 * Reads the next FastaSequence from the input
\r
109 * @throws AssertionError
\r
110 * if the header or the sequence is missing
\r
111 * @throws IllegalStateException
\r
112 * if the close method was called on this instance
\r
115 public FastaSequence next() {
\r
116 return FastaReader.toFastaSequence(input.next());
\r
123 public void remove() {
\r
124 throw new UnsupportedOperationException();
\r
128 * Call this method to close the connection to the input file if you want to
\r
129 * free up the resources. The connection will be closed on the JVM shutdown
\r
130 * if this method was not called explicitly. No further reading on this
\r
131 * instance of the FastaReader will be possible after calling this method.
\r
133 public void close() {
\r
137 private static FastaSequence toFastaSequence(final String singleFastaEntry) {
\r
139 assert !Util.isEmpty(singleFastaEntry) : "Empty String where FASTA sequence is expected!";
\r
141 int nlineidx = singleFastaEntry.indexOf("\n");
\r
142 if (nlineidx < 0) {
\r
143 throw new AssertionError(
\r
144 "The FASTA sequence must contain the header information"
\r
145 + " separated by the new line from the sequence. Given sequence does not appear to "
\r
146 + "contain the header! Given data:\n "
\r
147 + singleFastaEntry);
\r
149 String header = singleFastaEntry.substring(0, nlineidx);
\r
151 // Get rid of the new line chars (should cover common cases)
\r
152 header = header.replaceAll("\r", "");
\r
154 String sequence = singleFastaEntry.substring(nlineidx);
\r
156 if (Util.isEmpty(sequence)) {
\r
157 throw new AssertionError(
\r
158 "Empty sequences are not allowed! Please make sure the "
\r
159 + " data is in the FASTA format! Given data:\n "
\r
160 + singleFastaEntry);
\r
162 return new FastaSequence(header, sequence);
\r