source/mir/producer/reader/ScriptedProducerNodeDefinition.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 the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mir.producer.reader;
  33
  34 import java.util.HashMap;
  35 import java.util.HashSet;
  36 import java.util.Iterator;
  37 import java.util.Map;
  38 import java.util.Set;
  39 import java.util.Stack;
  40
  41 import mir.log.LoggerWrapper;
  42 import mir.producer.CompositeProducerNode;
  43 import mir.producer.ProducerExc;
  44 import mir.producer.ProducerFailure;
  45 import mir.producer.ProducerNode;
  46
  47 public class ScriptedProducerNodeDefinition {
  48   private Map integerParameters;               // name -> default value
  49   private Map stringParameters;               // name -> default value
  50   private Set nodeParameters;
  51   private ProducerNode body;
  52   private String name;
  53
  54   public static String SCRIPTED_PRODUCERNODE_RUNTIMEDATA_KEY = "$SCRIPTRUNTIMEDATA";
  55   public static String SCRIPTED_PRODUCERNODE_RUNTIMESTACK_KEY = "stack";
  56
  57   public ScriptedProducerNodeDefinition(String aName) {
  58     name = aName;
  59     integerParameters = new HashMap();
  60     stringParameters = new HashMap();
  61     nodeParameters = new HashSet();
  62     body = new CompositeProducerNode();
  63   }
  64
  65   public void addStringParameter(String aName, String aDefaultValue) {
  66     stringParameters.put(aName, aDefaultValue);
  67   }
  68
  69   public void addIntegerParameter(String aName, String aDefaultValue) {
  70     integerParameters.put(aName, aDefaultValue);
  71   }
  72
  73   public void addNodeParameter(String aName) {
  74     nodeParameters.add(aName);
  75   }
  76
  77   public void setBody(ProducerNode aBody) {
  78     body = aBody;
  79   }
  80
  81   protected Map getStringParameters() {
  82     return stringParameters;
  83   }
  84
  85   protected Map getIntegerParameters() {
  86     return integerParameters;
  87   }
  88
  89   protected Set getNodeParameters() {
  90     return nodeParameters;
  91   }
  92
  93   protected ProducerNode getBody() {
  94     return body;
  95   }
  96
  97   public String getName() {
  98     return name;
  99   }
 100
 101   public Set getRequiredAttributes() {
 102     return getAttributesSelection(true);
 103   }
 104
 105   public Set getOptionalAttributes() {
 106     return getAttributesSelection(false);
 107   }
 108
 109   public Set getAttributesSelection(boolean aRequired) {
 110     Set result = new HashSet();
 111     Iterator i = stringParameters.entrySet().iterator();
 112
 113     while (i.hasNext()) {
 114       Map.Entry entry = (Map.Entry) i.next();
 115
 116       if ((entry.getValue() == null) == aRequired ) {
 117         result.add(entry.getKey());
 118       }
 119     }
 120
 121     i = integerParameters.entrySet().iterator();
 122
 123     while (i.hasNext()) {
 124       Map.Entry entry = (Map.Entry) i.next();
 125
 126       if ((entry.getValue() == null) == aRequired ) {
 127         result.add(entry.getKey());
 128       }
 129     }
 130
 131     return result;
 132   }
 133
 134
 135   protected static class NodeParameterProducerNode implements ProducerNode {
 136     private String parameterName;
 137     private String definitionName;
 138
 139     public NodeParameterProducerNode(String aDefinitionName, String aParameterName) {
 140       definitionName = aDefinitionName;
 141       parameterName = aParameterName;
 142     }
 143
 144     public void produce(Map aValues, String aVerb, LoggerWrapper aLogger) throws ProducerExc, ProducerFailure {
 145       ProducerNode producerNode;
 146
 147       Map runTimeData = (Map) ((Map) aValues.get(SCRIPTED_PRODUCERNODE_RUNTIMEDATA_KEY)).get(definitionName);
 148       Map parameters = (Map) ((Stack) runTimeData.get( SCRIPTED_PRODUCERNODE_RUNTIMESTACK_KEY )).peek();
 149
 150       producerNode = (ProducerNode) parameters.get(parameterName);
 151
 152       if (producerNode != null)
 153         producerNode.produce(aValues, aVerb, aLogger);
 154     }
 155
 156     public Set buildVerbSet() {
 157       return new HashSet();
 158     }
 159   }
 160 }