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.datamodel.AlignmentAnnotation;
27 import java.util.ArrayList;
28 import java.util.Collections;
29 import java.util.HashSet;
30 import java.util.Hashtable;
31 import java.util.List;
35 public class AlignCalcManager implements AlignCalcManagerI
38 * list of registered workers
40 private volatile List<AlignCalcWorkerI> restartable;
43 * types of worker _not_ to run (for example, because they have
44 * previously thrown errors)
46 private volatile List<Class<? extends AlignCalcWorkerI>> blackList;
49 * global record of calculations in progress
51 private volatile List<AlignCalcWorkerI> inProgress;
54 * record of calculations pending or in progress in the current context
56 private volatile Map<Class<? extends AlignCalcWorkerI>, List<AlignCalcWorkerI>> updating;
59 * workers that have run to completion so are candidates for visual-only
60 * update of their results
62 private HashSet<AlignCalcWorkerI> canUpdate;
67 public AlignCalcManager()
69 restartable = Collections
70 .synchronizedList(new ArrayList<AlignCalcWorkerI>());
71 blackList = Collections.synchronizedList(
72 new ArrayList<Class<? extends AlignCalcWorkerI>>());
73 inProgress = Collections
74 .synchronizedList(new ArrayList<AlignCalcWorkerI>());
75 updating = Collections.synchronizedMap(
76 new Hashtable<Class<? extends AlignCalcWorkerI>, List<AlignCalcWorkerI>>());
77 canUpdate = new HashSet<AlignCalcWorkerI>();
81 public void notifyStart(AlignCalcWorkerI worker)
83 synchronized (updating)
85 List<AlignCalcWorkerI> upd = updating.get(worker.getClass());
88 updating.put(worker.getClass(), upd = Collections
89 .synchronizedList(new ArrayList<AlignCalcWorkerI>()));
101 * @see jalview.api.AlignCalcManagerI#isPending(jalview.api.AlignCalcWorkerI)
104 public boolean isPending(AlignCalcWorkerI workingClass)
106 List<AlignCalcWorkerI> upd;
107 synchronized (updating)
109 upd = updating.get(workingClass.getClass());
126 public boolean notifyWorking(AlignCalcWorkerI worker)
128 synchronized (inProgress)
130 if (inProgress.contains(worker))
132 return false; // worker is already working, so ask caller to wait around
136 inProgress.add(worker);
143 public void workerComplete(AlignCalcWorkerI worker)
145 synchronized (inProgress)
147 // System.err.println("Worker " + worker + " marked as complete.");
148 inProgress.remove(worker);
149 List<AlignCalcWorkerI> upd = updating.get(worker.getClass());
156 canUpdate.add(worker);
162 public void disableWorker(AlignCalcWorkerI worker)
164 synchronized (blackList)
166 blackList.add(worker.getClass());
171 public boolean isDisabled(AlignCalcWorkerI worker)
173 synchronized (blackList)
175 return blackList.contains(worker.getClass());
180 public void startWorker(AlignCalcWorkerI worker)
182 if (!isDisabled(worker))
184 Thread tw = new Thread(worker);
185 tw.setName(worker.getClass().toString());
191 public boolean isWorking(AlignCalcWorkerI worker)
193 synchronized (inProgress)
194 {// System.err.println("isWorking : worker "+(worker!=null ?
195 // worker.getClass():"null")+ " "+hashCode());
196 return worker != null && inProgress.contains(worker);
201 public boolean isWorking()
203 synchronized (inProgress)
205 // System.err.println("isWorking "+hashCode());
206 return inProgress.size() > 0;
210 public int getQueueLength() {
211 return inProgress.size();
215 public void registerWorker(AlignCalcWorkerI worker)
217 synchronized (restartable)
219 if (!restartable.contains(worker))
221 restartable.add(worker);
228 public void restartWorkers()
230 synchronized (restartable)
232 for (AlignCalcWorkerI worker : restartable)
240 public boolean workingInvolvedWith(
241 AlignmentAnnotation alignmentAnnotation)
243 synchronized (inProgress)
245 for (AlignCalcWorkerI worker : inProgress)
247 if (worker.involves(alignmentAnnotation))
253 synchronized (updating)
255 for (List<AlignCalcWorkerI> workers : updating.values())
257 for (AlignCalcWorkerI worker : workers)
259 if (worker.involves(alignmentAnnotation))
270 public void updateAnnotationFor(
271 Class<? extends AlignCalcWorkerI> workerClass)
274 AlignCalcWorkerI[] workers;
275 synchronized (canUpdate)
277 workers = canUpdate.toArray(new AlignCalcWorkerI[0]);
279 for (AlignCalcWorkerI worker : workers)
281 if (workerClass.equals(worker.getClass()))
283 worker.updateAnnotation();
289 public List<AlignCalcWorkerI> getRegisteredWorkersOfClass(
290 Class<? extends AlignCalcWorkerI> workerClass)
292 List<AlignCalcWorkerI> workingClass = new ArrayList<AlignCalcWorkerI>();
293 synchronized (canUpdate)
295 for (AlignCalcWorkerI worker : canUpdate)
297 if (workerClass.equals(worker.getClass()))
299 workingClass.add(worker);
303 return (workingClass.size() == 0) ? null : workingClass;
307 public void enableWorker(AlignCalcWorkerI worker)
309 synchronized (blackList)
311 blackList.remove(worker.getClass());
316 public void removeRegisteredWorkersOfClass(
317 Class<? extends AlignCalcWorkerI> typeToRemove)
319 List<AlignCalcWorkerI> removable = new ArrayList<AlignCalcWorkerI>();
320 Set<AlignCalcWorkerI> toremovannot = new HashSet<AlignCalcWorkerI>();
321 synchronized (restartable)
323 for (AlignCalcWorkerI worker : restartable)
325 if (typeToRemove.equals(worker.getClass()))
327 removable.add(worker);
328 toremovannot.add(worker);
331 restartable.removeAll(removable);
333 synchronized (canUpdate)
335 for (AlignCalcWorkerI worker : canUpdate)
337 if (typeToRemove.equals(worker.getClass()))
339 removable.add(worker);
340 toremovannot.add(worker);
343 canUpdate.removeAll(removable);
345 // TODO: finish testing this extension
348 * synchronized (inProgress) { // need to kill or mark as dead any running
349 * threads... (inProgress.get(typeToRemove)); }
351 * if (workers == null) { return; } for (AlignCalcWorkerI worker : workers)
354 * if (isPending(worker)) { worker.abortAndDestroy(); startWorker(worker); }
355 * else { System.err.println("Pending exists for " + workerClass); } }
360 * Deletes the worker that update the given annotation, provided it is marked
364 public void removeWorkerForAnnotation(AlignmentAnnotation ann)
367 * first just find those to remove (to avoid
368 * ConcurrentModificationException)
370 List<AlignCalcWorkerI> toRemove = new ArrayList<AlignCalcWorkerI>();
371 for (AlignCalcWorkerI worker : restartable)
373 if (worker.involves(ann))
375 if (worker.isDeletable())
377 toRemove.add(worker);
383 * remove all references to deleted workers so any references
384 * they hold to annotation data can be garbage collected
386 for (AlignCalcWorkerI worker : toRemove)
388 restartable.remove(worker);
389 blackList.remove(worker.getClass());
390 inProgress.remove(worker);
391 canUpdate.remove(worker);
392 synchronized (updating)
394 List<AlignCalcWorkerI> upd = updating.get(worker.getClass());