3 // FORESTER -- software libraries and applications
4 // for evolutionary biology research and applications.
6 // Copyright (C) 2008-2009 Christian M. Zmasek
7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
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.
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.
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
24 // Contact: phylosoft @ gmail . com
25 // WWW: www.phylosoft.org/
27 package org.forester.io.parsers.util;
29 import java.io.BufferedReader;
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;
38 import java.util.regex.Matcher;
39 import java.util.regex.Pattern;
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;
56 public final class ParserUtils {
58 final public static Pattern TAXOMONY_SN_PATTERN = Pattern
59 .compile( "[^_]{2,}_([A-Z][a-z]+_[a-z]{2,}(_[A-Za-z]\\w+|))\\b" );
60 final public static Pattern TAXOMONY_CODE_PATTERN_1 = Pattern
61 .compile( "\\b[A-Z9][A-Z]{2}[A-Z0-9]{2}|RAT|PIG|PEA|CAP\\b" );
62 final private static Pattern TAXOMONY_CODE_PATTERN_2 = Pattern
63 .compile( "([A-Z9][A-Z]{2}[A-Z0-9]{2}|RAT|PIG|PEA|CAP)[^0-9A-Za-z].*" );
64 final private static Pattern TAXOMONY_CODE_PATTERN_PF = Pattern
65 .compile( "([A-Z9][A-Z]{2}[A-Z0-9]{2}|RAT|PIG|PEA|CAP)/\\d+-\\d+" );
66 final private static Pattern TAXOMONY_UNIPROT_ID_PATTERN_1 = Pattern.compile( "\\b\\d{1,7}\\b" );
67 final private static Pattern TAXOMONY_UNIPROT_ID_PATTERN_2 = Pattern.compile( "(\\d{1,7})[^0-9A-Za-z].*" );
68 final private static Pattern TAXOMONY_UNIPROT_ID_PATTERN_PF = Pattern.compile( "(\\d{1,7})/\\d+-\\d+" );
70 final public static PhylogenyParser createParserDependingFileContents( final File file,
71 final boolean phyloxml_validate_against_xsd )
72 throws FileNotFoundException, IOException {
73 PhylogenyParser parser = null;
74 final String first_line = ForesterUtil.getFirstLine( file ).trim().toLowerCase();
75 if ( first_line.startsWith( "<" ) ) {
76 parser = new PhyloXmlParser();
77 if ( phyloxml_validate_against_xsd ) {
78 final ClassLoader cl = PhyloXmlParser.class.getClassLoader();
79 final URL xsd_url = cl.getResource( ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE );
80 if ( xsd_url != null ) {
81 ( ( PhyloXmlParser ) parser ).setValidateAgainstSchema( xsd_url.toString() );
84 if ( ForesterConstants.RELEASE ) {
85 throw new RuntimeException( "failed to get URL for phyloXML XSD from jar file from ["
86 + ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE + "]" );
91 else if ( ( first_line.startsWith( "nexus" ) ) || ( first_line.startsWith( "#nexus" ) )
92 || ( first_line.startsWith( "# nexus" ) ) || ( first_line.startsWith( "begin" ) ) ) {
93 parser = new NexusPhylogeniesParser();
96 parser = new NHXParser();
101 final public static PhylogenyParser createParserDependingOnFileType( final File file,
102 final boolean phyloxml_validate_against_xsd )
103 throws FileNotFoundException, IOException {
104 PhylogenyParser parser = null;
105 parser = ParserUtils.createParserDependingOnSuffix( file.getName(), phyloxml_validate_against_xsd );
106 if ( parser == null ) {
107 parser = createParserDependingFileContents( file, phyloxml_validate_against_xsd );
113 * Return null if it can not guess the parser to use based on name suffix.
118 final public static PhylogenyParser createParserDependingOnSuffix( final String filename,
119 final boolean phyloxml_validate_against_xsd ) {
120 PhylogenyParser parser = null;
121 final String filename_lc = filename.toLowerCase();
122 if ( filename_lc.endsWith( ".tol" ) || filename_lc.endsWith( ".tolxml" ) || filename_lc.endsWith( ".tol.zip" ) ) {
123 parser = new TolParser();
125 else if ( filename_lc.endsWith( ".xml" ) || filename_lc.endsWith( ".px" ) || filename_lc.endsWith( "phyloxml" )
126 || filename_lc.endsWith( ".zip" ) ) {
127 parser = new PhyloXmlParser();
128 if ( phyloxml_validate_against_xsd ) {
129 final ClassLoader cl = PhyloXmlParser.class.getClassLoader();
130 final URL xsd_url = cl.getResource( ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE );
131 if ( xsd_url != null ) {
132 ( ( PhyloXmlParser ) parser ).setValidateAgainstSchema( xsd_url.toString() );
135 if ( ForesterConstants.RELEASE ) {
136 throw new RuntimeException( "failed to get URL for phyloXML XSD from jar file from ["
137 + ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE + "]" );
142 else if ( filename_lc.endsWith( ".nexus" ) || filename_lc.endsWith( ".nex" ) || filename_lc.endsWith( ".nx" ) ) {
143 parser = new NexusPhylogeniesParser();
145 else if ( filename_lc.endsWith( ".nhx" ) || filename_lc.endsWith( ".nh" ) || filename_lc.endsWith( ".newick" )
146 || filename_lc.endsWith( ".nwk" ) ) {
147 parser = new NHXParser();
152 final public static PhylogenyParser createParserDependingOnUrlContents( final URL url,
153 final boolean phyloxml_validate_against_xsd )
154 throws FileNotFoundException, IOException {
155 final String lc_filename = url.getFile().toString().toLowerCase();
156 PhylogenyParser parser = createParserDependingOnSuffix( lc_filename, phyloxml_validate_against_xsd );
157 if ( ( parser != null ) && lc_filename.endsWith( ".zip" ) ) {
158 if ( parser instanceof PhyloXmlParser ) {
159 ( ( PhyloXmlParser ) parser ).setZippedInputstream( true );
161 else if ( parser instanceof TolParser ) {
162 ( ( TolParser ) parser ).setZippedInputstream( true );
165 if ( parser == null ) {
166 final String first_line = ForesterUtil.getFirstLine( url ).trim().toLowerCase();
167 if ( first_line.startsWith( "<" ) ) {
168 parser = new PhyloXmlParser();
169 if ( phyloxml_validate_against_xsd ) {
170 final ClassLoader cl = PhyloXmlParser.class.getClassLoader();
171 final URL xsd_url = cl.getResource( ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE );
172 if ( xsd_url != null ) {
173 ( ( PhyloXmlParser ) parser ).setValidateAgainstSchema( xsd_url.toString() );
176 throw new RuntimeException( "failed to get URL for phyloXML XSD from jar file from ["
177 + ForesterConstants.LOCAL_PHYLOXML_XSD_RESOURCE + "]" );
181 else if ( ( first_line.startsWith( "nexus" ) ) || ( first_line.startsWith( "#nexus" ) )
182 || ( first_line.startsWith( "# nexus" ) ) || ( first_line.startsWith( "begin" ) ) ) {
183 parser = new NexusPhylogeniesParser();
186 parser = new NHXParser();
192 public static BufferedReader createReader( final Object source ) throws IOException, FileNotFoundException {
193 BufferedReader reader = null;
194 if ( ( source instanceof File ) || ( source instanceof String ) ) {
196 if ( source instanceof File ) {
200 f = new File( ( String ) source );
203 throw new IOException( "[" + f.getAbsolutePath() + "] does not exist" );
205 else if ( !f.isFile() ) {
206 throw new IOException( "[" + f.getAbsolutePath() + "] is not a file" );
208 else if ( !f.canRead() ) {
209 throw new IOException( "[" + f.getAbsolutePath() + "] is not a readable" );
211 reader = new BufferedReader( new FileReader( f ) );
213 else if ( source instanceof InputStream ) {
214 reader = new BufferedReader( new InputStreamReader( ( InputStream ) source ) );
216 else if ( ( source instanceof StringBuffer ) || ( source instanceof StringBuilder ) ) {
217 reader = new BufferedReader( new StringReader( source.toString() ) );
220 throw new IllegalArgumentException( "attempt to parse object of type [" + source.getClass()
221 + "] (can only parse objects of type File/String, InputStream, StringBuffer, or StringBuilder)" );
226 public final static String extractTaxonomyCodeFromNodeName( final String name,
227 final TAXONOMY_EXTRACTION taxonomy_extraction ) {
228 if ( ( name.indexOf( "_" ) > 0 )
229 && ( ( taxonomy_extraction != TAXONOMY_EXTRACTION.PFAM_STYLE_STRICT ) || ( name.indexOf( "/" ) > 4 ) ) ) {
230 final String[] s = name.split( "[_\\s]" );
231 if ( s.length > 1 ) {
232 final String str = s[ 1 ];
233 if ( !ForesterUtil.isEmpty( str ) ) {
234 if ( taxonomy_extraction == TAXONOMY_EXTRACTION.PFAM_STYLE_STRICT ) {
235 final Matcher m = TAXOMONY_CODE_PATTERN_PF.matcher( str );
241 final Matcher m1 = TAXOMONY_CODE_PATTERN_1.matcher( str );
242 if ( m1.matches() ) {
245 final Matcher m2 = TAXOMONY_CODE_PATTERN_2.matcher( str );
246 if ( m2.matches() ) {
247 return m2.group( 1 );
253 else if ( taxonomy_extraction == TAXONOMY_EXTRACTION.PFAM_STYLE_RELAXED ) {
254 final Matcher m1 = TAXOMONY_CODE_PATTERN_1.matcher( name );
255 if ( m1.matches() ) {
262 public final static String extractScientificNameFromNodeName( final String name ) {
263 final Matcher m1 = TAXOMONY_SN_PATTERN.matcher( name );
264 if ( m1.matches() ) {
265 return m1.group( 1 ).replace( '_', ' ' );
270 public final static String extractTaxonomyDataFromNodeName( final PhylogenyNode node,
271 final NHXParser.TAXONOMY_EXTRACTION taxonomy_extraction )
272 throws PhyloXmlDataFormatException {
273 final String id = extractUniprotTaxonomyIdFromNodeName( node.getName(), taxonomy_extraction );
274 if ( !ForesterUtil.isEmpty( id ) ) {
275 if ( !node.getNodeData().isHasTaxonomy() ) {
276 node.getNodeData().setTaxonomy( new Taxonomy() );
278 if ( ( node.getNodeData().getTaxonomy().getIdentifier() == null )
279 || ForesterUtil.isEmpty( node.getNodeData().getTaxonomy().getIdentifier().getValue() ) ) {
280 node.getNodeData().getTaxonomy().setIdentifier( new Identifier( id, "uniprot" ) );
285 final String code = extractTaxonomyCodeFromNodeName( node.getName(), taxonomy_extraction );
286 if ( !ForesterUtil.isEmpty( code ) ) {
287 if ( !node.getNodeData().isHasTaxonomy() ) {
288 node.getNodeData().setTaxonomy( new Taxonomy() );
290 if ( ForesterUtil.isEmpty( node.getNodeData().getTaxonomy().getTaxonomyCode() ) ) {
291 node.getNodeData().getTaxonomy().setTaxonomyCode( code );
295 else if ( ( taxonomy_extraction == TAXONOMY_EXTRACTION.PFAM_STYLE_RELAXED )
296 || ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGRESSIVE ) ) {
297 final String sn = extractScientificNameFromNodeName( node.getName() );
298 if ( !ForesterUtil.isEmpty( sn ) ) {
299 if ( !node.getNodeData().isHasTaxonomy() ) {
300 node.getNodeData().setTaxonomy( new Taxonomy() );
302 if ( ForesterUtil.isEmpty( node.getNodeData().getTaxonomy().getScientificName() ) ) {
303 node.getNodeData().getTaxonomy().setScientificName( sn );
312 public final static String extractUniprotTaxonomyIdFromNodeName( final String name,
313 final TAXONOMY_EXTRACTION taxonomy_extraction ) {
314 if ( ( name.indexOf( "_" ) > 0 )
315 && ( ( taxonomy_extraction != TAXONOMY_EXTRACTION.PFAM_STYLE_STRICT ) || ( name.indexOf( "/" ) > 4 ) ) ) {
316 final String[] s = name.split( "[_\\s]" );
317 if ( s.length > 1 ) {
318 final String str = s[ 1 ];
319 if ( !ForesterUtil.isEmpty( str ) ) {
320 if ( taxonomy_extraction == TAXONOMY_EXTRACTION.PFAM_STYLE_STRICT ) {
321 final Matcher m = TAXOMONY_UNIPROT_ID_PATTERN_PF.matcher( str );
327 final Matcher m1 = TAXOMONY_UNIPROT_ID_PATTERN_1.matcher( str );
328 if ( m1.matches() ) {
331 final Matcher m2 = TAXOMONY_UNIPROT_ID_PATTERN_2.matcher( str );
332 if ( m2.matches() ) {
333 return m2.group( 1 );
339 if ( taxonomy_extraction == TAXONOMY_EXTRACTION.AGRESSIVE ) {
340 final Matcher m1 = TAXOMONY_UNIPROT_ID_PATTERN_1.matcher( name );
341 if ( m1.matches() ) {
348 public final static Phylogeny[] readPhylogenies( final File file ) throws FileNotFoundException, IOException {
349 return PhylogenyMethods.readPhylogenies( ParserUtils.createParserDependingOnFileType( file, true ), file );
352 public final static Phylogeny[] readPhylogenies( final String file_name ) throws FileNotFoundException, IOException {
353 return readPhylogenies( new File( file_name ) );