webservices/compbio/ws/server/MuscleWS.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.Muscle;\r
  49 \r
  50 @WebService(endpointInterface = "compbio.data.msa.MsaWS", targetNamespace = JABAService.SERVICE_NAMESPACE, serviceName = "MuscleWS")\r
  51 public class MuscleWS implements MsaWS<Muscle> {\r
  52 \r
  53         private static Logger log = Logger.getLogger(MuscleWS.class);\r
  54 \r
  55         private static final RunnerConfig<Muscle> muscleOptions = Util\r
  56                         .getSupportedOptions(Muscle.class);\r
  57 \r
  58         private static final PresetManager<Muscle> musclePresets = Util\r
  59                         .getPresets(Muscle.class);\r
  60 \r
  61         private static final LimitsManager<Muscle> limitMan = compbio.engine.client.Util\r
  62                         .getLimits(new Muscle().getType());\r
  63 \r
  64         @Override\r
  65         public String align(List<FastaSequence> sequences)\r
  66                         throws JobSubmissionException {\r
  67                 WSUtil.validateFastaInput(sequences);\r
  68                 ConfiguredExecutable<Muscle> confMuscle = init(sequences);\r
  69                 return WSUtil.align(sequences, confMuscle, null, "align", getLimit(""));\r
  70         }\r
  71 \r
  72         ConfiguredExecutable<Muscle> init(List<FastaSequence> sequences)\r
  73                         throws JobSubmissionException {\r
  74                 Muscle muscle = new Muscle();\r
  75                 muscle.setInput(SkeletalExecutable.INPUT)\r
  76                                 .setOutput(SkeletalExecutable.OUTPUT)\r
  77                                 .setError(SkeletalExecutable.ERROR);\r
  78                 return Configurator.configureExecutable(muscle, sequences);\r
  79         }\r
  80 \r
  81         @Override\r
  82         public String customAlign(List<FastaSequence> sequences,\r
  83                         List<Option<Muscle>> options) throws JobSubmissionException,\r
  84                         WrongParameterException {\r
  85                 WSUtil.validateFastaInput(sequences);\r
  86                 ConfiguredExecutable<Muscle> confMuscle = init(sequences);\r
  87                 // Could not do that! Space separated values\r
  88                 // will all be treated as keys! thus duplicates removed\r
  89                 // String params = cbuilder.getCommand();\r
  90                 List<String> params = WSUtil.getCommands(options,\r
  91                                 Muscle.KEY_VALUE_SEPARATOR);\r
  92                 confMuscle.addParameters(params);\r
  93                 return WSUtil.align(sequences, confMuscle, null, "customAlign",\r
  94                                 getLimit(""));\r
  95         }\r
  96 \r
  97         @Override\r
  98         public String presetAlign(List<FastaSequence> sequences,\r
  99                         Preset<Muscle> preset) throws JobSubmissionException,\r
 100                         WrongParameterException {\r
 101                 WSUtil.validateFastaInput(sequences);\r
 102                 if (preset == null) {\r
 103                         throw new WrongParameterException("Preset must be provided!");\r
 104                 }\r
 105                 ConfiguredExecutable<Muscle> confMuscle = init(sequences);\r
 106                 confMuscle.addParameters(preset.getOptions());\r
 107                 Limit<Muscle> limit = getLimit(preset.getName());\r
 108                 return WSUtil.align(sequences, confMuscle, null, "presetAlign", limit);\r
 109         }\r
 110 \r
 111         @SuppressWarnings("unchecked")\r
 112         @Override\r
 113         public Alignment getResult(String jobId) throws ResultNotAvailableException {\r
 114                 WSUtil.validateJobId(jobId);\r
 115                 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);\r
 116                 ConfiguredExecutable<Muscle> muscle = (ConfiguredExecutable<Muscle>) asyncEngine\r
 117                                 .getResults(jobId);\r
 118                 Alignment al = muscle.getResults();\r
 119                 // log(jobId, "getResults");\r
 120                 return al;\r
 121         }\r
 122 \r
 123         @Override\r
 124         public Limit<Muscle> getLimit(String presetName) {\r
 125                 if (limitMan == null) {\r
 126                         // No limit is configured\r
 127                         return null;\r
 128                 }\r
 129                 return limitMan.getLimitByName(presetName);\r
 130         }\r
 131 \r
 132         @Override\r
 133         public LimitsManager<Muscle> getLimits() {\r
 134                 return limitMan;\r
 135         }\r
 136 \r
 137         @Override\r
 138         public ChunkHolder pullExecStatistics(String jobId, long position) {\r
 139                 WSUtil.validateJobId(jobId);\r
 140                 String file = Configurator.getWorkDirectory(jobId) + File.separator\r
 141                                 + Muscle.getStatFile();\r
 142                 return WSUtil.pullFile(file, position);\r
 143         }\r
 144 \r
 145         @Override\r
 146         public boolean cancelJob(String jobId) {\r
 147                 WSUtil.validateJobId(jobId);\r
 148                 return WSUtil.cancelJob(jobId);\r
 149         }\r
 150 \r
 151         @Override\r
 152         public JobStatus getJobStatus(String jobId) {\r
 153                 WSUtil.validateJobId(jobId);\r
 154                 return WSUtil.getJobStatus(jobId);\r
 155         }\r
 156 \r
 157         @Override\r
 158         public PresetManager<Muscle> getPresets() {\r
 159                 return musclePresets;\r
 160         }\r
 161 \r
 162         @Override\r
 163         public RunnerConfig<Muscle> getRunnerOptions() {\r
 164                 return muscleOptions;\r
 165         }\r
 166 \r
 167 }\r