9692ba698b4e3a3154437658859c19467aa6fd53
[mir.git] / source / mir / producer / NodedProducer.java
1 /*
2  * Copyright (C) 2001, 2002 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License,
22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23  * (or with modified versions of the above that use the same license as the above),
24  * and distribute linked combinations including the two.  You must obey the
25  * GNU General Public License in all respects for all of the code used other than
26  * the above mentioned libraries.  If you modify this file, you may extend this
27  * exception to your version of the file, but you are not obligated to do so.
28  * If you do not wish to do so, delete this exception statement from your version.
29  */
30 package mir.producer;
31
32 /**
33  * <p>A NodedProducer is the root of a tree of ProducerNodes.</p>
34  * 
35  * <p>There  used to be  a time  when there  were Producers  that weren't
36  * NodedProducers, however they have been phased out.</p>
37  */
38
39 public class NodedProducer implements Producer {
40   private ProducerNode rootNode;
41   private boolean isAborted;
42   private boolean isFinished;
43   protected final static String PRODUCER_KEY = "$producer";
44
45   public NodedProducer(ProducerNode aRootNode) {
46     rootNode = aRootNode;
47     isAborted = false;
48   }
49
50   public boolean execute(ProductionContext aProductionContext) throws ProducerFailure, ProducerExc {
51     rootNode.produce(aProductionContext);
52
53     synchronized(this) {
54       isFinished=true;
55
56       return !isAborted;
57     }
58   }
59
60   public void abort(ProductionContext aContext) {
61     synchronized(this) {
62       if (!isFinished)
63         isAborted=true;
64     }
65   }
66
67   public boolean getIsAborted() {
68     synchronized(this) {
69       return isAborted;
70     }
71   }
72 }