src/jalview/api/AlignCalcWorkerI.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.api;
  22
  23 import java.util.concurrent.Callable;
  24
  25 import jalview.datamodel.AlignmentAnnotation;
  26
  27 /**
  28  * Interface describing a worker that calculates alignment annotation(s). The
  29  * main (re-)calculation should be performed by the inherited run() method.
  30  */
  31 public interface AlignCalcWorkerI
  32 {
  33   /**
  34    * Returns the name of this calculation used to identify the service running
  35    * this worker.
  36    *
  37    * @return calculator name
  38    */
  39   public default String getCalcName()
  40   {
  41     return null;
  42   }
  43
  44   /**
  45    * Answers true if this worker updates the given annotation (regardless of its
  46    * current state)
  47    *
  48    * @param annot
  49    * @return
  50    */
  51   boolean involves(AlignmentAnnotation annot);
  52
  53   /**
  54    * Updates the display of calculated annotation values (does not recalculate
  55    * the values). This allows a quick redraw of annotations when display
  56    * settings are changed.
  57    */
  58   void updateAnnotation();
  59
  60   /**
  61    * Removes any annotation(s) managed by this worker from the alignment
  62    */
  63   void removeAnnotation();
  64
  65   /**
  66    * The main calculation happens here
  67    *
  68    * @throws Throwable
  69    */
  70   public void run() throws Throwable;
  71
  72   /**
  73    * Answers true if the worker should be deleted entirely when its annotation
  74    * is deleted from the display, or false if it should continue to run. Some
  75    * workers are required to run for their side-effects.
  76    *
  77    * @return
  78    */
  79   boolean isDeletable();
  80 }