1 /* Copyright (c) 2011 Peter Troshin
\r
3 * JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.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.ws.server;
\r
21 import java.io.File;
\r
22 import java.util.List;
\r
24 import javax.jws.WebService;
\r
26 import org.apache.log4j.Logger;
\r
28 import compbio.data.msa.JABAService;
\r
29 import compbio.data.msa.MsaWS;
\r
30 import compbio.data.sequence.Alignment;
\r
31 import compbio.data.sequence.FastaSequence;
\r
32 import compbio.data.sequence.Program;
\r
33 import compbio.engine.AsyncExecutor;
\r
34 import compbio.engine.Configurator;
\r
35 import compbio.engine.client.ConfiguredExecutable;
\r
36 import compbio.engine.client.SkeletalExecutable;
\r
37 import compbio.engine.client.EngineUtil;
\r
38 import compbio.metadata.ChunkHolder;
\r
39 import compbio.metadata.JobStatus;
\r
40 import compbio.metadata.JobSubmissionException;
\r
41 import compbio.metadata.Limit;
\r
42 import compbio.metadata.LimitsManager;
\r
43 import compbio.metadata.Option;
\r
44 import compbio.metadata.Preset;
\r
45 import compbio.metadata.PresetManager;
\r
46 import compbio.metadata.ResultNotAvailableException;
\r
47 import compbio.metadata.RunnerConfig;
\r
48 import compbio.metadata.WrongParameterException;
\r
49 import compbio.runner.RunnerUtil;
\r
50 import compbio.runner.msa.Mafft;
\r
52 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = JABAService.SERVICE_NAMESPACE, serviceName = "MafftWS")
\r
53 public class MafftWS implements MsaWS<Mafft> {
\r
55 private static Logger log = Logger.getLogger(MafftWS.class);
\r
56 private static final RunnerConfig<Mafft> mafftOptions = RunnerUtil.getSupportedOptions(Mafft.class);
\r
57 private static final PresetManager<Mafft> mafftPresets = RunnerUtil.getPresets(Mafft.class);
\r
58 private static final LimitsManager<Mafft> limitMan = EngineUtil.getLimits(new Mafft().getType());
\r
61 public String align(List<FastaSequence> sequences) throws JobSubmissionException {
\r
62 WSUtil.validateFastaInput(sequences);
\r
63 ConfiguredExecutable<Mafft> confMafft = init(sequences);
\r
64 return WSUtil.align(sequences, confMafft, log, "align", getLimit(""));
\r
67 ConfiguredExecutable<Mafft> init(List<FastaSequence> dataSet) throws JobSubmissionException {
\r
68 Mafft mafft = new Mafft();
\r
69 mafft.setInput(SkeletalExecutable.INPUT);
\r
70 mafft.setOutput(SkeletalExecutable.OUTPUT);
\r
71 mafft.setError(SkeletalExecutable.ERROR);
\r
72 return Configurator.configureExecutable(mafft, dataSet);
\r
76 public String customAlign(List<FastaSequence> sequences, List<Option<Mafft>> options) throws JobSubmissionException,
\r
77 WrongParameterException {
\r
78 WSUtil.validateFastaInput(sequences);
\r
79 ConfiguredExecutable<Mafft> confMafft = init(sequences);
\r
80 List<String> params = WSUtil.getCommands(options, Mafft.KEY_VALUE_SEPARATOR);
\r
81 log.info("Setting parameters: " + params);
\r
82 confMafft.addParameters(params);
\r
83 return WSUtil.align(sequences, confMafft, log, "customAlign", getLimit(""));
\r
87 public String presetAlign(List<FastaSequence> sequences, Preset<Mafft> preset) throws JobSubmissionException, WrongParameterException {
\r
88 WSUtil.validateFastaInput(sequences);
\r
89 if (preset == null) {
\r
90 throw new WrongParameterException("Preset must be provided!");
\r
92 ConfiguredExecutable<Mafft> confMafft = init(sequences);
\r
93 confMafft.addParameters(preset.getOptions());
\r
94 // This will return default limit if a specific the limit for a
\r
95 // particular preset is not found
\r
96 Limit<Mafft> limit = getLimit(preset.getName());
\r
98 return WSUtil.align(sequences, confMafft, log, "presetAlign", limit);
\r
101 @SuppressWarnings("unchecked")
\r
103 public Alignment getResult(String jobId) throws ResultNotAvailableException {
\r
104 WSUtil.validateJobId(jobId);
\r
105 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);
\r
106 ConfiguredExecutable<Mafft> mafft = (ConfiguredExecutable<Mafft>) asyncEngine.getResults(jobId);
\r
107 Alignment al = mafft.getResults();
\r
108 return new Alignment(al.getSequences(), Program.Mafft, '-');
\r
112 public Limit<Mafft> getLimit(String presetName) {
\r
113 if (limitMan == null) {
\r
114 // Limit is not defined
\r
117 return limitMan.getLimitByName(presetName);
\r
121 public LimitsManager<Mafft> getLimits() {
\r
126 public ChunkHolder pullExecStatistics(String jobId, long position) {
\r
127 WSUtil.validateJobId(jobId);
\r
128 String file = Configurator.getWorkDirectory(jobId) + File.separator + new Mafft().getError();
\r
129 return WSUtil.pullFile(file, position);
\r
133 public boolean cancelJob(String jobId) {
\r
134 WSUtil.validateJobId(jobId);
\r
135 return WSUtil.cancelJob(jobId);
\r
139 public JobStatus getJobStatus(String jobId) {
\r
140 WSUtil.validateJobId(jobId);
\r
141 return WSUtil.getJobStatus(jobId);
\r
145 public PresetManager<Mafft> getPresets() {
\r
146 return mafftPresets;
\r
150 public RunnerConfig<Mafft> getRunnerOptions() {
\r
151 return mafftOptions;
\r