forester/java/src/org/forester/io/parsers/util/ParserUtils.java

   1 // $Id:
   2 //
   3 // FORESTER -- software libraries and applications
   4 // for evolutionary biology research and applications.
   5 //
   6 // Copyright (C) 2008-2009 Christian M. Zmasek
   7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   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/
  26
  27 package org.forester.io.parsers.util;
  28
  29 import java.io.BufferedReader;
  30 import java.io.File;
  31 import java.io.FileNotFoundException;
  32 import java.io.FileReader;
  33 import java.io.IOException;
  34 import java.io.InputStream;
  35 import java.io.InputStreamReader;
  36 import java.io.StringReader;
  37 import java.net.URL;
  38 import java.util.regex.Matcher;
  39 import java.util.regex.Pattern;
  40
  41 import org.forester.io.parsers.PhylogenyParser;
  42 import org.forester.io.parsers.nexus.NexusPhylogeniesParser;
  43 import org.forester.io.parsers.nhx.NHXParser;
  44 import org.forester.io.parsers.nhx.NHXParser.TAXONOMY_EXTRACTION;
  45 import org.forester.io.parsers.phyloxml.PhyloXmlDataFormatException;
  46 import org.forester.io.parsers.phyloxml.PhyloXmlParser;
  47 import org.forester.io.parsers.tol.TolParser;
  48 import org.forester.phylogeny.Phylogeny;
  49 import org.forester.phylogeny.PhylogenyMethods;
  50 import org.forester.phylogeny.PhylogenyNode;
  51 import org.forester.phylogeny.data.Identifier;
  52 import org.forester.phylogeny.data.Taxonomy;
  53 import org.forester.util.ForesterConstants;
  54 import org.forester.util.ForesterUtil;
  55
  56 public final class ParserUtils {
  57
  58     final public static String   TAX_CODE                        = "(?:[A-Z9][A-Z]{2}[A-Z0-9]{2})|RAT|PIG|PEA";
  59     final public static Pattern  TAXOMONY_CODE_PATTERN_A         = Pattern.compile( "(?:\\b|_)(" + TAX_CODE + ")\\b" );
  60     final public static Pattern  TAXOMONY_CODE_PATTERN_BRACKETED = Pattern.compile( "\\[(" + TAX_CODE + ")\\]" );
  61     final public static Pattern  TAXOMONY_CODE_PATTERN_PFR       = Pattern.compile( "(?:\\b|_)[a-zA-Z0-9]{3,}_("
  62                                                                          + TAX_CODE + ")\\b" );
  63     final public static Pattern  TAXOMONY_SN_PATTERN             = Pattern
  64                                                                          .compile( "(?:\\b|_)[a-zA-Z0-9]{3,}_([A-Z][a-z]+_[a-z]{2,}(?:_[a-z][a-z0-9_]+)?)\\b" );
  65     final private static Pattern TAXOMONY_CODE_PATTERN_PFS       = Pattern.compile( "(?:\\b|_)[A-Z0-9]{4,}_("
  66                                                                          + TAX_CODE + ")/\\d+-\\d+\\b" );
  67     final private static Pattern TAXOMONY_UNIPROT_ID_PATTERN_A   = Pattern.compile( "(?:\\b|_)(\\d{1,7})\\b" );
  68     final private static Pattern TAXOMONY_UNIPROT_ID_PATTERN_PFR = Pattern
  69                                                                          .compile( "(?:\\b|_)[a-zA-Z0-9]{3,}_(\\d{1,7})\\b" );
  70     final private static Pattern TAXOMONY_UNIPROT_ID_PATTERN_PFS = Pattern
  71                                                                          .compile( "(?:\\b|_)[A-Z0-9]{4,}_(\\d{1,7})/\\d+-\\d+\\b" );
  72
  73     final public static PhylogenyParser createParserDependingFileContents( final File file,
  74                                                                            final boolean phyloxml_validate_against_xsd )
  75             throws FileNotFoundException, IOException {
  76         PhylogenyParser parser = null;
  77         final String first_line = ForesterUtil.getFirstLine( file ).trim().toLowerCase();
  78         if ( first_line.startsWith( "<" ) ) {
  79             parser = PhyloXmlParser.createPhyloXmlParser();
  80             if ( phyloxml_validate_against_xsd ) {
  81                 final ClassLoader cl = PhyloXmlParser.class.getClassLoader();
  82                 final URL xsd_url = cl.getResource( ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE );
  83                 if ( xsd_url != null ) {
  84                     ( ( PhyloXmlParser ) parser ).setValidateAgainstSchema( xsd_url.toString() );
  85                 }
  86                 else {
  87                     if ( ForesterConstants.RELEASE ) {
  88                         throw new RuntimeException( "failed to get URL for phyloXML XSD from jar file from ["
  89                                 + ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE + "]" );
  90                     }
  91                 }
  92             }
  93         }
  94         else if ( ( first_line.startsWith( "nexus" ) ) || ( first_line.startsWith( "#nexus" ) )
  95                 || ( first_line.startsWith( "# nexus" ) ) || ( first_line.startsWith( "begin" ) ) ) {
  96             parser = new NexusPhylogeniesParser();
  97         }
  98         else {
  99             parser = new NHXParser();
 100         }
 101         return parser;
 102     }
 103
 104     final public static PhylogenyParser createParserDependingOnFileType( final File file,
 105                                                                          final boolean phyloxml_validate_against_xsd )
 106             throws FileNotFoundException, IOException {
 107         PhylogenyParser parser = null;
 108         parser = ParserUtils.createParserDependingOnSuffix( file.getName(), phyloxml_validate_against_xsd );
 109         if ( parser == null ) {
 110             parser = createParserDependingFileContents( file, phyloxml_validate_against_xsd );
 111         }
 112         if ( ( parser != null ) && file.toString().toLowerCase().endsWith( ".zip" ) ) {
 113             if ( parser instanceof PhyloXmlParser ) {
 114                 ( ( PhyloXmlParser ) parser ).setZippedInputstream( true );
 115             }
 116             else if ( parser instanceof TolParser ) {
 117                 ( ( TolParser ) parser ).setZippedInputstream( true );
 118             }
 119         }
 120         return parser;
 121     }
 122
 123     final public static PhylogenyParser createParserDependingOnUrlContents( final URL url,
 124                                                                             final boolean phyloxml_validate_against_xsd )
 125             throws FileNotFoundException, IOException {
 126         final String lc_filename = url.getFile().toString().toLowerCase();
 127         PhylogenyParser parser = createParserDependingOnSuffix( lc_filename, phyloxml_validate_against_xsd );
 128         if ( parser == null ) {
 129             final String first_line = ForesterUtil.getFirstLine( url ).trim().toLowerCase();
 130             if ( first_line.startsWith( "<" ) ) {
 131                 parser = PhyloXmlParser.createPhyloXmlParser();
 132                 if ( phyloxml_validate_against_xsd ) {
 133                     final ClassLoader cl = PhyloXmlParser.class.getClassLoader();
 134                     final URL xsd_url = cl.getResource( ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE );
 135                     if ( xsd_url != null ) {
 136                         ( ( PhyloXmlParser ) parser ).setValidateAgainstSchema( xsd_url.toString() );
 137                     }
 138                     else {
 139                         throw new RuntimeException( "failed to get URL for phyloXML XSD from jar file from ["
 140                                 + ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE + "]" );
 141                     }
 142                 }
 143             }
 144             else if ( ( first_line.startsWith( "nexus" ) ) || ( first_line.startsWith( "#nexus" ) )
 145                     || ( first_line.startsWith( "# nexus" ) ) || ( first_line.startsWith( "begin" ) ) ) {
 146                 parser = new NexusPhylogeniesParser();
 147             }
 148             else {
 149                 parser = new NHXParser();
 150             }
 151         }
 152         if ( ( parser != null ) && lc_filename.endsWith( ".zip" ) ) {
 153             if ( parser instanceof PhyloXmlParser ) {
 154                 ( ( PhyloXmlParser ) parser ).setZippedInputstream( true );
 155             }
 156             else if ( parser instanceof TolParser ) {
 157                 ( ( TolParser ) parser ).setZippedInputstream( true );
 158             }
 159         }
 160         return parser;
 161     }
 162
 163     public static BufferedReader createReader( final Object source ) throws IOException, FileNotFoundException {
 164         BufferedReader reader = null;
 165         if ( ( source instanceof File ) || ( source instanceof String ) ) {
 166             File f = null;
 167             if ( source instanceof File ) {
 168                 f = ( File ) source;
 169             }
 170             else {
 171                 f = new File( ( String ) source );
 172             }
 173             if ( !f.exists() ) {
 174                 throw new IOException( "[" + f.getAbsolutePath() + "] does not exist" );
 175             }
 176             else if ( !f.isFile() ) {
 177                 throw new IOException( "[" + f.getAbsolutePath() + "] is not a file" );
 178             }
 179             else if ( !f.canRead() ) {
 180                 throw new IOException( "[" + f.getAbsolutePath() + "] is not a readable" );
 181             }
 182             reader = new BufferedReader( new FileReader( f ) );
 183         }
 184         else if ( source instanceof InputStream ) {
 185             reader = new BufferedReader( new InputStreamReader( ( InputStream ) source ) );
 186         }
 187         else if ( ( source instanceof StringBuffer ) || ( source instanceof StringBuilder ) ) {
 188             reader = new BufferedReader( new StringReader( source.toString() ) );
 189         }
 190         else {
 191             throw new IllegalArgumentException( "attempt to parse object of type [" + source.getClass()
 192                     + "] (can only parse objects of type File/String, InputStream, StringBuffer, or StringBuilder)" );
 193         }
 194         return reader;
 195     }
 196
 197     public final static String extractScientificNameFromNodeName( final String name ) {
 198         final Matcher m = TAXOMONY_SN_PATTERN.matcher( name );
 199         if ( m.find() ) {
 200             return m.group( 1 ).replace( '_', ' ' );
 201         }
 202         return null;
 203     }
 204
 205     public final static String extractTaxonomyCodeFromNodeName( final String name,
 206                                                                 final TAXONOMY_EXTRACTION taxonomy_extraction ) {
 207         Matcher m = TAXOMONY_CODE_PATTERN_PFS.matcher( name );
 208         if ( m.find() ) {
 209             return m.group( 1 );
 210         }
 211         else if ( ( taxonomy_extraction == TAXONOMY_EXTRACTION.PFAM_STYLE_RELAXED )
 212                 || ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGGRESSIVE ) ) {
 213             m = TAXOMONY_CODE_PATTERN_PFR.matcher( name );
 214             if ( m.find() ) {
 215                 return m.group( 1 );
 216             }
 217             else if ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGGRESSIVE ) {
 218                 m = TAXOMONY_CODE_PATTERN_A.matcher( name );
 219                 if ( m.find() ) {
 220                     return m.group( 1 );
 221                 }
 222             }
 223         }
 224         return null;
 225     }
 226
 227     public final static String extractTaxonomyDataFromNodeName( final PhylogenyNode node,
 228                                                                 final NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction )
 229             throws PhyloXmlDataFormatException {
 230         if ( taxonomy_extraction == TAXONOMY_EXTRACTION.NO ) {
 231             throw new IllegalArgumentException();
 232         }
 233         final String id = extractUniprotTaxonomyIdFromNodeName( node.getName(), taxonomy_extraction );
 234         if ( !ForesterUtil.isEmpty( id ) ) {
 235             if ( !node.getNodeData().isHasTaxonomy() ) {
 236                 node.getNodeData().setTaxonomy( new Taxonomy() );
 237             }
 238             node.getNodeData().getTaxonomy().setIdentifier( new Identifier( id, "uniprot" ) );
 239             return id;
 240         }
 241         else {
 242             final String code = extractTaxonomyCodeFromNodeName( node.getName(), taxonomy_extraction );
 243             if ( !ForesterUtil.isEmpty( code ) ) {
 244                 if ( !node.getNodeData().isHasTaxonomy() ) {
 245                     node.getNodeData().setTaxonomy( new Taxonomy() );
 246                 }
 247                 node.getNodeData().getTaxonomy().setTaxonomyCode( code );
 248                 return code;
 249             }
 250             else if ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGGRESSIVE ) {
 251                 final String sn = extractScientificNameFromNodeName( node.getName() );
 252                 if ( !ForesterUtil.isEmpty( sn ) ) {
 253                     if ( !node.getNodeData().isHasTaxonomy() ) {
 254                         node.getNodeData().setTaxonomy( new Taxonomy() );
 255                     }
 256                     node.getNodeData().getTaxonomy().setScientificName( sn );
 257                     return sn;
 258                 }
 259             }
 260         }
 261         return null;
 262     }
 263
 264     public final static String extractUniprotTaxonomyIdFromNodeName( final String name,
 265                                                                      final TAXONOMY_EXTRACTION taxonomy_extraction ) {
 266         Matcher m = TAXOMONY_UNIPROT_ID_PATTERN_PFS.matcher( name );
 267         if ( m.find() ) {
 268             return m.group( 1 );
 269         }
 270         else if ( ( taxonomy_extraction == TAXONOMY_EXTRACTION.PFAM_STYLE_RELAXED )
 271                 || ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGGRESSIVE ) ) {
 272             m = TAXOMONY_UNIPROT_ID_PATTERN_PFR.matcher( name );
 273             if ( m.find() ) {
 274                 return m.group( 1 );
 275             }
 276             else if ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGGRESSIVE ) {
 277                 m = TAXOMONY_UNIPROT_ID_PATTERN_A.matcher( name );
 278                 if ( m.find() ) {
 279                     return m.group( 1 );
 280                 }
 281             }
 282         }
 283         return null;
 284     }
 285
 286     public final static Phylogeny[] readPhylogenies( final File file ) throws FileNotFoundException, IOException {
 287         return PhylogenyMethods.readPhylogenies( ParserUtils.createParserDependingOnFileType( file, true ), file );
 288     }
 289
 290     public final static Phylogeny[] readPhylogenies( final String file_name ) throws FileNotFoundException, IOException {
 291         return readPhylogenies( new File( file_name ) );
 292     }
 293
 294     /**
 295      * Return null if it can not guess the parser to use based on name suffix.
 296      *
 297      * @param filename
 298      * @return
 299      */
 300     final private static PhylogenyParser createParserDependingOnSuffix( final String filename,
 301                                                                         final boolean phyloxml_validate_against_xsd ) {
 302         PhylogenyParser parser = null;
 303         final String filename_lc = filename.toLowerCase();
 304         if ( filename_lc.endsWith( ".tol" ) || filename_lc.endsWith( ".tolxml" ) || filename_lc.endsWith( ".tol.zip" ) ) {
 305             parser = new TolParser();
 306         }
 307         else if ( filename_lc.endsWith( ".xml" ) || filename_lc.endsWith( "phyloxml" ) || filename_lc.endsWith( ".zip" ) ) {
 308             parser = PhyloXmlParser.createPhyloXmlParser();
 309             if ( phyloxml_validate_against_xsd ) {
 310                 final ClassLoader cl = PhyloXmlParser.class.getClassLoader();
 311                 final URL xsd_url = cl.getResource( ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE );
 312                 if ( xsd_url != null ) {
 313                     ( ( PhyloXmlParser ) parser ).setValidateAgainstSchema( xsd_url.toString() );
 314                 }
 315                 else {
 316                     if ( ForesterConstants.RELEASE ) {
 317                         throw new RuntimeException( "failed to get URL for phyloXML XSD from jar file from ["
 318                                 + ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE + "]" );
 319                     }
 320                 }
 321             }
 322         }
 323         else if ( filename_lc.endsWith( ".nexus" ) || filename_lc.endsWith( ".nex" ) || filename_lc.endsWith( ".nx" ) ) {
 324             parser = new NexusPhylogeniesParser();
 325         }
 326         else if ( filename_lc.endsWith( ".nhx" ) || filename_lc.endsWith( ".nh" ) || filename_lc.endsWith( ".newick" )
 327                 || filename_lc.endsWith( ".nwk" ) ) {
 328             parser = new NHXParser();
 329         }
 330         return parser;
 331     }
 332 }