src/jalview/ws/jws2/JabawsCalcWorker.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 jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.Annotation;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.gui.AlignFrame;
  27 import jalview.util.MessageManager;
  28 import jalview.ws.jws2.jabaws2.Jws2Instance;
  29 import jalview.ws.params.WsParamSetI;
  30
  31 import java.util.Iterator;
  32 import java.util.List;
  33
  34 import compbio.data.msa.SequenceAnnotation;
  35 import compbio.data.sequence.Score;
  36 import compbio.data.sequence.ScoreManager;
  37 import compbio.metadata.Argument;
  38 import compbio.metadata.ChunkHolder;
  39 import compbio.metadata.JobStatus;
  40 import compbio.metadata.JobSubmissionException;
  41 import compbio.metadata.ResultNotAvailableException;
  42 import compbio.metadata.WrongParameterException;
  43
  44 public abstract class JabawsCalcWorker extends AbstractJabaCalcWorker
  45 {
  46
  47   @SuppressWarnings("unchecked")
  48   protected SequenceAnnotation aaservice;
  49
  50   protected ScoreManager scoremanager;
  51
  52   public JabawsCalcWorker(Jws2Instance service, AlignFrame alignFrame,
  53           WsParamSetI preset, List<Argument> paramset)
  54   {
  55     super(service, alignFrame, preset, paramset);
  56     aaservice = (SequenceAnnotation) service.service;
  57   }
  58
  59   @Override
  60   ChunkHolder pullExecStatistics(String rslt, long rpos)
  61   {
  62     return aaservice.pullExecStatistics(rslt, rpos);
  63   }
  64
  65   @Override
  66   boolean collectAnnotationResultsFor(String rslt)
  67           throws ResultNotAvailableException
  68   {
  69     scoremanager = aaservice.getAnnotation(rslt);
  70     if (scoremanager != null)
  71     {
  72       return true;
  73     }
  74     return false;
  75   }
  76
  77   @Override
  78   boolean cancelJob(String rslt) throws Exception
  79   {
  80     return aaservice.cancelJob(rslt);
  81   }
  82
  83   @Override
  84   protected JobStatus getJobStatus(String rslt) throws Exception
  85   {
  86     return aaservice.getJobStatus(rslt);
  87   }
  88
  89   @Override
  90   boolean hasService()
  91   {
  92     return aaservice != null;
  93   }
  94
  95   @Override
  96   protected boolean isInteractiveUpdate()
  97   {
  98     return this instanceof AAConClient;
  99   }
 100
 101   @Override
 102   protected String submitToService(
 103           List<compbio.data.sequence.FastaSequence> seqs)
 104           throws JobSubmissionException
 105   {
 106     String rslt;
 107     if (preset == null && arguments == null)
 108     {
 109       rslt = aaservice.analize(seqs);
 110     }
 111     else
 112     {
 113       try
 114       {
 115         rslt = aaservice.customAnalize(seqs, getJabaArguments());
 116       } catch (WrongParameterException x)
 117       {
 118         throw new JobSubmissionException(MessageManager.getString("exception.jobsubmission_invalid_params_set"), x);
 119
 120       }
 121     }
 122     return rslt;
 123   }
 124
 125   protected void createAnnotationRowsForScores(
 126           List<AlignmentAnnotation> ourAnnot, String calcId, int alWidth,
 127           Score scr)
 128   {
 129     // simple annotation row
 130     AlignmentAnnotation annotation = alignViewport.getAlignment()
 131             .findOrCreateAnnotation(scr.getMethod(), calcId, true, null,
 132                     null);
 133     if (alWidth == gapMap.length) // scr.getScores().size())
 134     {
 135       constructAnnotationFromScore(annotation, 0, alWidth, scr);
 136       ourAnnot.add(annotation);
 137     }
 138   }
 139
 140   protected AlignmentAnnotation createAnnotationRowsForScores(
 141           List<AlignmentAnnotation> ourAnnot, String typeName,
 142           String calcId, SequenceI dseq, int base, Score scr)
 143   {
 144     System.out.println("Creating annotation on dseq:" + dseq.getStart()
 145             + " base is " + base + " and length=" + dseq.getLength()
 146             + " == " + scr.getScores().size());
 147     // AlignmentAnnotation annotation = new AlignmentAnnotation(
 148     // scr.getMethod(), typeName, new Annotation[]
 149     // {}, 0, -1, AlignmentAnnotation.LINE_GRAPH);
 150     // annotation.setCalcId(calcId);
 151     AlignmentAnnotation annotation = alignViewport.getAlignment()
 152             .findOrCreateAnnotation(typeName, calcId, false, dseq, null);
 153     constructAnnotationFromScore(annotation, 0, dseq.getLength(), scr);
 154     annotation.createSequenceMapping(dseq, base, false);
 155     annotation.adjustForAlignment();
 156     dseq.addAlignmentAnnotation(annotation);
 157     ourAnnot.add(annotation);
 158     return annotation;
 159   }
 160
 161   protected void replaceAnnotationOnAlignmentWith(
 162           AlignmentAnnotation newAnnot, String typeName, String calcId,
 163           SequenceI aSeq)
 164   {
 165     SequenceI dsseq = aSeq.getDatasetSequence();
 166     while (dsseq.getDatasetSequence() != null)
 167     {
 168       dsseq = dsseq.getDatasetSequence();
 169     }
 170     // look for same annotation on dataset and lift this one over
 171     List<AlignmentAnnotation> dsan = dsseq.getAlignmentAnnotations(calcId,
 172             typeName);
 173     if (dsan != null && dsan.size() > 0)
 174     {
 175       for (AlignmentAnnotation dssan : dsan)
 176       {
 177         dsseq.removeAlignmentAnnotation(dssan);
 178       }
 179     }
 180     AlignmentAnnotation dssan = new AlignmentAnnotation(newAnnot);
 181     dsseq.addAlignmentAnnotation(dssan);
 182     dssan.adjustForAlignment();
 183   }
 184
 185   private void constructAnnotationFromScore(AlignmentAnnotation annotation,
 186           int base, int alWidth, Score scr)
 187   {
 188     Annotation[] elm = new Annotation[alWidth];
 189     Iterator<Float> vals = scr.getScores().iterator();
 190     float m = 0f, x = 0f;
 191     for (int i = 0; vals.hasNext(); i++)
 192     {
 193       float val = vals.next().floatValue();
 194       if (i == 0)
 195       {
 196         m = val;
 197         x = val;
 198       }
 199       else
 200       {
 201         if (m > val)
 202         {
 203           m = val;
 204         }
 205         ;
 206         if (x < val)
 207         {
 208           x = val;
 209         }
 210       }
 211       // if we're at a gapped column then skip to next ungapped position
 212       if (gapMap != null && gapMap.length > 0)
 213       {
 214         while (!gapMap[i])
 215         {
 216           elm[i++] = new Annotation("", "", ' ', Float.NaN);
 217         }
 218       }
 219       elm[i] = new Annotation("", "" + val, ' ', val);
 220     }
 221
 222     annotation.annotations = elm;
 223     annotation.belowAlignment = true;
 224     if (x < 0)
 225     {
 226       x = 0;
 227     }
 228     x += (x - m) * 0.1;
 229     annotation.graphMax = x;
 230     annotation.graphMin = m;
 231     annotation.validateRangeAndDisplay();
 232   }
 233
 234 }