JAL-1365 refactored core methods from RNAAliFold and AACon service clients to a commo...
[jalview.git] / src / jalview / ws / jws2 / AAConClient.java
1 /*
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
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 of the License, or (at your option) any later version.
10  *  
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.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.ws.jws2;
19
20 import jalview.datamodel.AlignmentAnnotation;
21 import jalview.gui.AlignFrame;
22 import jalview.gui.AlignmentPanel;
23 import jalview.ws.jws2.dm.AAConSettings;
24 import jalview.ws.jws2.jabaws2.Jws2Instance;
25 import jalview.ws.params.WsParamSetI;
26
27 import java.util.ArrayList;
28 import java.util.List;
29 import java.util.Map;
30 import java.util.Set;
31 import java.util.TreeSet;
32
33 import compbio.data.sequence.Score;
34 import compbio.metadata.Argument;
35
36 public class AAConClient extends JabawsAlignCalcWorker
37 {
38
39   public AAConClient(Jws2Instance service, AlignFrame alignFrame,
40           WsParamSetI preset, List<Argument> paramset)
41   {
42     super(service, alignFrame, preset, paramset);
43     submitGaps = true;
44     alignedSeqs = true;
45     nucleotidesAllowed = false;
46     proteinAllowed = true;
47     gapMap = new boolean[0];
48     initViewportParams();
49   }
50
51   public String getServiceActionText()
52   {
53     return "calculating Amino acid consensus using AACon service";
54   }
55
56   /**
57    * update the consensus annotation from the sequence profile data using
58    * current visualization settings.
59    */
60
61   public void updateResultAnnotation(boolean immediate)
62   {
63     if (immediate || !calcMan.isWorking(this) && scoremanager != null)
64     {
65       Map<String, TreeSet<Score>> scoremap = scoremanager.asMap();
66       int alWidth = alignViewport.getAlignment().getWidth();
67       ArrayList<AlignmentAnnotation> ourAnnot = new ArrayList<AlignmentAnnotation>();
68       for (String score : scoremap.keySet())
69       {
70         Set<Score> scores = scoremap.get(score);
71         for (Score scr : scores)
72         {
73           if (scr.getRanges() != null && scr.getRanges().size() > 0)
74           {
75             /**
76              * annotation in range annotation = findOrCreate(scr.getMethod(),
77              * true, null, null); Annotation[] elm = new Annotation[alWidth];
78              * Iterator<Float> vals = scr.getScores().iterator(); for (Range rng
79              * : scr.getRanges()) { float val = vals.next().floatValue(); for
80              * (int i = rng.from; i <= rng.to; i++) { elm[i] = new
81              * Annotation("", "", ' ', val); } } annotation.annotations = elm;
82              * annotation.validateRangeAndDisplay();
83              */
84           }
85           else
86           {
87             createAnnotationRowsForScores(ourAnnot, getCalcId(), alWidth,
88                     scr);
89           }
90         }
91       }
92
93       if (ourAnnot.size() > 0)
94       {
95         updateOurAnnots(ourAnnot);
96       }
97     }
98   }
99
100   @Override
101   public String getCalcId()
102   {
103     return CALC_ID;
104   }
105   private static String CALC_ID="jabaws2.AACon";
106
107   {
108   }
109 }