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.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.MsaWS;
\r
29 import compbio.data.sequence.Alignment;
\r
30 import compbio.data.sequence.FastaSequence;
\r
31 import compbio.engine.AsyncExecutor;
\r
32 import compbio.engine.Configurator;
\r
33 import compbio.engine.client.ConfiguredExecutable;
\r
34 import compbio.metadata.ChunkHolder;
\r
35 import compbio.metadata.JobStatus;
\r
36 import compbio.metadata.JobSubmissionException;
\r
37 import compbio.metadata.Limit;
\r
38 import compbio.metadata.LimitsManager;
\r
39 import compbio.metadata.Option;
\r
40 import compbio.metadata.Preset;
\r
41 import compbio.metadata.PresetManager;
\r
42 import compbio.metadata.ResultNotAvailableException;
\r
43 import compbio.metadata.RunnerConfig;
\r
44 import compbio.metadata.WrongParameterException;
\r
45 import compbio.runner.Util;
\r
46 import compbio.runner.msa.ClustalW;
\r
48 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = "http://msa.data.compbio/01/01/2010/", serviceName = "ClustalWS")
\r
49 public class ClustalWS implements MsaWS<ClustalW> {
\r
51 private static Logger log = Logger.getLogger(ClustalWS.class);
\r
53 private static final RunnerConfig<ClustalW> clustalOptions = Util
\r
54 .getSupportedOptions(ClustalW.class);
\r
56 private static final PresetManager<ClustalW> clustalPresets = Util
\r
57 .getPresets(ClustalW.class);
\r
59 private static final LimitsManager<ClustalW> limitMan = compbio.engine.client.Util
\r
60 .getLimits(new ClustalW().getType());
\r
63 public String align(List<FastaSequence> sequences)
\r
64 throws JobSubmissionException {
\r
66 WSUtil.validateFastaInput(sequences);
\r
67 ConfiguredExecutable<ClustalW> confClust = init(sequences);
\r
68 return WSUtil.align(sequences, confClust, log, "align", getLimit(""));
\r
71 ConfiguredExecutable<ClustalW> init(List<FastaSequence> dataSet)
\r
72 throws JobSubmissionException {
\r
73 ClustalW clustal = new ClustalW();
\r
74 ConfiguredExecutable<ClustalW> confClust = Configurator
\r
75 .configureExecutable(clustal, dataSet);
\r
80 public String presetAlign(List<FastaSequence> sequences,
\r
81 Preset<ClustalW> preset) throws JobSubmissionException,
\r
82 WrongParameterException {
\r
83 WSUtil.validateFastaInput(sequences);
\r
84 if (preset == null) {
\r
85 throw new WrongParameterException("Preset must be provided!");
\r
87 Limit<ClustalW> limit = getLimit(preset.getName());
\r
88 ConfiguredExecutable<ClustalW> confClust = init(sequences);
\r
89 confClust.addParameters(preset.getOptions());
\r
90 return WSUtil.align(sequences, confClust, log, "presetAlign", limit);
\r
94 public String customAlign(List<FastaSequence> sequences,
\r
95 List<Option<ClustalW>> options) throws JobSubmissionException,
\r
96 WrongParameterException {
\r
97 WSUtil.validateFastaInput(sequences);
\r
98 ConfiguredExecutable<ClustalW> confClust = init(sequences);
\r
99 List<String> params = WSUtil.getCommands(options,
\r
100 ClustalW.KEY_VALUE_SEPARATOR);
\r
101 confClust.addParameters(params);
\r
102 log.info("Setting parameters: " + params);
\r
103 return WSUtil.align(sequences, confClust, log, "customAlign",
\r
108 public RunnerConfig<ClustalW> getRunnerOptions() {
\r
109 return clustalOptions;
\r
112 @SuppressWarnings("unchecked")
\r
114 public Alignment getResult(String jobId) throws ResultNotAvailableException {
\r
116 WSUtil.validateJobId(jobId);
\r
117 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);
\r
118 ConfiguredExecutable<ClustalW> clustal = (ConfiguredExecutable<ClustalW>) asyncEngine
\r
119 .getResults(jobId);
\r
120 Alignment al = clustal.getResults();
\r
126 public Limit<ClustalW> getLimit(String presetName) {
\r
127 if (limitMan == null) {
\r
128 // No limit is configured
\r
131 Limit<ClustalW> limit = limitMan.getLimitByName(presetName);
\r
136 public LimitsManager<ClustalW> getLimits() {
\r
141 public boolean cancelJob(String jobId) {
\r
142 WSUtil.validateJobId(jobId);
\r
143 boolean result = WSUtil.cancelJob(jobId);
\r
148 public JobStatus getJobStatus(String jobId) {
\r
149 WSUtil.validateJobId(jobId);
\r
150 JobStatus status = WSUtil.getJobStatus(jobId);
\r
155 public PresetManager<ClustalW> getPresets() {
\r
156 return clustalPresets;
\r
160 public ChunkHolder pullExecStatistics(String jobId, long position) {
\r
162 WSUtil.validateJobId(jobId);
\r
163 String file = Configurator.getWorkDirectory(jobId) + File.separator
\r
164 + ClustalW.getStatFile();
\r
165 ChunkHolder cholder = WSUtil.pullFile(file, position);
\r