webservices/compbio/ws/server/AAConWS.java

   1 package compbio.ws.server;\r
   2 \r
   3 import java.io.File;\r
   4 import java.util.Arrays;\r
   5 import java.util.HashMap;\r
   6 import java.util.HashSet;\r
   7 import java.util.List;\r
   8 \r
   9 import javax.annotation.Resource;\r
  10 import javax.jws.WebService;\r
  11 import javax.xml.ws.WebServiceContext;\r
  12 \r
  13 import org.apache.log4j.Logger;\r
  14 \r
  15 import compbio.data.msa.SequenceAnnotation;\r
  16 import compbio.data.sequence.FastaSequence;\r
  17 import compbio.data.sequence.Score;\r
  18 import compbio.engine.AsyncExecutor;\r
  19 import compbio.engine.Configurator;\r
  20 import compbio.engine.client.ConfiguredExecutable;\r
  21 import compbio.metadata.ChunkHolder;\r
  22 import compbio.metadata.JobStatus;\r
  23 import compbio.metadata.JobSubmissionException;\r
  24 import compbio.metadata.Limit;\r
  25 import compbio.metadata.LimitExceededException;\r
  26 import compbio.metadata.LimitsManager;\r
  27 import compbio.metadata.Option;\r
  28 import compbio.metadata.Preset;\r
  29 import compbio.metadata.PresetManager;\r
  30 import compbio.metadata.ResultNotAvailableException;\r
  31 import compbio.metadata.RunnerConfig;\r
  32 import compbio.metadata.UnsupportedRuntimeException;\r
  33 import compbio.metadata.WrongParameterException;\r
  34 import compbio.runner.Util;\r
  35 import compbio.runner.conservation.AACon;\r
  36 \r
  37 @WebService(endpointInterface = "compbio.data.msa.SequenceAnnotation", targetNamespace = "http://msa.data.compbio/01/12/2010/", serviceName = "AAConWS")\r
  38 public class AAConWS implements SequenceAnnotation<AACon> {\r
  39 \r
  40         // Ask for resource injection\r
  41         @Resource\r
  42         WebServiceContext wsContext;\r
  43 \r
  44         private static Logger statLog = Logger.getLogger("AAConWS-stats");\r
  45 \r
  46         private static Logger log = Logger.getLogger(AAConWS.class);\r
  47 \r
  48         private static final RunnerConfig<AACon> aaconOptions = Util\r
  49                         .getSupportedOptions(AACon.class);\r
  50 \r
  51         private static final PresetManager<AACon> aaconPresets = Util\r
  52                         .getPresets(AACon.class);\r
  53 \r
  54         ConfiguredExecutable<AACon> init(List<FastaSequence> sequences)\r
  55                         throws JobSubmissionException {\r
  56                 AACon aacon = new AACon();\r
  57                 aacon.setInput("fasta.in").setOutput("aacon.out");\r
  58                 return Configurator.configureExecutable(aacon, sequences);\r
  59         }\r
  60 \r
  61         @Override\r
  62         public HashMap<String, HashSet<Score>> getAnnotation(String jobId)\r
  63                         throws ResultNotAvailableException {\r
  64                 WSUtil.validateJobId(jobId);\r
  65                 AsyncExecutor asyncEngine = Configurator.getAsyncEngine(jobId);\r
  66                 ConfiguredExecutable<AACon> aacon = (ConfiguredExecutable<AACon>) asyncEngine\r
  67                                 .getResults(jobId);\r
  68                 HashSet<Score> mas = aacon.getResults();\r
  69                 HashMap<String, HashSet<Score>> result = new HashMap<String, HashSet<Score>>();\r
  70                 result.put("Alignment", mas);\r
  71                 log.trace(jobId + " getConservation : " + mas);\r
  72                 return result;\r
  73         }\r
  74         /*\r
  75          * @SuppressWarnings("unchecked") public JalviewAnnotation\r
  76          * getJalviewAnnotation(String jobId) throws ResultNotAvailableException {\r
  77          * MultiAnnotatedSequence<Method> result = getResult(jobId); // TODO //\r
  78          * log(jobId, "getResults"); return result.toJalviewAnnotation(); }\r
  79          */\r
  80 \r
  81         @Override\r
  82         public Limit<AACon> getLimit(String presetName) {\r
  83                 return new AACon().getLimit(presetName);\r
  84         }\r
  85 \r
  86         @Override\r
  87         public LimitsManager<AACon> getLimits() {\r
  88                 return new AACon().getLimits();\r
  89         }\r
  90 \r
  91         @Override\r
  92         public ChunkHolder pullExecStatistics(String jobId, long position) {\r
  93                 WSUtil.validateJobId(jobId);\r
  94                 String file = Configurator.getWorkDirectory(jobId) + File.separator\r
  95                                 + AACon.getStatFile();\r
  96                 return WSUtil.pullFile(file, position);\r
  97         }\r
  98 \r
  99         @Override\r
 100         public boolean cancelJob(String jobId) {\r
 101                 WSUtil.validateJobId(jobId);\r
 102                 return WSUtil.cancelJob(jobId);\r
 103         }\r
 104 \r
 105         @Override\r
 106         public JobStatus getJobStatus(String jobId) {\r
 107                 WSUtil.validateJobId(jobId);\r
 108                 return WSUtil.getJobStatus(jobId);\r
 109         }\r
 110 \r
 111         @Override\r
 112         public PresetManager<AACon> getPresets() {\r
 113                 return aaconPresets;\r
 114         }\r
 115 \r
 116         @Override\r
 117         public RunnerConfig<AACon> getRunnerOptions() {\r
 118                 return aaconOptions;\r
 119         }\r
 120 \r
 121         String analize(List<FastaSequence> sequences,\r
 122                         ConfiguredExecutable<AACon> confExec, Logger log, String method,\r
 123                         Limit<AACon> limit) throws JobSubmissionException {\r
 124                 if (limit != null && limit.isExceeded(sequences)) {\r
 125                         throw LimitExceededException.newLimitExceeded(limit, sequences);\r
 126                 }\r
 127 \r
 128                 compbio.runner.Util.writeInput(sequences, confExec);\r
 129                 AsyncExecutor engine = Configurator.getAsyncEngine(confExec);\r
 130                 String jobId = engine.submitJob(confExec);\r
 131                 return jobId;\r
 132         }\r
 133 \r
 134         @Override\r
 135         public String analize(List<FastaSequence> sequences)\r
 136                         throws UnsupportedRuntimeException, LimitExceededException,\r
 137                         JobSubmissionException {\r
 138                 WSUtil.validateFastaInput(sequences);\r
 139                 ConfiguredExecutable<AACon> confAAcon = init(sequences);\r
 140 \r
 141                 // set default conservation method to fastest - SHENKIN\r
 142                 // TODO: This violates encapsulation, should be moved to the runners\r
 143                 // level.\r
 144                 confAAcon.addParameters(Arrays.asList("-m=SHENKIN"));\r
 145                 return analize(sequences, confAAcon, null, "analize", getLimit(""));\r
 146         }\r
 147 \r
 148         @Override\r
 149         public String customAnalize(List<FastaSequence> sequences,\r
 150                         List<Option<AACon>> options) throws UnsupportedRuntimeException,\r
 151                         LimitExceededException, JobSubmissionException,\r
 152                         WrongParameterException {\r
 153                 WSUtil.validateFastaInput(sequences);\r
 154                 ConfiguredExecutable<AACon> confAACon = init(sequences);\r
 155                 // Could not do that! Space separated values\r
 156                 // will all be treated as keys! thus duplicates removed\r
 157                 // String params = cbuilder.getCommand();\r
 158                 List<String> params = WSUtil.getCommands(options,\r
 159                                 AACon.KEY_VALUE_SEPARATOR);\r
 160                 confAACon.addParameters(params);\r
 161                 return analize(sequences, confAACon, null, "customAnalize",\r
 162                                 getLimit(""));\r
 163         }\r
 164 \r
 165         @Override\r
 166         public String presetAnalize(List<FastaSequence> sequences,\r
 167                         Preset<AACon> preset) throws UnsupportedRuntimeException,\r
 168                         LimitExceededException, JobSubmissionException,\r
 169                         WrongParameterException {\r
 170                 WSUtil.validateFastaInput(sequences);\r
 171                 if (preset == null) {\r
 172                         throw new WrongParameterException("Preset must be provided!");\r
 173                 }\r
 174                 ConfiguredExecutable<AACon> confAAcon = init(sequences);\r
 175                 confAAcon.addParameters(preset.getOptions());\r
 176                 Limit<AACon> limit = getLimit(preset.getName());\r
 177                 return WSUtil.align(sequences, confAAcon, null, "presetAnalize", limit);\r
 178         }\r
 179 \r
 180 }\r