forester/java/src/org/forester/msa/ClustalOmega.java

   1 // $Id:
   2 // forester -- software libraries and applications
   3 // for genomics and evolutionary biology research.
   4 //
   5 // Copyright (C) 2010 Christian M Zmasek
   6 // Copyright (C) 2010 Sanford-Burnham Medical Research Institute
   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.msa;
  27
  28 import java.io.File;
  29 import java.io.IOException;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32
  33 import org.forester.io.parsers.FastaParser;
  34 import org.forester.util.SystemCommandExecutor;
  35
  36 public final class ClustalOmega implements MsaInferrer {
  37
  38     private final static String DEFAULT_PARAMETERS = "";
  39     private String              _error;
  40     private int                 _exit_code;
  41     private final String        _path_to_prg;
  42
  43
  44
  45     public static MsaInferrer createInstance( final String path_to_prg ) throws IOException {
  46         return new ClustalOmega( path_to_prg );
  47     }
  48
  49
  50
  51     private ClustalOmega( final String path_to_prg ) throws IOException {
  52         if ( !SystemCommandExecutor.isExecuteableFile( new File( path_to_prg ) ) ) {
  53             throw new IOException( "cannot execute MAFFT with \"" + path_to_prg + "\"" );
  54         }
  55         _path_to_prg = new String( path_to_prg );
  56         init();
  57     }
  58
  59     public static String getDefaultParameters() {
  60         return DEFAULT_PARAMETERS;
  61     }
  62
  63     @Override
  64     public Object clone() {
  65         throw new NoSuchMethodError();
  66     }
  67
  68     @Override
  69     public String getErrorDescription() {
  70         return _error;
  71     }
  72
  73     @Override
  74     public int getExitCode() {
  75         return _exit_code;
  76     }
  77
  78     @Override
  79     public Msa infer( final File path_to_input_seqs, final List<String> opts ) throws IOException, InterruptedException {
  80         init();
  81         final List<String> my_opts = new ArrayList<String>();
  82         my_opts.add( _path_to_prg );
  83         for( int i = 0; i < opts.size(); i++ ) {
  84             my_opts.add( opts.get( i ) );
  85         }
  86         my_opts.add( path_to_input_seqs.getAbsolutePath() );
  87         final SystemCommandExecutor command_executor = new SystemCommandExecutor( my_opts );
  88         final int _exit_code = command_executor.executeCommand();
  89         final StringBuilder stderr = command_executor.getStandardErrorFromCommand();
  90         _error = stderr.toString();
  91         if ( _exit_code != 0 ) {
  92             throw new IOException( "Clustal Omega program failed, exit code: " + _exit_code + "\nCommand:\n" + my_opts
  93                     + "\nError:\n" + stderr );
  94         }
  95         final StringBuilder stdout = command_executor.getStandardOutputFromCommand();
  96         if ( ( stdout == null ) || ( stdout.length() < 2 ) ) {
  97             throw new IOException( "Clustal Omega program did not produce any output\nCommand:\n" + my_opts + "\nError:\n"
  98                     + stderr );
  99         }
 100         final Msa msa = FastaParser.parseMsa( stdout.toString() );
 101         return msa;
 102     }
 103
 104     private void init() {
 105         _error = null;
 106         _exit_code = -100;
 107     }
 108 }