source/mir/producer/reader/ScriptedProducerNode.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.reader;
  31
  32 import mir.producer.ProducerExc;
  33 import mir.producer.ProducerFailure;
  34 import mir.producer.ProducerNode;
  35 import mir.producer.ProductionContext;
  36 import mir.util.ParameterExpander;
  37
  38 import java.util.HashMap;
  39 import java.util.Iterator;
  40 import java.util.Map;
  41
  42 /**
  43  * <p> A  ScriptedProducerNode is a  ProducerNode which is  defined in
  44  * producers.xml file by the &lt;nodedefinition&gt; statement.  </p>
  45  *
  46  * <p>It  Acts as  a  "function"  (or "macro")  that  can be  "called"
  47  * elsewhere in a  producer.  More precisely, it is a  way to define a
  48  * new producer  node type inside the producers.xml  file.  (check the
  49  * Language node in that file for an example).</p>
  50  */
  51 public class ScriptedProducerNode implements ProducerNode {
  52   private ScriptedProducerNodeDefinition definition;
  53   private Map integerParameterValues;
  54   private Map stringParameterValues;
  55   private Map nodeParameterValues;
  56
  57   public ScriptedProducerNode(ScriptedProducerNodeDefinition aDefinition, Map aStringParameterValues, Map anIntegerParameterValues, Map aNodeParameterValues) {
  58     definition = aDefinition;
  59     stringParameterValues = new HashMap();
  60     stringParameterValues.putAll(aStringParameterValues);
  61     integerParameterValues = new HashMap();
  62     integerParameterValues.putAll(anIntegerParameterValues);
  63     nodeParameterValues = new HashMap();
  64     nodeParameterValues.putAll(aNodeParameterValues);
  65   }
  66
  67   public void produce(ProductionContext aProductionContext) throws ProducerFailure, ProducerExc {
  68     try {
  69       Map oldValues = new HashMap();
  70       ScriptedProducerNodeTool.saveMapValues(oldValues,
  71           aProductionContext.getValueSet(), definition.getStringParameters().keySet());
  72       ScriptedProducerNodeTool.saveMapValues(oldValues,
  73           aProductionContext.getValueSet(), definition.getIntegerParameters().keySet());
  74       try {
  75         Iterator i = stringParameterValues.entrySet().iterator();
  76
  77         while (i.hasNext()) {
  78           Map.Entry entry = (Map.Entry) i.next();
  79
  80           if (entry.getValue() instanceof String) {
  81             aProductionContext.getValueSet().put(entry.getKey(),
  82                 ParameterExpander.expandExpression(aProductionContext.getValueSet(),
  83                     (String) entry.getValue()));
  84           }
  85         }
  86
  87         i = integerParameterValues.entrySet().iterator();
  88
  89         while (i.hasNext()) {
  90           Map.Entry entry = (Map.Entry) i.next();
  91
  92           if (entry.getValue() instanceof String) {
  93             aProductionContext.getValueSet().put(entry.getKey(),
  94                 ParameterExpander.evaluateExpression(aProductionContext.getValueSet(), (String) entry.getValue()));
  95           }
  96         }
  97
  98         ScriptedProducerNodeTool.pushNodeParameterValues(aProductionContext.getValueSet(),
  99             definition.getName(), nodeParameterValues);
 100         try {
 101           definition.getBody().produce(aProductionContext);
 102         }
 103         finally {
 104           ScriptedProducerNodeTool.popNodeParameterValues(aProductionContext.getValueSet(), definition.getName());
 105         }
 106       }
 107       finally {
 108         ScriptedProducerNodeTool.restoreMapValues(aProductionContext.getValueSet(), definition.getIntegerParameters().keySet(), oldValues);
 109         ScriptedProducerNodeTool.restoreMapValues(aProductionContext.getValueSet(), definition.getStringParameters().keySet(), oldValues);
 110       }
 111     }
 112     catch (Exception e) {
 113       aProductionContext.getLogger().error("Scripted producer node " + definition.getName() + " caused an exception", e);
 114     }
 115   }
 116
 117 }