runner/compbio/runner/msa/Mafft.java

   1 /* Copyright (c) 2009 Peter Troshin\r
   2  *  \r
   3  *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0 \r
   4  * \r
   5  *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
   6  *  Apache License version 2 as published by the Apache Software Foundation\r
   7  * \r
   8  *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\r
   9  *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache \r
  10  *  License for more details.\r
  11  * \r
  12  *  A copy of the license is in apache_license.txt. It is also available here:\r
  13  * @see: http://www.apache.org/licenses/LICENSE-2.0.txt\r
  14  * \r
  15  * Any republication or derived work distributed in source code form\r
  16  * must include this copyright and license notice.\r
  17  */\r
  18 \r
  19 package compbio.runner.msa;\r
  20 \r
  21 import java.io.FileNotFoundException;\r
  22 import java.io.IOException;\r
  23 import java.util.Arrays;\r
  24 import java.util.List;\r
  25 \r
  26 import org.apache.log4j.Logger;\r
  27 \r
  28 import compbio.data.sequence.Alignment;\r
  29 import compbio.data.sequence.UnknownFileFormatException;\r
  30 \r
  31 import compbio.engine.client.PipedExecutable;\r
  32 import compbio.engine.client.SkeletalExecutable;\r
  33 import compbio.metadata.ResultNotAvailableException;\r
  34 import compbio.runner.Util;\r
  35 \r
  36 /**\r
  37  * \r
  38  * @author pvtroshin\r
  39  *\r
  40  */\r
  41 public class Mafft extends SkeletalExecutable<Mafft>\r
  42                 implements\r
  43                         PipedExecutable<Mafft> {\r
  44         /*\r
  45          * TODO get rid of piping: Mafft now supports --out option for output file. \r
  46      * Multithreading support does not seem to work reliably!  \r
  47          */\r
  48         \r
  49         \r
  50         private static Logger log = Logger.getLogger(Mafft.class);\r
  51 \r
  52         private static String autoOption = "--auto";\r
  53 \r
  54         private final String MATRIX_PAR_NAME = "--aamatrix";\r
  55 \r
  56         public static final String KEY_VALUE_SEPARATOR = Util.SPACE;\r
  57 \r
  58         public Mafft() {\r
  59                 // remove default input to prevent it to appear in the parameters list\r
  60                 // that could happen if the parameters are set first\r
  61                 // super.setInput("");\r
  62                 addParameters(Arrays.asList("--clustalout", autoOption));\r
  63         }\r
  64 \r
  65         @SuppressWarnings("unchecked")\r
  66         public Alignment getResults(String workDirectory)\r
  67                         throws ResultNotAvailableException {\r
  68                 try {\r
  69                         return Util.readClustalFile(workDirectory, getOutput());\r
  70                 } catch (FileNotFoundException e) {\r
  71                         log.error(e.getMessage(), e.getCause());\r
  72                         throw new ResultNotAvailableException(e);\r
  73                 } catch (IOException e) {\r
  74                         log.error(e.getMessage(), e.getCause());\r
  75                         throw new ResultNotAvailableException(e);\r
  76                 } catch (UnknownFileFormatException e) {\r
  77                         log.error(e.getMessage(), e.getCause());\r
  78                         throw new ResultNotAvailableException(e);\r
  79                 } catch (NullPointerException e) {\r
  80                         log.error(e.getMessage(), e.getCause());\r
  81                         throw new ResultNotAvailableException(e);\r
  82                 }\r
  83         }\r
  84 \r
  85         @Override\r
  86         public Mafft setInput(String inFile) {\r
  87                 super.setInput(inFile);\r
  88                 cbuilder.setLast(inFile);\r
  89                 return this;\r
  90         }\r
  91 \r
  92         /**\r
  93          * Mafft input must always be the last parameter!\r
  94          */\r
  95         @Override\r
  96         public Mafft addParameters(List<String> parameters) {\r
  97                 cbuilder.addParams(parameters);\r
  98                 cbuilder.removeParam(autoOption);\r
  99                 return this;\r
 100         }\r
 101 \r
 102 \r
 103         \r
 104         @SuppressWarnings("unchecked")\r
 105         @Override\r
 106         public Class<Mafft> getType() {\r
 107                 return (Class<Mafft>) this.getClass();\r
 108         }\r
 109 \r
 110         /*\r
 111          * @Override public List<String> getParameters(\r
 112          * compbio.runner.Executable.ExecProvider provider) { for (int i = 0; i <\r
 113          * param.size(); i++) { String par = param.get(i); if\r
 114          * (isMatrixParameter(par)) { String matrixName = getValue(i); if (new\r
 115          * File(matrixName).isAbsolute()) { // Matrix can be found so no actions\r
 116          * necessary // This method has been called already and the matrix name //\r
 117          * is modified to contain full path // no further actions is necessary\r
 118          * break; } String matrixPath = Util.getExecProperty("matrix.path", this);\r
 119          * String absMatrixPath = Util.convertToAbsolute(matrixPath); param.remove(i\r
 120          * + 1); param.remove(i); super.addParameter(MATRIX_PAR_NAME);\r
 121          * super.addParameter(absMatrixPath + File.separator + matrixName); break; }\r
 122          * } return super.getParameters(provider); }\r
 123          * \r
 124          * boolean isMatrixParameter(String parameter) { assert\r
 125          * !compbio.util.Util.isEmpty(parameter); if\r
 126          * (parameter.toUpperCase().startsWith(MATRIX_PAR_NAME)) { return true; }\r
 127          * return false; }\r
 128          * \r
 129          * String getValue(int i) { return param.get(i + 1); }\r
 130          */\r
 131 }\r