JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / workers / ConservationThread.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
3  * Copyright (C) 2015 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.workers;
22
23 import jalview.analysis.Conservation;
24 import jalview.api.AlignCalcWorkerI;
25 import jalview.api.AlignViewportI;
26 import jalview.api.AlignmentViewPanel;
27 import jalview.datamodel.AlignmentAnnotation;
28 import jalview.datamodel.AlignmentI;
29
30 import java.util.ArrayList;
31 import java.util.List;
32
33 public class ConservationThread extends AlignCalcWorker implements
34         AlignCalcWorkerI
35 {
36
37   private int ConsPercGaps = 25; // JBPNote : This should be a configurable
38                                  // property!
39
40   public ConservationThread(AlignViewportI alignViewport,
41           AlignmentViewPanel alignPanel)
42   {
43     super(alignViewport, alignPanel);
44     ConsPercGaps = alignViewport.getConsPercGaps();
45   }
46
47   private Conservation cons;
48
49   AlignmentAnnotation conservation, quality;
50
51   int alWidth;
52
53   @Override
54   public void run()
55   {
56     try
57     {
58       calcMan.notifyStart(this); // updatingConservation = true;
59
60       while (!calcMan.notifyWorking(this))
61       {
62         try
63         {
64           if (ap != null)
65           {
66             // ap.paintAlignment(false);
67           }
68           Thread.sleep(200);
69         } catch (Exception ex)
70         {
71           ex.printStackTrace();
72         }
73       }
74       if (alignViewport.isClosed())
75       {
76         abortAndDestroy();
77         return;
78       }
79       List<AlignmentAnnotation> ourAnnot = new ArrayList<AlignmentAnnotation>();
80       AlignmentI alignment = alignViewport.getAlignment();
81       conservation = alignViewport.getAlignmentConservationAnnotation();
82       quality = alignViewport.getAlignmentQualityAnnot();
83       ourAnnot.add(conservation);
84       ourAnnot.add(quality);
85       ourAnnots = ourAnnot;
86       ConsPercGaps = alignViewport.getConsPercGaps();
87       // AlignViewport.UPDATING_CONSERVATION = true;
88
89       if (alignment == null || (alWidth = alignment.getWidth()) < 0)
90       {
91         calcMan.workerComplete(this);
92         // .updatingConservation = false;
93         // AlignViewport.UPDATING_CONSERVATION = false;
94
95         return;
96       }
97       try
98       {
99         cons = Conservation.calculateConservation("All",
100                 jalview.schemes.ResidueProperties.propHash, 3,
101                 alignment.getSequences(), 0, alWidth - 1, false,
102                 ConsPercGaps, quality != null);
103       } catch (IndexOutOfBoundsException x)
104       {
105         // probable race condition. just finish and return without any fuss.
106         calcMan.workerComplete(this);
107         return;
108       }
109       updateResultAnnotation(true);
110     } catch (OutOfMemoryError error)
111     {
112       ap.raiseOOMWarning("calculating conservation", error);
113       calcMan.workerCannotRun(this);
114       // alignViewport.conservation = null;
115       // this.alignViewport.quality = null;
116
117     }
118     calcMan.workerComplete(this);
119
120     if (ap != null)
121     {
122       ap.paintAlignment(true);
123     }
124
125   }
126
127   private void updateResultAnnotation(boolean b)
128   {
129     if (b || !calcMan.isWorking(this) && cons != null
130             && conservation != null && quality != null)
131     {
132       alignViewport.setConservation(cons);
133       cons.completeAnnotations(conservation, quality, 0, alWidth);
134     }
135   }
136
137   @Override
138   public void updateAnnotation()
139   {
140     updateResultAnnotation(false);
141
142   }
143 }