2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3 * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
18 package jalview.ws.jws1;
22 import jalview.analysis.*;
24 import jalview.datamodel.*;
27 import jalview.util.*;
28 import jalview.ws.AWsJob;
29 import jalview.ws.JobStateSummary;
30 import jalview.ws.WSClientI;
31 import vamsas.objects.simple.JpredResult;
33 class JPredThread extends JWS1Thread implements WSClientI
35 // TODO: put mapping between JPredJob input and input data here -
36 // JNetAnnotation adding is done after result parsing.
37 class JPredJob extends WSJob
39 // TODO: make JPredJob deal only with what was sent to and received from a
41 int[] predMap = null; // mapping from sequence(i) to the original
43 // sequence(predMap[i]) being predicted on
45 vamsas.objects.simple.Sequence sequence;
47 vamsas.objects.simple.Msfalignment msa;
49 java.util.Hashtable SequenceInfo = null;
51 int msaIndex = 0; // the position of the original sequence in the array of
53 // Sequences in the input object that this job holds a
58 * @return true if getResultSet will return a valid alignment and prediction
61 public boolean hasResults()
63 if (subjobComplete && result != null && result.isFinished()
64 && ((JpredResult) result).getPredfile() != null
65 && ((JpredResult) result).getAligfile() != null)
72 public boolean hasValidInput()
83 * @return null or Object[] { annotated alignment for this prediction,
84 * ColumnSelection for this prediction} or null if no results
88 public Object[] getResultSet() throws Exception
90 if (result == null || !result.isFinished())
95 ColumnSelection alcsel = null;
96 int FirstSeq = -1; // the position of the query sequence in Alignment al
98 JpredResult result = (JpredResult) this.result;
100 jalview.bin.Cache.log.debug("Parsing output from JNet job.");
101 // JPredFile prediction = new JPredFile("C:/JalviewX/files/jpred.txt",
103 jalview.io.JPredFile prediction = new jalview.io.JPredFile(
104 result.getPredfile(), "Paste");
105 SequenceI[] preds = prediction.getSeqsAsArray();
106 jalview.bin.Cache.log.debug("Got prediction profile.");
108 if ((this.msa != null) && (result.getAligfile() != null))
110 jalview.bin.Cache.log.debug("Getting associated alignment.");
111 // we ignore the returned alignment if we only predicted on a single
113 String format = new jalview.io.IdentifyFile().Identify(
114 result.getAligfile(), "Paste");
116 if (jalview.io.FormatAdapter.isValidFormat(format))
121 Object[] alandcolsel = input
122 .getAlignmentAndColumnSelection(getGapChar());
123 sqs = (SequenceI[]) alandcolsel[0];
124 al = new Alignment(sqs);
125 alcsel = (ColumnSelection) alandcolsel[1];
129 al = new FormatAdapter().readFile(result.getAligfile(),
131 sqs = new SequenceI[al.getHeight()];
133 for (int i = 0, j = al.getHeight(); i < j; i++)
135 sqs[i] = al.getSequenceAt(i);
137 if (!jalview.analysis.SeqsetUtils.deuniquify(
138 (Hashtable) SequenceInfo, sqs))
140 throw (new Exception(
141 "Couldn't recover sequence properties for alignment."));
147 jalview.io.JnetAnnotationMaker.add_annotation(prediction, al,
148 FirstSeq, false, predMap);
153 throw (new Exception("Unknown format " + format
154 + " for file : \n" + result.getAligfile()));
159 al = new Alignment(preds);
160 FirstSeq = prediction.getQuerySeqPosition();
163 char gc = getGapChar();
164 SequenceI[] sqs = (SequenceI[]) ((java.lang.Object[]) input
165 .getAlignmentAndColumnSelection(gc))[0];
166 if (this.msaIndex >= sqs.length)
169 "Implementation Error! Invalid msaIndex for JPredJob on parent MSA input object!");
173 // Uses RemoveGapsCommand
175 new jalview.commands.RemoveGapsCommand("Remove Gaps",
177 { sqs[msaIndex] }, currentView);
179 SequenceI profileseq = al.getSequenceAt(FirstSeq);
180 profileseq.setSequence(sqs[msaIndex].getSequenceAsString());
183 if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(
184 al.getSequenceAt(FirstSeq), SequenceInfo))
186 throw (new Exception(
187 "Couldn't recover sequence properties for JNet Query sequence!"));
192 jalview.io.JnetAnnotationMaker.add_annotation(prediction, al,
193 FirstSeq, true, predMap);
194 SequenceI profileseq = al.getSequenceAt(0); // this includes any gaps.
195 alignToProfileSeq(al, profileseq);
198 // Adjust input view for gaps
199 // propagate insertions into profile
200 alcsel = ColumnSelection.propagateInsertions(profileseq, al,
206 { al, alcsel }; // , FirstSeq, noMsa};
210 * Given an alignment where all other sequences except profileseq are
211 * aligned to the ungapped profileseq, insert gaps in the other sequences to
212 * realign them with the residues in profileseq
217 private void alignToProfileSeq(Alignment al, SequenceI profileseq)
219 char gc = al.getGapCharacter();
220 int[] gapMap = profileseq.gapMap();
221 // insert gaps into profile
222 for (int lp = 0, r = 0; r < gapMap.length; r++)
224 if (gapMap[r] - lp > 1)
226 StringBuffer sb = new StringBuffer();
227 for (int s = 0, ns = gapMap[r] - lp; s < ns; s++)
231 for (int s = 1, ns = al.getHeight(); s < ns; s++)
233 String sq = al.getSequenceAt(s).getSequenceAsString();
234 int diff = gapMap[r] - sq.length();
239 while ((diff = gapMap[r] - sq.length()) > 0)
242 + ((diff >= sb.length()) ? sb.toString() : sb
243 .substring(0, diff));
245 al.getSequenceAt(s).setSequence(sq);
249 al.getSequenceAt(s).setSequence(
250 sq.substring(0, gapMap[r]) + sb.toString()
251 + sq.substring(gapMap[r]));
259 public JPredJob(Hashtable SequenceInfo, SequenceI seq, int[] delMap)
262 this.predMap = delMap;
263 String sq = AlignSeq.extractGaps(Comparison.GapChars,
264 seq.getSequenceAsString());
265 if (sq.length() >= 20)
267 this.SequenceInfo = SequenceInfo;
268 sequence = new vamsas.objects.simple.Sequence();
269 sequence.setId(seq.getName());
274 errorMessage = "Sequence is too short to predict with JPred - need at least 20 amino acids.";
278 public JPredJob(Hashtable SequenceInfo, SequenceI[] msf, int[] delMap)
280 this(SequenceInfo, msf[0], delMap);
281 if (sequence != null)
285 msa = new vamsas.objects.simple.Msfalignment();
286 jalview.io.PileUpfile pileup = new jalview.io.PileUpfile();
287 msa.setMsf(pileup.print(msf));
292 String errorMessage = "";
294 public String getValidationMessages()
296 return errorMessage + "\n";
300 ext.vamsas.Jpred server;
304 JPredThread(WebserviceInfo wsinfo, String altitle,
305 ext.vamsas.Jpred server, String wsurl, AlignmentView alview,
308 super(alframe, wsinfo, alview, wsurl);
309 this.altitle = altitle;
310 this.server = server;
313 JPredThread(WebserviceInfo wsinfo, String altitle,
314 ext.vamsas.Jpred server, String wsurl, Hashtable SequenceInfo,
315 SequenceI seq, int[] delMap, AlignmentView alview,
318 this(wsinfo, altitle, server, wsurl, alview, alframe);
319 JPredJob job = new JPredJob(SequenceInfo, seq, delMap);
320 if (job.hasValidInput())
322 OutputHeader = wsInfo.getProgressText();
329 wsInfo.appendProgressText(job.getValidationMessages());
333 JPredThread(WebserviceInfo wsinfo, String altitle,
334 ext.vamsas.Jpred server, Hashtable SequenceInfo, SequenceI[] msf,
335 int[] delMap, AlignmentView alview, AlignFrame alframe,
338 this(wsinfo, altitle, server, wsurl, alview, alframe);
339 JPredJob job = new JPredJob(SequenceInfo, msf, delMap);
340 if (job.hasValidInput())
344 OutputHeader = wsInfo.getProgressText();
349 wsInfo.appendProgressText(job.getValidationMessages());
353 public void StartJob(AWsJob j)
355 if (!(j instanceof JPredJob))
358 "Implementation error - StartJob(JpredJob) called on "
363 JPredJob job = (JPredJob) j;
366 job.setJobId(server.predictOnMsa(job.msa));
368 else if (job.sequence != null)
370 job.setJobId(server.predict(job.sequence)); // debug like : job.jobId =
371 // "/jobs/www-jpred/jp_Yatat29";//
374 if (job.getJobId() != null)
376 if (job.getJobId().startsWith("Broken"))
378 job.result = (vamsas.objects.simple.Result) new JpredResult();
379 job.result.setInvalid(true);
380 job.result.setStatus("Submission " + job.getJobId());
381 throw new Exception(job.getJobId());
385 job.setSubmitted(true);
386 job.setSubjobComplete(false);
387 Cache.log.info(WsUrl + " Job Id '" + job.getJobId() + "'");
392 throw new Exception("Server timed out - try again later\n");
394 } catch (Exception e)
396 // kill the whole job.
397 wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
398 if (e.getMessage().indexOf("Exception") > -1)
400 wsInfo.setStatus(j.getJobnum(),
401 WebserviceInfo.STATE_STOPPED_SERVERERROR);
402 wsInfo.setProgressText(
404 "Failed to submit the prediction. (Just close the window)\n"
405 + "It is most likely that there is a problem with the server.\n");
407 .println("JPredWS Client: Failed to submit the prediction. Quite possibly because of a server error - see below)\n"
408 + e.getMessage() + "\n");
410 jalview.bin.Cache.log.warn("Server Exception", e);
414 wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
415 // JBPNote - this could be a popup informing the user of the problem.
416 wsInfo.appendProgressText(j.getJobnum(),
417 "Failed to submit the prediction:\n" + e.getMessage()
418 + wsInfo.getProgressText());
420 jalview.bin.Cache.log.debug(
421 "Failed Submission of job " + j.getJobnum(), e);
424 j.setAllowedServerExceptions(-1);
425 j.setSubjobComplete(true);
429 public void parseResult()
431 int results = 0; // number of result sets received
432 JobStateSummary finalState = new JobStateSummary();
435 for (int j = 0; j < jobs.length; j++)
437 finalState.updateJobPanelState(wsInfo, OutputHeader, jobs[j]);
438 if (jobs[j].isSubmitted() && jobs[j].isSubjobComplete()
439 && jobs[j].hasResults())
444 } catch (Exception ex)
447 Cache.log.error("Unexpected exception when processing results for "
449 wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
453 wsInfo.showResultsNewFrame
454 .addActionListener(new java.awt.event.ActionListener()
456 public void actionPerformed(java.awt.event.ActionEvent evt)
458 displayResults(true);
462 .addActionListener(new java.awt.event.ActionListener()
464 public void actionPerformed(java.awt.event.ActionEvent evt)
466 displayResults(false);
469 wsInfo.setResultsReady();
473 wsInfo.setStatus(wsInfo.STATE_STOPPED_ERROR);
474 wsInfo.appendInfoText("No jobs ran.");
475 wsInfo.setFinishedNoResults();
479 void displayResults(boolean newWindow)
481 // TODO: cope with multiple subjobs.
486 for (int jn = 0; jn < jobs.length; jn++)
488 Object[] jobres = null;
489 JPredJob j = (JPredJob) jobs[jn];
493 // hack - we only deal with all single seuqence predictions or all
494 // profile predictions
495 msa = (j.msa != null) ? true : msa;
498 jalview.bin.Cache.log.debug("Parsing output of job " + jn);
499 jobres = j.getResultSet();
500 jalview.bin.Cache.log.debug("Finished parsing output.");
501 if (jobs.length == 1)
507 // do merge with other job results
509 "Multiple JNet subjob merging not yet implemented.");
511 } catch (Exception e)
513 jalview.bin.Cache.log.error(
514 "JNet Client: JPred Annotation Parse Error", e);
515 wsInfo.setStatus(j.getJobnum(),
516 WebserviceInfo.STATE_STOPPED_ERROR);
517 wsInfo.appendProgressText(j.getJobnum(), OutputHeader + "\n"
518 + j.result.getStatus()
519 + "\nInvalid JNet job result data!\n" + e.getMessage());
520 j.result.setBroken(true);
534 af = new AlignFrame((Alignment) res[0],
535 (ColumnSelection) res[1], AlignFrame.DEFAULT_WIDTH,
536 AlignFrame.DEFAULT_HEIGHT);
540 af = new AlignFrame((Alignment) res[0],
541 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
547 * java.lang.Object[] alandcolsel =
548 * input.getAlignmentAndColumnSelection
549 * (alignFrame.getViewport().getGapCharacter()); if
550 * (((SequenceI[])alandcolsel[0])[0].getLength()!=res.getWidth()) {
551 * if (msa) { throw new Error("Implementation Error! ColumnSelection
552 * from input alignment will not map to result alignment!"); } } if
553 * (!msa) { // update hidden regions to account for loss of gaps in
554 * profile. - if any // gapMap returns insert list, interpreted as
555 * delete list by pruneDeletions //((ColumnSelection)
556 * alandcolsel[1]).pruneDeletions(ShiftList.parseMap(((SequenceI[])
557 * alandcolsel[0])[0].gapMap())); }
560 af = new AlignFrame((Alignment) res[0],
561 (ColumnSelection) res[1], AlignFrame.DEFAULT_WIDTH,
562 AlignFrame.DEFAULT_HEIGHT);
564 Desktop.addInternalFrame(af, altitle, AlignFrame.DEFAULT_WIDTH,
565 AlignFrame.DEFAULT_HEIGHT);
569 Cache.log.info("Append results onto existing alignment.");
575 public void pollJob(AWsJob job) throws Exception
577 ((JPredJob) job).result = server.getresult(job.getJobId());
580 public boolean isCancellable()
585 public void cancelJob()
587 throw new Error("Implementation error!");
590 public boolean canMergeResults()