/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
- * Copyright (C) 2015 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
*/
package jalview.api;
+import java.util.concurrent.Callable;
+
import jalview.datamodel.AlignmentAnnotation;
/**
* Interface describing a worker that calculates alignment annotation(s). The
* main (re-)calculation should be performed by the inherited run() method.
*/
-public interface AlignCalcWorkerI extends Runnable
+public interface AlignCalcWorkerI
{
/**
+ * Returns the name of this calculation used to identify the service running
+ * this worker.
+ *
+ * @return calculator name
+ */
+ public default String getCalcName()
+ {
+ return null;
+ }
+
+ /**
* Answers true if this worker updates the given annotation (regardless of its
* current state)
*
/**
* Updates the display of calculated annotation values (does not recalculate
- * the values). This allows ßquick redraw of annotations when display settings
- * are changed.
+ * the values). This allows a quick redraw of annotations when display
+ * settings are changed.
*/
void updateAnnotation();
void removeAnnotation();
/**
+ * The main calculation happens here
+ *
+ * @throws Throwable
+ */
+ public void run() throws Throwable;
+
+ /**
* Answers true if the worker should be deleted entirely when its annotation
* is deleted from the display, or false if it should continue to run. Some
* workers are required to run for their side-effects.