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