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  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.*;
  33
  34 import java.util.*;
  35
  36 public class ScriptedProducerNodeDefinition {
  37   private Map integerParameters;               // name -> default value
  38   private Map stringParameters;               // name -> default value
  39   private Set nodeParameters;
  40   private ProducerNode body;
  41   private String name;
  42
  43   public static String SCRIPTED_PRODUCERNODE_RUNTIMEDATA_KEY = "$SCRIPTRUNTIMEDATA";
  44   public static String SCRIPTED_PRODUCERNODE_RUNTIMESTACK_KEY = "stack";
  45
  46   public ScriptedProducerNodeDefinition(String aName) {
  47     name = aName;
  48     integerParameters = new HashMap();
  49     stringParameters = new HashMap();
  50     nodeParameters = new HashSet();
  51     body = new CompositeProducerNode();
  52   }
  53
  54   public void addStringParameter(String aName, String aDefaultValue) {
  55     stringParameters.put(aName, aDefaultValue);
  56   }
  57
  58   public void addIntegerParameter(String aName, String aDefaultValue) {
  59     integerParameters.put(aName, aDefaultValue);
  60   }
  61
  62   public void addNodeParameter(String aName) {
  63     nodeParameters.add(aName);
  64   }
  65
  66   public void setBody(ProducerNode aBody) {
  67     body = aBody;
  68   }
  69
  70   protected Map getStringParameters() {
  71     return stringParameters;
  72   }
  73
  74   protected Map getIntegerParameters() {
  75     return integerParameters;
  76   }
  77
  78   protected Set getNodeParameters() {
  79     return nodeParameters;
  80   }
  81
  82   protected ProducerNode getBody() {
  83     return body;
  84   }
  85
  86   public String getName() {
  87     return name;
  88   }
  89
  90   public Set getRequiredAttributes() {
  91     return getAttributesSelection(true);
  92   }
  93
  94   public Set getOptionalAttributes() {
  95     return getAttributesSelection(false);
  96   }
  97
  98   public Set getAttributesSelection(boolean aRequired) {
  99     Set result = new HashSet();
 100     Iterator i = stringParameters.entrySet().iterator();
 101
 102     while (i.hasNext()) {
 103       Map.Entry entry = (Map.Entry) i.next();
 104
 105       if ((entry.getValue() == null) == aRequired ) {
 106         result.add(entry.getKey());
 107       }
 108     }
 109
 110     i = integerParameters.entrySet().iterator();
 111
 112     while (i.hasNext()) {
 113       Map.Entry entry = (Map.Entry) i.next();
 114
 115       if ((entry.getValue() == null) == aRequired ) {
 116         result.add(entry.getKey());
 117       }
 118     }
 119
 120     return result;
 121   }
 122
 123   protected static class NodeParameterProducerNode implements ProducerNode {
 124     private String parameterName;
 125     private String definitionName;
 126
 127     public NodeParameterProducerNode(String aDefinitionName, String aParameterName) {
 128       definitionName = aDefinitionName;
 129       parameterName = aParameterName;
 130     }
 131
 132     public void produce(ProductionContext aProductionContext) throws ProducerExc, ProducerFailure {
 133       ProducerNode producerNode;
 134
 135       Map runTimeData = (Map) ((Map) aProductionContext.getValueSet().get(SCRIPTED_PRODUCERNODE_RUNTIMEDATA_KEY)).get(definitionName);
 136       Map parameters = (Map) ((Stack) runTimeData.get( SCRIPTED_PRODUCERNODE_RUNTIMESTACK_KEY )).peek();
 137
 138       producerNode = (ProducerNode) parameters.get(parameterName);
 139
 140       if (producerNode != null) {
 141         producerNode.produce(aProductionContext);
 142       }
 143     }
 144
 145     public Set buildVerbSet() {
 146       return new HashSet();
 147     }
 148   }
 149 }