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