src/jalview/ws/jws2/JabawsMsaInterfaceAlignCalcWorker.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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 java.util.Iterator;
  24 import java.util.List;
  25
  26 import compbio.data.msa.MsaWS;
  27 import compbio.data.msa.SequenceAnnotation;
  28 import compbio.data.sequence.Alignment;
  29 import compbio.data.sequence.Score;
  30 import compbio.data.sequence.ScoreManager;
  31 import compbio.metadata.Argument;
  32 import compbio.metadata.ChunkHolder;
  33 import compbio.metadata.JobStatus;
  34 import compbio.metadata.JobSubmissionException;
  35 import compbio.metadata.ResultNotAvailableException;
  36 import compbio.metadata.WrongParameterException;
  37 import jalview.api.AlignViewportI;
  38 import jalview.api.AlignmentViewPanel;
  39 import jalview.datamodel.AlignmentAnnotation;
  40 import jalview.datamodel.Annotation;
  41 import jalview.datamodel.SequenceI;
  42 import jalview.gui.AlignFrame;
  43 import jalview.workers.AlignCalcWorker;
  44 import jalview.ws.jws2.jabaws2.Jws2Instance;
  45 import jalview.ws.params.WsParamSetI;
  46
  47 public abstract class JabawsMsaInterfaceAlignCalcWorker 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, AlignFrame alignFrame,
  62           WsParamSetI preset, List<Argument> paramset)
  63   {
  64     this(alignFrame.getCurrentView(), alignFrame.alignPanel);
  65     this.guiProgress = alignFrame;
  66     this.preset = preset;
  67     this.arguments = paramset;
  68     this.service = service;
  69     msaservice = (MsaWS) service.service;
  70
  71   }
  72
  73   @Override
  74   ChunkHolder pullExecStatistics(String rslt, long rpos)
  75   {
  76     return msaservice.pullExecStatistics(rslt, rpos);
  77   }
  78
  79   @Override
  80   boolean collectAnnotationResultsFor(String rslt)
  81           throws ResultNotAvailableException
  82   {
  83     msascoreset = msaservice.getResult(rslt);
  84     if (msascoreset != null)
  85     {
  86       return true;
  87     }
  88     return false;
  89   }
  90
  91   @Override
  92   boolean cancelJob(String rslt) throws Exception
  93   {
  94     return msaservice.cancelJob(rslt);
  95   }
  96
  97   @Override
  98   protected JobStatus getJobStatus(String rslt) throws Exception
  99   {
 100     return msaservice.getJobStatus(rslt);
 101   }
 102
 103   @Override
 104   boolean hasService()
 105   {
 106     return msaservice != null;
 107   }
 108
 109   @Override
 110   protected boolean isInteractiveUpdate()
 111   {
 112     return false; // this instanceof AAConClient;
 113   }
 114
 115   @Override
 116   protected String submitToService(
 117           List<compbio.data.sequence.FastaSequence> seqs)
 118           throws JobSubmissionException
 119   {
 120     String rslt;
 121     if (preset == null && arguments == null)
 122     {
 123       rslt = msaservice.align(seqs);
 124     }
 125     else
 126     {
 127       try
 128       {
 129         rslt = msaservice.customAlign(seqs, getJabaArguments());
 130       } catch (WrongParameterException x)
 131       {
 132         throw new JobSubmissionException(
 133                 "Invalid parameter set. Check Jalview implementation.", x);
 134
 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     System.out.println("Creating annotation on dseq:" + dseq.getStart()
 160             + " base is " + base + " and length=" + dseq.getLength()
 161             + " == " + 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 }