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      * Multi-threading supported with e.g. "thread 4" only for Linux, so JABAWS \r
  47      * will not support it for now, it also need editing of mafft makefile  \r
  48          */\r
  49         \r
  50         \r
  51         private static Logger log = Logger.getLogger(Mafft.class);\r
  52 \r
  53         private static String autoOption = "--auto";\r
  54 \r
  55         private final String MATRIX_PAR_NAME = "--aamatrix";\r
  56 \r
  57         public static final String KEY_VALUE_SEPARATOR = Util.SPACE;\r
  58 \r
  59         public Mafft() {\r
  60                 // remove default input to prevent it to appear in the parameters list\r
  61                 // that could happen if the parameters are set first\r
  62                 // super.setInput("");\r
  63                 addParameters(Arrays.asList("--clustalout", autoOption));\r
  64         }\r
  65 \r
  66         @SuppressWarnings("unchecked")\r
  67         public Alignment getResults(String workDirectory)\r
  68                         throws ResultNotAvailableException {\r
  69                 try {\r
  70                         return Util.readClustalFile(workDirectory, getOutput());\r
  71                 } catch (FileNotFoundException e) {\r
  72                         log.error(e.getMessage(), e.getCause());\r
  73                         throw new ResultNotAvailableException(e);\r
  74                 } catch (IOException e) {\r
  75                         log.error(e.getMessage(), e.getCause());\r
  76                         throw new ResultNotAvailableException(e);\r
  77                 } catch (UnknownFileFormatException e) {\r
  78                         log.error(e.getMessage(), e.getCause());\r
  79                         throw new ResultNotAvailableException(e);\r
  80                 } catch (NullPointerException e) {\r
  81                         log.error(e.getMessage(), e.getCause());\r
  82                         throw new ResultNotAvailableException(e);\r
  83                 }\r
  84         }\r
  85 \r
  86         @Override\r
  87         public Mafft setInput(String inFile) {\r
  88                 super.setInput(inFile);\r
  89                 cbuilder.setLast(inFile);\r
  90                 return this;\r
  91         }\r
  92 \r
  93         /**\r
  94          * Mafft input must always be the last parameter!\r
  95          */\r
  96         @Override\r
  97         public Mafft addParameters(List<String> parameters) {\r
  98                 cbuilder.addParams(parameters);\r
  99                 cbuilder.removeParam(autoOption);\r
 100                 return this;\r
 101         }\r
 102 \r
 103 \r
 104         \r
 105         @SuppressWarnings("unchecked")\r
 106         @Override\r
 107         public Class<Mafft> getType() {\r
 108                 return (Class<Mafft>) this.getClass();\r
 109         }\r
 110 \r
 111         /*\r
 112          * @Override public List<String> getParameters(\r
 113          * compbio.runner.Executable.ExecProvider provider) { for (int i = 0; i <\r
 114          * param.size(); i++) { String par = param.get(i); if\r
 115          * (isMatrixParameter(par)) { String matrixName = getValue(i); if (new\r
 116          * File(matrixName).isAbsolute()) { // Matrix can be found so no actions\r
 117          * necessary // This method has been called already and the matrix name //\r
 118          * is modified to contain full path // no further actions is necessary\r
 119          * break; } String matrixPath = Util.getExecProperty("matrix.path", this);\r
 120          * String absMatrixPath = Util.convertToAbsolute(matrixPath); param.remove(i\r
 121          * + 1); param.remove(i); super.addParameter(MATRIX_PAR_NAME);\r
 122          * super.addParameter(absMatrixPath + File.separator + matrixName); break; }\r
 123          * } return super.getParameters(provider); }\r
 124          * \r
 125          * boolean isMatrixParameter(String parameter) { assert\r
 126          * !compbio.util.Util.isEmpty(parameter); if\r
 127          * (parameter.toUpperCase().startsWith(MATRIX_PAR_NAME)) { return true; }\r
 128          * return false; }\r
 129          * \r
 130          * String getValue(int i) { return param.get(i + 1); }\r
 131          */\r
 132 }\r