forester/java/src/org/forester/io/parsers/FastaParser.java

   1 // $Id:
   2 //
   3 // forester -- software libraries and applications
   4 // for genomics and evolutionary biology research.
   5 //
   6 // Copyright (C) 2010 Christian M Zmasek
   7 // Copyright (C) 2010 Sanford-Burnham Medical Research Institute
   8 // All rights reserved
   9 //
  10 // This library is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU Lesser General Public
  12 // License as published by the Free Software Foundation; either
  13 // version 2.1 of the License, or (at your option) any later version.
  14 //
  15 // This library is distributed in the hope that it will be useful,
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 // Lesser General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU Lesser General Public
  21 // License along with this library; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  23 //
  24 // Contact: phylosoft @ gmail . com
  25 // WWW: www.phylosoft.org/forester
  26
  27 package org.forester.io.parsers;
  28
  29 import java.io.BufferedReader;
  30 import java.io.ByteArrayInputStream;
  31 import java.io.File;
  32 import java.io.FileInputStream;
  33 import java.io.IOException;
  34 import java.io.InputStream;
  35 import java.io.InputStreamReader;
  36 import java.util.ArrayList;
  37 import java.util.List;
  38 import java.util.regex.Matcher;
  39 import java.util.regex.Pattern;
  40
  41 import org.forester.msa.BasicMsa;
  42 import org.forester.msa.Msa;
  43 import org.forester.msa.MsaFormatException;
  44 import org.forester.sequence.BasicSequence;
  45 import org.forester.sequence.Sequence;
  46
  47 public class FastaParser {
  48
  49     private static final Pattern NAME_REGEX      = Pattern.compile( "^\\s*>\\s*(.+)" );
  50     private static final Pattern SEQ_REGEX       = Pattern.compile( "^\\s*(.+)" );
  51     private static final Pattern ANYTHING_REGEX  = Pattern.compile( "[\\d\\s]+" );
  52     //>gi|71834668|ref|NP_001025424.1| Bcl2 [Danio rerio]
  53     public static final Pattern  FASTA_DESC_LINE = Pattern
  54                                                          .compile( ">?\\s*([^|]+)\\|([^|]+)\\S*\\s+(.+)\\s+\\[(.+)\\]" );
  55
  56     public static void main( final String[] args ) {
  57         final String a = ">gi|71834668|ref|NP_001025424.1| Bcl2 [Danio rerio]";
  58         final Matcher name_m = FASTA_DESC_LINE.matcher( a );
  59         if ( name_m.lookingAt() ) {
  60             System.out.println();
  61             System.out.println( name_m.group( 1 ) );
  62             System.out.println( name_m.group( 2 ) );
  63             System.out.println( name_m.group( 3 ) );
  64             System.out.println( name_m.group( 4 ) );
  65         }
  66         else {
  67             System.out.println( "Does not match." );
  68         }
  69     }
  70
  71     static public boolean isLikelyFasta( final InputStream is ) throws IOException {
  72         final BufferedReader reader = new BufferedReader( new InputStreamReader( is, "UTF-8" ) );
  73         String line = null;
  74         while ( ( line = reader.readLine() ) != null ) {
  75             final boolean is_name_line = NAME_REGEX.matcher( line ).lookingAt();
  76             if ( canIgnore( line, true, false ) ) {
  77                 continue;
  78             }
  79             else if ( is_name_line ) {
  80                 reader.close();
  81                 return true;
  82             }
  83             else if ( SEQ_REGEX.matcher( line ).lookingAt() ) {
  84                 reader.close();
  85                 return false;
  86             }
  87         }
  88         reader.close();
  89         return false;
  90     }
  91
  92     static public Msa parseMsa( final File f ) throws IOException {
  93         return parseMsa( new FileInputStream( f ) );
  94     }
  95
  96     static public Msa parseMsa( final InputStream is ) throws IOException {
  97         return BasicMsa.createInstance( parse( is ) );
  98     }
  99
 100     static public Msa parseMsa( final String s ) throws IOException {
 101         return parseMsa( s.getBytes() );
 102     }
 103
 104     static public Msa parseMsa( final byte[] bytes ) throws IOException {
 105         return parseMsa( new ByteArrayInputStream( bytes ) );
 106     }
 107
 108     static public List<Sequence> parse( final File f ) throws IOException {
 109         return parse( new FileInputStream( f ) );
 110     }
 111
 112     static public List<Sequence> parse( final InputStream is ) throws IOException {
 113         final BufferedReader reader = new BufferedReader( new InputStreamReader( is, "UTF-8" ) );
 114         String line = null;
 115         int line_counter = 0;
 116         boolean saw_first_seq = false;
 117         StringBuilder current_seq = null;
 118         StringBuilder name = null;
 119         final List<StringBuilder[]> temp_msa = new ArrayList<StringBuilder[]>();
 120         while ( ( line = reader.readLine() ) != null ) {
 121             ++line_counter;
 122             final Matcher name_m = NAME_REGEX.matcher( line );
 123             final boolean is_name_line = name_m.lookingAt();
 124             if ( canIgnore( line, saw_first_seq, is_name_line ) ) {
 125                 continue;
 126             }
 127             final Matcher seq_m = SEQ_REGEX.matcher( line );
 128             if ( is_name_line ) {
 129                 saw_first_seq = true;
 130                 addSeq( name, current_seq, temp_msa );
 131                 name = new StringBuilder( name_m.group( 1 ).trim() );
 132                 current_seq = new StringBuilder();
 133             }
 134             else if ( seq_m.lookingAt() ) {
 135                 if ( name.length() < 1 ) {
 136                     reader.close();
 137                     throw new MsaFormatException( "illegally formatted fasta msa (line: " + line_counter + "):\n\""
 138                             + trim( line ) + "\"" );
 139                 }
 140                 current_seq.append( seq_m.group( 1 ).replaceAll( "\\s+", "" ) );
 141             }
 142             else {
 143                 reader.close();
 144                 throw new MsaFormatException( "illegally formatted fasta msa (line: " + line_counter + "):\n\""
 145                         + trim( line ) + "\"" );
 146             }
 147         }
 148         addSeq( name, current_seq, temp_msa );
 149         reader.close();
 150         final List<Sequence> seqs = new ArrayList<Sequence>();
 151         for( int i = 0; i < temp_msa.size(); ++i ) {
 152             seqs.add( BasicSequence.createAaSequence( temp_msa.get( i )[ 0 ].toString(),
 153                                                       temp_msa.get( i )[ 1 ].toString() ) );
 154         }
 155         return seqs;
 156     }
 157
 158     static private boolean canIgnore( final String line, final boolean saw_first_seq, final boolean is_name_line ) {
 159         if ( ( line.length() < 1 ) || ANYTHING_REGEX.matcher( line ).matches() ) {
 160             return true;
 161         }
 162         if ( !saw_first_seq && !is_name_line ) {
 163             return true;
 164         }
 165         return false;
 166     }
 167
 168     private static void addSeq( final StringBuilder name, final StringBuilder seq, final List<StringBuilder[]> temp_msa ) {
 169         if ( ( name != null ) && ( seq != null ) && ( name.length() > 0 ) && ( seq.length() > 0 ) ) {
 170             final StringBuilder[] ary = new StringBuilder[ 2 ];
 171             ary[ 0 ] = name;
 172             ary[ 1 ] = seq;
 173             temp_msa.add( ary );
 174         }
 175     }
 176
 177     private static String trim( final String line ) {
 178         if ( line.length() > 100 ) {
 179             return line.substring( 0, 100 ) + " ...";
 180         }
 181         return line;
 182     }
 183 }