webservices/compbio/ws/server/ClustalWS.java

   1 /* Copyright (c) 2011 Peter Troshin\r
   2  *  \r
   3  *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.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.ws.server;\r
  20 \r
  21 import java.io.File;\r
  22 import java.util.List;\r
  23 \r
  24 import javax.jws.WebService;\r
  25 \r
  26 import org.apache.log4j.Logger;\r
  27 \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.engine.AsyncExecutor;\r
  33 import compbio.engine.Configurator;\r
  34 import compbio.engine.client.ConfiguredExecutable;\r
  35 import compbio.engine.client.SkeletalExecutable;\r
  36 import compbio.metadata.ChunkHolder;\r
  37 import compbio.metadata.JobStatus;\r
  38 import compbio.metadata.JobSubmissionException;\r
  39 import compbio.metadata.Limit;\r
  40 import compbio.metadata.LimitsManager;\r
  41 import compbio.metadata.Option;\r
  42 import compbio.metadata.Preset;\r
  43 import compbio.metadata.PresetManager;\r
  44 import compbio.metadata.ResultNotAvailableException;\r
  45 import compbio.metadata.RunnerConfig;\r
  46 import compbio.metadata.WrongParameterException;\r
  47 import compbio.runner.Util;\r
  48 import compbio.runner.msa.ClustalW;\r
  49 \r
  50 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = JABAService.SERVICE_NAMESPACE, serviceName = "ClustalWS")\r
  51 public class ClustalWS implements MsaWS<ClustalW> {\r
  52 \r
  53         private static Logger log = Logger.getLogger(ClustalWS.class);\r
  54 \r
  55         private static final RunnerConfig<ClustalW> clustalOptions = Util\r
  56                         .getSupportedOptions(ClustalW.class);\r
  57 \r
  58         private static final PresetManager<ClustalW> clustalPresets = Util\r
  59                         .getPresets(ClustalW.class);\r
  60 \r
  61         private static final LimitsManager<ClustalW> limitMan = compbio.engine.client.Util\r
  62                         .getLimits(new ClustalW().getType());\r
  63 \r
  64         @Override\r
  65         public String align(List<FastaSequence> sequences)\r
  66                         throws JobSubmissionException {\r
  67 \r
  68                 WSUtil.validateFastaInput(sequences);\r
  69                 ConfiguredExecutable<ClustalW> confClust = init(sequences);\r
  70                 return WSUtil.align(sequences, confClust, log, "align", getLimit(""));\r
  71         }\r
  72 \r
  73         ConfiguredExecutable<ClustalW> init(List<FastaSequence> dataSet)\r
  74                         throws JobSubmissionException {\r
  75                 ClustalW clustal = new ClustalW();\r
  76                 clustal.setInput(SkeletalExecutable.INPUT)\r
  77                                 .setOutput(SkeletalExecutable.OUTPUT)\r
  78                                 .setError(SkeletalExecutable.ERROR);\r
  79                 ConfiguredExecutable<ClustalW> confClust = Configurator\r
  80                                 .configureExecutable(clustal, dataSet);\r
  81                 return confClust;\r
  82         }\r
  83 \r
  84         @Override\r
  85         public String presetAlign(List<FastaSequence> sequences,\r
  86                         Preset<ClustalW> preset) throws JobSubmissionException,\r
  87                         WrongParameterException {\r
  88                 WSUtil.validateFastaInput(sequences);\r
  89                 if (preset == null) {\r
  90                         throw new WrongParameterException("Preset must be provided!");\r
  91                 }\r
  92                 Limit<ClustalW> limit = getLimit(preset.getName());\r
  93                 ConfiguredExecutable<ClustalW> confClust = init(sequences);\r
  94                 confClust.addParameters(preset.getOptions());\r
  95                 return WSUtil.align(sequences, confClust, log, "presetAlign", limit);\r
  96         }\r
  97 \r
  98         @Override\r
  99         public String customAlign(List<FastaSequence> sequences,\r
 100                         List<Option<ClustalW>> options) throws JobSubmissionException,\r
 101                         WrongParameterException {\r
 102                 WSUtil.validateFastaInput(sequences);\r
 103                 ConfiguredExecutable<ClustalW> confClust = init(sequences);\r
 104                 List<String> params = WSUtil.getCommands(options,\r
 105                                 ClustalW.KEY_VALUE_SEPARATOR);\r
 106                 confClust.addParameters(params);\r
 107                 log.info("Setting parameters: " + params);\r
 108                 return WSUtil.align(sequences, confClust, log, "customAlign",\r
 109                                 getLimit(""));\r
 110         }\r
 111 \r
 112         @Override\r
 113         public RunnerConfig<ClustalW> getRunnerOptions() {\r
 114                 return clustalOptions;\r
 115         }\r
 116 \r
 117         @SuppressWarnings("unchecked")\r
 118         @Override\r
 119         public Alignment getResult(String jobId) throws ResultNotAvailableException {\r
 120 \r
 121                 WSUtil.validateJobId(jobId);\r
 122                 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);\r
 123                 ConfiguredExecutable<ClustalW> clustal = (ConfiguredExecutable<ClustalW>) asyncEngine\r
 124                                 .getResults(jobId);\r
 125                 Alignment al = clustal.getResults();\r
 126 \r
 127                 return al;\r
 128         }\r
 129 \r
 130         @Override\r
 131         public Limit<ClustalW> getLimit(String presetName) {\r
 132                 if (limitMan == null) {\r
 133                         // No limit is configured\r
 134                         return null;\r
 135                 }\r
 136                 Limit<ClustalW> limit = limitMan.getLimitByName(presetName);\r
 137                 return limit;\r
 138         }\r
 139 \r
 140         @Override\r
 141         public LimitsManager<ClustalW> getLimits() {\r
 142                 return limitMan;\r
 143         }\r
 144 \r
 145         @Override\r
 146         public boolean cancelJob(String jobId) {\r
 147                 WSUtil.validateJobId(jobId);\r
 148                 boolean result = WSUtil.cancelJob(jobId);\r
 149                 return result;\r
 150         }\r
 151 \r
 152         @Override\r
 153         public JobStatus getJobStatus(String jobId) {\r
 154                 WSUtil.validateJobId(jobId);\r
 155                 JobStatus status = WSUtil.getJobStatus(jobId);\r
 156                 return status;\r
 157         }\r
 158 \r
 159         @Override\r
 160         public PresetManager<ClustalW> getPresets() {\r
 161                 return clustalPresets;\r
 162         }\r
 163 \r
 164         @Override\r
 165         public ChunkHolder pullExecStatistics(String jobId, long position) {\r
 166 \r
 167                 WSUtil.validateJobId(jobId);\r
 168                 String file = Configurator.getWorkDirectory(jobId) + File.separator\r
 169                                 + ClustalW.getStatFile();\r
 170                 ChunkHolder cholder = WSUtil.pullFile(file, position);\r
 171                 return cholder;\r
 172         }\r
 173 \r
 174 }\r