1. Project Clover database Fri Dec 6 2024 13:47:14 GMT
  2. Package jalview.api

File AlignCalcWorkerI.java

 

Code metrics

0
0
0
1
60
9
0
-
-
0
-

Classes

Class
Line #
Actions
AlignCalcWorkerI 29 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.api;
22   
23    import jalview.datamodel.AlignmentAnnotation;
24   
25    /**
26    * Interface describing a worker that calculates alignment annotation(s). The
27    * main (re-)calculation should be performed by the inherited run() method.
28    */
 
29    public interface AlignCalcWorkerI extends Runnable
30    {
31    /**
32    * Answers true if this worker updates the given annotation (regardless of its
33    * current state)
34    *
35    * @param annot
36    * @return
37    */
38    boolean involves(AlignmentAnnotation annot);
39   
40    /**
41    * Updates the display of calculated annotation values (does not recalculate
42    * the values). This allows ßquick redraw of annotations when display settings
43    * are changed.
44    */
45    void updateAnnotation();
46   
47    /**
48    * Removes any annotation(s) managed by this worker from the alignment
49    */
50    void removeAnnotation();
51   
52    /**
53    * Answers true if the worker should be deleted entirely when its annotation
54    * is deleted from the display, or false if it should continue to run. Some
55    * workers are required to run for their side-effects.
56    *
57    * @return
58    */
59    boolean isDeletable();
60    }