forester/java/src/org/forester/io/parsers/nexus/NexusPhylogeniesParser.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: www.phylosoft.org/forester
  25
  26 package org.forester.io.parsers.nexus;
  27
  28 import java.io.BufferedReader;
  29 import java.io.IOException;
  30 import java.util.ArrayList;
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.regex.Matcher;
  35 import java.util.regex.Pattern;
  36
  37 import org.forester.archaeopteryx.Constants;
  38 import org.forester.io.parsers.PhylogenyParser;
  39 import org.forester.io.parsers.nhx.NHXFormatException;
  40 import org.forester.io.parsers.nhx.NHXParser;
  41 import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
  42 import org.forester.io.parsers.util.ParserUtils;
  43 import org.forester.io.parsers.util.PhylogenyParserException;
  44 import org.forester.phylogeny.Phylogeny;
  45 import org.forester.phylogeny.PhylogenyNode;
  46 import org.forester.phylogeny.factories.ParserBasedPhylogenyFactory;
  47 import org.forester.phylogeny.factories.PhylogenyFactory;
  48 import org.forester.phylogeny.iterators.PhylogenyNodeIterator;
  49 import org.forester.util.ForesterUtil;
  50
  51 public class NexusPhylogeniesParser implements PhylogenyParser {
  52
  53     final private static String  begin_trees               = NexusConstants.BEGIN_TREES.toLowerCase();
  54     final private static String  taxlabels                 = NexusConstants.TAXLABELS.toLowerCase();
  55     final private static String  translate                 = NexusConstants.TRANSLATE.toLowerCase();
  56     final private static String  tree                      = NexusConstants.TREE.toLowerCase();
  57     final private static String  utree                     = NexusConstants.UTREE.toLowerCase();
  58     final private static String  end                       = NexusConstants.END.toLowerCase();
  59     final private static String  endblock                  = "endblock";
  60     final private static Pattern TREE_NAME_PATTERN         = Pattern.compile( "\\s*.?Tree\\s+(.+?)\\s*=.+",
  61                                                                               Pattern.CASE_INSENSITIVE );
  62     final private static Pattern ROOTEDNESS_PATTERN        = Pattern.compile( ".+=\\s*\\[&([R|U])\\].*" );
  63     private Object               _nexus_source;
  64     private List<Phylogeny>      _phylogenies;
  65     private List<String>         _taxlabels;
  66     private Map<String, String>  _translate_map;
  67     private boolean              _replace_underscores      = NHXParser.REPLACE_UNDERSCORES_DEFAULT;
  68     private boolean              _ignore_quotes_in_nh_data = Constants.NH_PARSING_IGNORE_QUOTES_DEFAULT;
  69     private TAXONOMY_EXTRACTION  _taxonomy_extraction      = NHXParser.TAXONOMY_EXTRACTION_DEFAULT;
  70
  71     @Override
  72     public Phylogeny[] parse() throws IOException, NHXFormatException {
  73         reset();
  74         final BufferedReader reader = ParserUtils.createReader( getNexusSource() );
  75         String line;
  76         String name = "";
  77         StringBuffer nhx = new StringBuffer();
  78         final StringBuffer translate_sb = new StringBuffer();
  79         boolean in_trees_block = false;
  80         boolean in_taxalabels = false;
  81         boolean in_translate = false;
  82         boolean in_tree = false;
  83         boolean rooted_info_present = false;
  84         boolean is_rooted = false;
  85         while ( ( line = reader.readLine() ) != null ) {
  86             line = line.trim();
  87             if ( ( line.length() > 0 ) && !line.startsWith( "#" ) && !line.startsWith( ">" ) ) {
  88                 line = ForesterUtil.collapseWhiteSpace( line );
  89                 line = removeWhiteSpaceBeforeSemicolon( line );
  90                 final String line_lc = line.toLowerCase();
  91                 if ( line_lc.startsWith( begin_trees ) ) {
  92                     in_trees_block = true;
  93                     in_taxalabels = false;
  94                     in_translate = false;
  95                 }
  96                 else if ( line_lc.startsWith( taxlabels ) ) {
  97                     in_trees_block = false;
  98                     in_taxalabels = true;
  99                     in_translate = false;
 100                 }
 101                 else if ( line_lc.startsWith( translate ) ) {
 102                     in_taxalabels = false;
 103                     in_translate = true;
 104                 }
 105                 else if ( in_trees_block ) {
 106                     //FIXME TODO need to work on this "title" and "link"
 107                     if ( line_lc.startsWith( "title" ) || line_lc.startsWith( "link" ) ) {
 108                         // Do nothing.
 109                     }
 110                     else if ( line_lc.startsWith( end ) || line_lc.startsWith( endblock ) ) {
 111                         in_trees_block = false;
 112                         in_tree = false;
 113                         in_translate = false;
 114                         if ( nhx.length() > 0 ) {
 115                             createPhylogeny( name, nhx, rooted_info_present, is_rooted );
 116                             nhx = new StringBuffer();
 117                             name = "";
 118                             rooted_info_present = false;
 119                             is_rooted = false;
 120                         }
 121                     }
 122                     else if ( line_lc.startsWith( tree ) || ( line_lc.startsWith( utree ) ) ) {
 123                         if ( nhx.length() > 0 ) {
 124                             createPhylogeny( name, nhx, rooted_info_present, is_rooted );
 125                             nhx = new StringBuffer();
 126                             name = "";
 127                             rooted_info_present = false;
 128                             is_rooted = false;
 129                         }
 130                         in_tree = true;
 131                         nhx.append( line.substring( line.indexOf( '=' ) ) );
 132                         final Matcher name_matcher = TREE_NAME_PATTERN.matcher( line );
 133                         if ( name_matcher.matches() ) {
 134                             name = name_matcher.group( 1 );
 135                             name = name.replaceAll( "['\"]+", "" );
 136                         }
 137                         final Matcher rootedness_matcher = ROOTEDNESS_PATTERN.matcher( line );
 138                         if ( rootedness_matcher.matches() ) {
 139                             final String s = rootedness_matcher.group( 1 );
 140                             line = line.replaceAll( "\\[\\&.\\]", "" );
 141                             rooted_info_present = true;
 142                             if ( s.toUpperCase().equals( "R" ) ) {
 143                                 is_rooted = true;
 144                             }
 145                         }
 146                     }
 147                     else if ( in_tree && !in_translate ) {
 148                         nhx.append( line );
 149                     }
 150                     if ( !line_lc.startsWith( "title" ) && !line_lc.startsWith( "link" ) && !in_translate
 151                             && !line_lc.startsWith( end ) && !line_lc.startsWith( endblock ) && line_lc.endsWith( ";" ) ) {
 152                         in_tree = false;
 153                         in_translate = false;
 154                         createPhylogeny( name, nhx, rooted_info_present, is_rooted );
 155                         nhx = new StringBuffer();
 156                         name = "";
 157                         rooted_info_present = false;
 158                         is_rooted = false;
 159                     }
 160                 }
 161                 if ( in_taxalabels ) {
 162                     if ( line_lc.startsWith( end ) || line_lc.startsWith( endblock ) ) {
 163                         in_taxalabels = false;
 164                     }
 165                     else {
 166                         final String[] labels = line.split( "\\s+" );
 167                         for( String label : labels ) {
 168                             if ( !label.toLowerCase().equals( taxlabels ) ) {
 169                                 if ( label.endsWith( ";" ) ) {
 170                                     in_taxalabels = false;
 171                                     label = label.substring( 0, label.length() - 1 );
 172                                 }
 173                                 if ( label.length() > 0 ) {
 174                                     getTaxlabels().add( label );
 175                                 }
 176                             }
 177                         }
 178                     }
 179                 }
 180                 if ( in_translate ) {
 181                     if ( line_lc.startsWith( end ) || line_lc.startsWith( endblock ) ) {
 182                         in_translate = false;
 183                     }
 184                     else {
 185                         translate_sb.append( " " );
 186                         translate_sb.append( line.trim() );
 187                         if ( line.endsWith( ";" ) ) {
 188                             in_translate = false;
 189                             setTranslateKeyValuePairs( translate_sb );
 190                         }
 191                     }
 192                 }
 193             }
 194         }
 195         if ( nhx.length() > 0 ) {
 196             createPhylogeny( name, nhx, rooted_info_present, is_rooted );
 197         }
 198         return getPhylogeniesAsArray();
 199     }
 200
 201     public void setIgnoreQuotes( final boolean ignore_quotes_in_nh_data ) {
 202         _ignore_quotes_in_nh_data = ignore_quotes_in_nh_data;
 203     }
 204
 205     public void setReplaceUnderscores( final boolean replace_underscores ) {
 206         _replace_underscores = replace_underscores;
 207     }
 208
 209     @Override
 210     public void setSource( final Object nexus_source ) throws PhylogenyParserException, IOException {
 211         if ( nexus_source == null ) {
 212             throw new PhylogenyParserException( getClass() + ": attempt to parse null object." );
 213         }
 214         _nexus_source = nexus_source;
 215     }
 216
 217     public void setTaxonomyExtraction( final TAXONOMY_EXTRACTION taxonomy_extraction ) {
 218         _taxonomy_extraction = taxonomy_extraction;
 219     }
 220
 221     private void createPhylogeny( final String name,
 222                                   final StringBuffer nhx,
 223                                   final boolean rooted_info_present,
 224                                   final boolean is_rooted ) throws IOException {
 225         final PhylogenyFactory factory = ParserBasedPhylogenyFactory.getInstance();
 226         final NHXParser pars = new NHXParser();
 227         pars.setTaxonomyExtraction( getTaxonomyExtraction() );
 228         pars.setReplaceUnderscores( isReplaceUnderscores() );
 229         pars.setIgnoreQuotes( isIgnoreQuotes() );
 230         if ( rooted_info_present ) {
 231             pars.setGuessRootedness( false );
 232         }
 233         final Phylogeny p = factory.create( nhx, pars )[ 0 ];
 234         p.setName( name );
 235         if ( rooted_info_present ) {
 236             p.setRooted( is_rooted );
 237         }
 238         if ( ( getTaxlabels().size() > 0 ) || ( getTranslateMap().size() > 0 ) ) {
 239             final PhylogenyNodeIterator it = p.iteratorExternalForward();
 240             while ( it.hasNext() ) {
 241                 final PhylogenyNode node = it.next();
 242                 if ( ( getTranslateMap().size() > 0 ) && getTranslateMap().containsKey( node.getName() ) ) {
 243                     node.setName( getTranslateMap().get( node.getName() ).replaceAll( "['\"]+", "" ) );
 244                 }
 245                 else if ( getTaxlabels().size() > 0 ) {
 246                     int i = -1;
 247                     try {
 248                         i = Integer.parseInt( node.getName() );
 249                     }
 250                     catch ( final NumberFormatException e ) {
 251                         // Ignore.
 252                     }
 253                     if ( i > 0 ) {
 254                         node.setName( getTaxlabels().get( i - 1 ).replaceAll( "['\"]+", "" ) );
 255                     }
 256                 }
 257             }
 258         }
 259         getPhylogenies().add( p );
 260     }
 261
 262     private Object getNexusSource() {
 263         return _nexus_source;
 264     }
 265
 266     private List<Phylogeny> getPhylogenies() {
 267         return _phylogenies;
 268     }
 269
 270     private Phylogeny[] getPhylogeniesAsArray() {
 271         final Phylogeny[] p = new Phylogeny[ getPhylogenies().size() ];
 272         for( int i = 0; i < getPhylogenies().size(); ++i ) {
 273             p[ i ] = getPhylogenies().get( i );
 274         }
 275         return p;
 276     }
 277
 278     private List<String> getTaxlabels() {
 279         return _taxlabels;
 280     }
 281
 282     private TAXONOMY_EXTRACTION getTaxonomyExtraction() {
 283         return _taxonomy_extraction;
 284     }
 285
 286     private Map<String, String> getTranslateMap() {
 287         return _translate_map;
 288     }
 289
 290     private boolean isIgnoreQuotes() {
 291         return _ignore_quotes_in_nh_data;
 292     }
 293
 294     private boolean isReplaceUnderscores() {
 295         return _replace_underscores;
 296     }
 297
 298     private void reset() {
 299         setPhylogenies( new ArrayList<Phylogeny>() );
 300         setTaxlabels( new ArrayList<String>() );
 301         setTranslateMap( new HashMap<String, String>() );
 302     }
 303
 304     private void setPhylogenies( final ArrayList<Phylogeny> phylogenies ) {
 305         _phylogenies = phylogenies;
 306     }
 307
 308     private void setTaxlabels( final List<String> taxlabels ) {
 309         _taxlabels = taxlabels;
 310     }
 311
 312     private void setTranslateKeyValuePairs( final StringBuffer translate_sb ) throws IOException {
 313         String s = translate_sb.toString().trim();
 314         if ( s.endsWith( ";" ) ) {
 315             s = s.substring( 0, s.length() - 1 ).trim();
 316         }
 317         for( final String pair : s.split( "," ) ) {
 318             final String[] kv = pair.trim().split( "\\s+" );
 319             if ( ( kv.length < 2 ) || ( kv.length > 3 ) ) {
 320                 throw new IOException( "ill formatted translate values: " + translate_sb );
 321             }
 322             if ( ( kv.length == 3 ) && !kv[ 0 ].toLowerCase().trim().equals( translate ) ) {
 323                 throw new IOException( "ill formatted translate values: " + translate_sb );
 324             }
 325             String key = "";
 326             String value = "";
 327             if ( kv.length == 3 ) {
 328                 key = kv[ 1 ];
 329                 value = kv[ 2 ];
 330             }
 331             else {
 332                 key = kv[ 0 ];
 333                 value = kv[ 1 ];
 334             }
 335             if ( value.endsWith( ";" ) ) {
 336                 value = value.substring( 0, value.length() - 1 );
 337             }
 338             getTranslateMap().put( key, value );
 339         }
 340     }
 341
 342     private void setTranslateMap( final Map<String, String> translate_map ) {
 343         _translate_map = translate_map;
 344     }
 345
 346     private static String removeWhiteSpaceBeforeSemicolon( final String s ) {
 347         return s.replaceAll( "\\s+;", ";" );
 348     }
 349 }