2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.workers;
23 import jalview.api.AlignCalcManagerI;
24 import jalview.api.AlignCalcWorkerI;
25 import jalview.bin.Cache;
26 import jalview.datamodel.AlignmentAnnotation;
28 import java.util.ArrayList;
29 import java.util.Collections;
30 import java.util.HashSet;
31 import java.util.Hashtable;
32 import java.util.List;
36 public class AlignCalcManager implements AlignCalcManagerI
39 * list of registered workers
41 private volatile List<AlignCalcWorkerI> restartable;
44 * types of worker _not_ to run (for example, because they have
45 * previously thrown errors)
47 private volatile List<Class<? extends AlignCalcWorkerI>> blackList;
50 * global record of calculations in progress
52 private volatile List<AlignCalcWorkerI> inProgress;
55 * record of calculations pending or in progress in the current context
57 private volatile Map<Class<? extends AlignCalcWorkerI>, List<AlignCalcWorkerI>> updating;
60 * workers that have run to completion so are candidates for visual-only
61 * update of their results
63 private HashSet<AlignCalcWorkerI> canUpdate;
68 public AlignCalcManager()
70 restartable = Collections
71 .synchronizedList(new ArrayList<AlignCalcWorkerI>());
72 blackList = Collections.synchronizedList(
73 new ArrayList<Class<? extends AlignCalcWorkerI>>());
74 inProgress = Collections
75 .synchronizedList(new ArrayList<AlignCalcWorkerI>());
76 updating = Collections.synchronizedMap(
77 new Hashtable<Class<? extends AlignCalcWorkerI>, List<AlignCalcWorkerI>>());
78 canUpdate = new HashSet<>();
82 public void notifyStart(AlignCalcWorkerI worker)
84 synchronized (updating)
86 List<AlignCalcWorkerI> upd = updating.get(worker.getClass());
89 updating.put(worker.getClass(), upd = Collections
90 .synchronizedList(new ArrayList<AlignCalcWorkerI>()));
94 // avoid use of 'Contains' in case
95 for (AlignCalcWorkerI _otherworker : upd)
97 if (_otherworker == upd)
100 "Ignoring second call to notifyStart for worker "
113 * @see jalview.api.AlignCalcManagerI#isPending(jalview.api.AlignCalcWorkerI)
116 public boolean isPending(AlignCalcWorkerI workingClass)
118 List<AlignCalcWorkerI> upd;
119 synchronized (updating)
121 upd = updating.get(workingClass.getClass());
138 public boolean notifyWorking(AlignCalcWorkerI worker)
140 synchronized (inProgress)
142 if (inProgress.contains(worker))
144 return false; // worker is already working, so ask caller to wait around
148 inProgress.add(worker);
155 public void workerComplete(AlignCalcWorkerI worker)
157 synchronized (inProgress)
159 // System.err.println("Worker " + worker + " marked as complete.");
160 inProgress.remove(worker);
161 List<AlignCalcWorkerI> upd = updating.get(worker.getClass());
168 canUpdate.add(worker);
174 public void disableWorker(AlignCalcWorkerI worker)
176 synchronized (blackList)
178 blackList.add(worker.getClass());
183 public boolean isDisabled(AlignCalcWorkerI worker)
185 synchronized (blackList)
187 return blackList.contains(worker.getClass());
192 public void startWorker(AlignCalcWorkerI worker)
194 if (!isDisabled(worker))
196 Thread tw = new Thread(worker);
197 tw.setName(worker.getClass().toString());
203 public boolean isWorking(AlignCalcWorkerI worker)
205 synchronized (inProgress)
206 {// System.err.println("isWorking : worker "+(worker!=null ?
207 // worker.getClass():"null")+ " "+hashCode());
208 return worker != null && inProgress.contains(worker);
213 public boolean isWorking()
215 synchronized (inProgress)
217 // System.err.println("isWorking "+hashCode());
218 return inProgress.size() > 0;
223 public void registerWorker(AlignCalcWorkerI worker)
225 synchronized (restartable)
227 if (!restartable.contains(worker))
229 restartable.add(worker);
236 public void restartWorkers()
238 synchronized (restartable)
240 for (AlignCalcWorkerI worker : restartable)
248 public boolean workingInvolvedWith(
249 AlignmentAnnotation alignmentAnnotation)
251 synchronized (inProgress)
253 for (AlignCalcWorkerI worker : inProgress)
255 if (worker.involves(alignmentAnnotation))
261 synchronized (updating)
263 for (List<AlignCalcWorkerI> workers : updating.values())
265 for (AlignCalcWorkerI worker : workers)
267 if (worker.involves(alignmentAnnotation))
278 public void updateAnnotationFor(
279 Class<? extends AlignCalcWorkerI> workerClass)
282 AlignCalcWorkerI[] workers;
283 synchronized (canUpdate)
285 workers = canUpdate.toArray(new AlignCalcWorkerI[0]);
287 for (AlignCalcWorkerI worker : workers)
289 if (workerClass.equals(worker.getClass()))
291 worker.updateAnnotation();
297 public List<AlignCalcWorkerI> getRegisteredWorkersOfClass(
298 Class<? extends AlignCalcWorkerI> workerClass)
300 List<AlignCalcWorkerI> workingClass = new ArrayList<>();
301 synchronized (canUpdate)
303 for (AlignCalcWorkerI worker : canUpdate)
305 if (workerClass.equals(worker.getClass()))
307 workingClass.add(worker);
311 return (workingClass.size() == 0) ? null : workingClass;
315 public void enableWorker(AlignCalcWorkerI worker)
317 synchronized (blackList)
319 blackList.remove(worker.getClass());
324 public void removeRegisteredWorkersOfClass(
325 Class<? extends AlignCalcWorkerI> typeToRemove)
327 List<AlignCalcWorkerI> removable = new ArrayList<>();
328 Set<AlignCalcWorkerI> toremovannot = new HashSet<>();
329 synchronized (restartable)
331 for (AlignCalcWorkerI worker : restartable)
333 if (typeToRemove.equals(worker.getClass()))
335 removable.add(worker);
336 toremovannot.add(worker);
339 restartable.removeAll(removable);
341 synchronized (canUpdate)
343 for (AlignCalcWorkerI worker : canUpdate)
345 if (typeToRemove.equals(worker.getClass()))
347 removable.add(worker);
348 toremovannot.add(worker);
351 canUpdate.removeAll(removable);
353 // TODO: finish testing this extension
356 * synchronized (inProgress) { // need to kill or mark as dead any running
357 * threads... (inProgress.get(typeToRemove)); }
359 * if (workers == null) { return; } for (AlignCalcWorkerI worker : workers)
362 * if (isPending(worker)) { worker.abortAndDestroy(); startWorker(worker); }
363 * else { System.err.println("Pending exists for " + workerClass); } }
368 * Deletes the worker that update the given annotation, provided it is marked
372 public void removeWorkerForAnnotation(AlignmentAnnotation ann)
375 * first just find those to remove (to avoid
376 * ConcurrentModificationException)
378 List<AlignCalcWorkerI> toRemove = new ArrayList<>();
379 for (AlignCalcWorkerI worker : restartable)
381 if (worker.involves(ann))
383 if (worker.isDeletable())
385 toRemove.add(worker);
391 * remove all references to deleted workers so any references
392 * they hold to annotation data can be garbage collected
394 for (AlignCalcWorkerI worker : toRemove)
396 restartable.remove(worker);
397 blackList.remove(worker.getClass());
398 inProgress.remove(worker);
399 canUpdate.remove(worker);
400 synchronized (updating)
402 List<AlignCalcWorkerI> upd = updating.get(worker.getClass());