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 import java.util.HashMap;
  33 import java.util.Map;
  34
  35 import mir.log.LoggerWrapper;
  36 /**
  37  * <p>A NodedProducer is the root of a tree of ProducerNodes.</p>
  38  *
  39  * <p>There  used to be  a time  when there  were Producers  that weren't
  40  * NodedProducers, however they have been phased out.</p>
  41  */
  42 public class NodedProducer implements Producer {
  43   private ProducerNode rootNode;
  44   private String verb;
  45   private Map baseValues;
  46   private boolean isAborted;
  47   private boolean isFinished;
  48   protected final static String PRODUCER_KEY = "$producer";
  49
  50   public NodedProducer( ProducerNode aRootNode, String aVerb, Map aBaseValues) {
  51     rootNode = aRootNode;
  52     verb = aVerb;
  53     baseValues = aBaseValues;
  54     isAborted = false;
  55   }
  56
  57   public boolean produce( LoggerWrapper aLogger ) throws ProducerFailure, ProducerExc {
  58     Map valueMap;
  59
  60     valueMap = new HashMap();
  61     valueMap.putAll(baseValues);
  62     valueMap.put(PRODUCER_KEY, this);
  63
  64     rootNode.produce(valueMap, verb, aLogger);
  65
  66     synchronized(this) {
  67       isFinished=true;
  68       return !isAborted;
  69     }
  70   }
  71
  72   public void abort() {
  73     synchronized(this) {
  74       if (!isFinished)
  75         isAborted=true;
  76     }
  77   }
  78
  79   public boolean getIsAborted() {
  80     synchronized(this) {
  81       return isAborted;
  82     }
  83   }
  84
  85   public boolean getIsFinished() {
  86     synchronized(this) {
  87       return isFinished;
  88     }
  89   }
  90 }