src/jalview/ws/jws2/JabawsMsaInterfaceAlignCalcWorker.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws.jws2;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.api.AlignmentViewPanel;
  25 import jalview.datamodel.AlignmentAnnotation;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.gui.AlignFrame;
  29 import jalview.util.MessageManager;
  30 import jalview.ws.jws2.jabaws2.Jws2Instance;
  31 import jalview.ws.params.WsParamSetI;
  32
  33 import java.util.Iterator;
  34 import java.util.List;
  35
  36 import compbio.data.msa.MsaWS;
  37 import compbio.data.sequence.Alignment;
  38 import compbio.data.sequence.Score;
  39 import compbio.metadata.Argument;
  40 import compbio.metadata.ChunkHolder;
  41 import compbio.metadata.JobStatus;
  42 import compbio.metadata.JobSubmissionException;
  43 import compbio.metadata.ResultNotAvailableException;
  44 import compbio.metadata.WrongParameterException;
  45
  46 public abstract class JabawsMsaInterfaceAlignCalcWorker
  47         extends AbstractJabaCalcWorker
  48 {
  49
  50   @SuppressWarnings("unchecked")
  51   protected MsaWS msaservice;
  52
  53   protected Alignment msascoreset;
  54
  55   public JabawsMsaInterfaceAlignCalcWorker(AlignViewportI alignViewport,
  56           AlignmentViewPanel alignPanel)
  57   {
  58     super(alignViewport, alignPanel);
  59   }
  60
  61   public JabawsMsaInterfaceAlignCalcWorker(Jws2Instance service,
  62           AlignFrame alignFrame, WsParamSetI preset,
  63           List<Argument> paramset)
  64   {
  65     this(alignFrame.getCurrentView(), alignFrame.alignPanel);
  66     this.guiProgress = alignFrame;
  67     this.preset = preset;
  68     this.arguments = paramset;
  69     this.service = service;
  70     msaservice = (MsaWS) service.service;
  71
  72   }
  73
  74   @Override
  75   ChunkHolder pullExecStatistics(String rslt, long rpos)
  76   {
  77     return msaservice.pullExecStatistics(rslt, rpos);
  78   }
  79
  80   @Override
  81   boolean collectAnnotationResultsFor(String rslt)
  82           throws ResultNotAvailableException
  83   {
  84     msascoreset = msaservice.getResult(rslt);
  85     if (msascoreset != null)
  86     {
  87       return true;
  88     }
  89     return false;
  90   }
  91
  92   @Override
  93   boolean cancelJob(String rslt) throws Exception
  94   {
  95     return msaservice.cancelJob(rslt);
  96   }
  97
  98   @Override
  99   protected JobStatus getJobStatus(String rslt) throws Exception
 100   {
 101     return msaservice.getJobStatus(rslt);
 102   }
 103
 104   @Override
 105   boolean hasService()
 106   {
 107     return msaservice != null;
 108   }
 109
 110   @Override
 111   protected boolean isInteractiveUpdate()
 112   {
 113     return false; // this instanceof AAConClient;
 114   }
 115
 116   @Override
 117   protected String submitToService(
 118           List<compbio.data.sequence.FastaSequence> seqs)
 119           throws JobSubmissionException
 120   {
 121     String rslt;
 122     if (preset == null && arguments == null)
 123     {
 124       rslt = msaservice.align(seqs);
 125     }
 126     else
 127     {
 128       try
 129       {
 130         rslt = msaservice.customAlign(seqs, getJabaArguments());
 131       } catch (WrongParameterException x)
 132       {
 133         throw new JobSubmissionException(MessageManager.getString(
 134                 "exception.jobsubmission_invalid_params_set"), x);
 135       }
 136     }
 137     return rslt;
 138   }
 139
 140   protected void createAnnotationRowsForScores(
 141           List<AlignmentAnnotation> ourAnnot, String calcId, int alWidth,
 142           Score scr)
 143   {
 144     // simple annotation row
 145     AlignmentAnnotation annotation = alignViewport.getAlignment()
 146             .findOrCreateAnnotation(scr.getMethod(), calcId, true, null,
 147                     null);
 148     if (alWidth == gapMap.length) // scr.getScores().size())
 149     {
 150       constructAnnotationFromScore(annotation, 0, alWidth, scr);
 151       ourAnnot.add(annotation);
 152     }
 153   }
 154
 155   protected AlignmentAnnotation createAnnotationRowsForScores(
 156           List<AlignmentAnnotation> ourAnnot, String typeName,
 157           String calcId, SequenceI dseq, int base, Score scr)
 158   {
 159     jalview.bin.Console.outPrintln("Creating annotation on dseq:"
 160             + dseq.getStart() + " base is " + base + " and length="
 161             + dseq.getLength() + " == " + scr.getScores().size());
 162     // AlignmentAnnotation annotation = new AlignmentAnnotation(
 163     // scr.getMethod(), typeName, new Annotation[]
 164     // {}, 0, -1, AlignmentAnnotation.LINE_GRAPH);
 165     // annotation.setCalcId(calcId);
 166     AlignmentAnnotation annotation = alignViewport.getAlignment()
 167             .findOrCreateAnnotation(typeName, calcId, false, dseq, null);
 168     constructAnnotationFromScore(annotation, 0, dseq.getLength(), scr);
 169     annotation.createSequenceMapping(dseq, base, false);
 170     annotation.adjustForAlignment();
 171     dseq.addAlignmentAnnotation(annotation);
 172     ourAnnot.add(annotation);
 173     return annotation;
 174   }
 175
 176   private void constructAnnotationFromScore(AlignmentAnnotation annotation,
 177           int base, int alWidth, Score scr)
 178   {
 179     Annotation[] elm = new Annotation[alWidth];
 180     Iterator<Float> vals = scr.getScores().iterator();
 181     float m = 0f, x = 0f;
 182     for (int i = 0; vals.hasNext(); i++)
 183     {
 184       float val = vals.next().floatValue();
 185       if (i == 0)
 186       {
 187         m = val;
 188         x = val;
 189       }
 190       else
 191       {
 192         if (m > val)
 193         {
 194           m = val;
 195         }
 196         ;
 197         if (x < val)
 198         {
 199           x = val;
 200         }
 201       }
 202       // if we're at a gapped column then skip to next ungapped position
 203       if (gapMap != null && gapMap.length > 0)
 204       {
 205         while (!gapMap[i])
 206         {
 207           elm[i++] = new Annotation("", "", ' ', Float.NaN);
 208         }
 209       }
 210       elm[i] = new Annotation("", "" + val, ' ', val);
 211     }
 212
 213     annotation.annotations = elm;
 214     annotation.belowAlignment = true;
 215     if (x < 0)
 216     {
 217       x = 0;
 218     }
 219     x += (x - m) * 0.1;
 220     annotation.graphMax = x;
 221     annotation.graphMin = m;
 222     annotation.validateRangeAndDisplay();
 223   }
 224
 225 }