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