source/mir/producer/reader/ScriptedProducerNodeDefinition.java

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