1 /* Copyright (c) 2009 Peter Troshin
\r
3 * JAva Bioinformatics Analysis Web Services (JABAWS) @version: 1.0
\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
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
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
15 * Any republication or derived work distributed in source code form
\r
16 * must include this copyright and license notice.
\r
19 package compbio.runner.msa;
\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
26 import org.apache.log4j.Logger;
\r
28 import compbio.data.sequence.Alignment;
\r
29 import compbio.data.sequence.UnknownFileFormatException;
\r
30 import compbio.engine.client.CommandBuilder;
\r
31 import compbio.engine.client.Executable;
\r
32 import compbio.engine.client.PipedExecutable;
\r
33 import compbio.engine.client.SkeletalExecutable;
\r
34 import compbio.engine.conf.PropertyHelperManager;
\r
35 import compbio.metadata.ResultNotAvailableException;
\r
36 import compbio.runner.Util;
\r
37 import compbio.util.PropertyHelper;
\r
39 public class Tcoffee extends SkeletalExecutable<Tcoffee>
\r
40 implements PipedExecutable<Tcoffee> {
\r
42 private static Logger log = Logger.getLogger(Tcoffee.class);
\r
44 private static PropertyHelper ph = PropertyHelperManager
\r
45 .getPropertyHelper();
\r
47 public static final String KEY_VALUE_SEPARATOR = "=";
\r
50 * Number of cores to use, defaults to 1 for local execution or the value of
\r
51 * "tcoffee.cluster.cpunum" property for cluster execution
\r
53 private int ncoreNumber = 0;
\r
56 * Number of cores parameter name
\r
58 private final static String ncorePrm = "-n_core";
\r
62 * @param workDirectory
\r
65 super(KEY_VALUE_SEPARATOR);
\r
67 * Use "-quiet" to disable sdtout and progress to stderr inorder=input -
\r
68 * prevent t-coffee from sorting sequences
\r
70 addParameters(Arrays.asList("-output=clustalw"));
\r
71 setInput(super.inputFile);
\r
75 public Tcoffee setInput(String inFile) {
\r
76 super.setInput(inFile);
\r
77 cbuilder.setParam("-seq", inFile);
\r
81 @SuppressWarnings("unchecked")
\r
83 public Alignment getResults(String workDirectory)
\r
84 throws ResultNotAvailableException {
\r
86 return Util.readClustalFile(workDirectory, getOutput());
\r
87 } catch (FileNotFoundException e) {
\r
88 log.error(e.getMessage(), e.getCause());
\r
89 throw new ResultNotAvailableException(e);
\r
90 } catch (IOException e) {
\r
91 log.error(e.getMessage(), e.getCause());
\r
92 throw new ResultNotAvailableException(e);
\r
93 } catch (UnknownFileFormatException e) {
\r
94 log.error(e.getMessage(), e.getCause());
\r
95 throw new ResultNotAvailableException(e);
\r
96 } catch (NullPointerException e) {
\r
97 log.error(e.getMessage(), e.getCause());
\r
98 throw new ResultNotAvailableException(e);
\r
103 public List<String> getCreatedFiles() {
\r
104 return Arrays.asList(getOutput());
\r
107 public void setNCore(int ncoreNumber) {
\r
108 if (ncoreNumber < 1 || ncoreNumber > 100) {
\r
109 throw new IndexOutOfBoundsException(
\r
110 "Number of cores must be within 1 and 100 ");
\r
112 this.ncoreNumber = ncoreNumber;
\r
113 cbuilder.setParam(ncorePrm, Integer.toString(getNCore()));
\r
117 return ncoreNumber;
\r
121 public CommandBuilder<Tcoffee> getParameters(ExecProvider provider) {
\r
122 // Limit number of cores to 1 for ANY execution which does not set
\r
123 // Ncores explicitly using setNCore method
\r
124 if (ncoreNumber == 0) {
\r
127 if (provider == Executable.ExecProvider.Cluster) {
\r
128 int cpunum = SkeletalExecutable.getClusterCpuNum(getType());
\r
133 return super.getParameters(provider);
\r
137 @SuppressWarnings("unchecked")
\r
139 public Class<Tcoffee> getType() {
\r
140 return (Class<Tcoffee>) this.getClass();
\r