source/mircoders/producer/reader/SupplementalProducerNodeBuilders.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 mircoders.producer.reader;
  31
  32 import java.io.File;
  33 import java.util.Map;
  34
  35 import mir.producer.ProducerNode;
  36 import mir.producer.reader.DefaultProducerNodeBuilders;
  37 import mir.producer.reader.ProducerConfigExc;
  38 import mir.producer.reader.ProducerNodeBuilder;
  39 import mir.producer.reader.ProducerNodeBuilderLibrary;
  40 import mir.util.xml.XMLParserExc;
  41 import mir.util.xml.XMLReaderTool;
  42 import mircoders.producer.ContentMarkingProducerNode;
  43 import mircoders.producer.ContentModifyingProducerNode;
  44 import mircoders.producer.IndexingProducerNode;
  45 import mircoders.producer.MediaGeneratingProducerNode;
  46 import mircoders.producer.RadicalendarProducerNode;
  47 import mircoders.producer.UnIndexingProducerNode;
  48
  49
  50 public class SupplementalProducerNodeBuilders {
  51
  52   public static void registerBuilders(ProducerNodeBuilderLibrary aBuilderLibrary, File aBasePath) throws ProducerConfigExc {
  53     aBuilderLibrary.registerBuilder("ModifyContent", ContentModifyingProducerNodeBuilder.class);
  54     aBuilderLibrary.registerBuilder("MarkContent", ContentMarkingProducerNodeBuilder.class);
  55     aBuilderLibrary.registerBuilder("GenerateMedia", MediaGeneratingProducerNodeBuilder.class);
  56
  57     aBuilderLibrary.registerFactory("IndexContent", new ContentIndexingProducerNodeBuilder.factory(aBasePath));
  58     aBuilderLibrary.registerFactory("UnIndexContent", new ContentUnIndexingProducerNodeBuilder.factory(aBasePath));
  59     aBuilderLibrary.registerBuilder("Radicalendar", RadicalendarProducerNodeBuilder.class);
  60   }
  61
  62   private final static String MARKER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
  63   private final static String[] MARKER_REQUIRED_ATTRIBUTES = {MARKER_KEY_ATTRIBUTE};
  64   private final static String[] MARKER_OPTIONAL_ATTRIBUTES = {};
  65   private final static String[] MARKER_SUBNODES = {};
  66
  67   public static class ContentMarkingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
  68
  69     private String key;
  70
  71     public ContentMarkingProducerNodeBuilder() {
  72       super(MARKER_SUBNODES);
  73     }
  74
  75     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLParserExc {
  76       XMLReaderTool.checkAttributes(anAttributes, MARKER_REQUIRED_ATTRIBUTES, MARKER_OPTIONAL_ATTRIBUTES);
  77
  78       key = (String) anAttributes.get(MARKER_KEY_ATTRIBUTE);
  79     }
  80
  81     public ProducerNode constructNode() {
  82       return new ContentMarkingProducerNode(key);
  83     }
  84   }
  85
  86   private final static String INDEXER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
  87   private final static String INDEXER_INDEX_ATTRIBUTE = "pathToIndex";
  88   private final static String[] INDEXER_REQUIRED_ATTRIBUTES = {INDEXER_KEY_ATTRIBUTE, INDEXER_INDEX_ATTRIBUTE};
  89   private final static String[] INDEXER_OPTIONAL_ATTRIBUTES = {};
  90   private final static String[] INDEXER_SUBNODES = {};
  91
  92   public static class ContentIndexingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
  93     private String key;
  94     private String pathToIndex;
  95     private File indexBasePath;
  96
  97     private static class factory implements ProducerNodeBuilderFactory {
  98       private File sourceBasePath;
  99
 100       public factory(File aSourceBasePath) {
 101         sourceBasePath = aSourceBasePath;
 102       }
 103
 104       public ProducerNodeBuilder makeBuilder() {
 105         return new ContentIndexingProducerNodeBuilder(sourceBasePath);
 106       }
 107     }
 108
 109     public ContentIndexingProducerNodeBuilder(File anIndexBasePath) {
 110       super(INDEXER_SUBNODES);
 111
 112       indexBasePath = anIndexBasePath;
 113     }
 114
 115     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLParserExc {
 116       XMLReaderTool.checkAttributes(anAttributes, INDEXER_REQUIRED_ATTRIBUTES, INDEXER_OPTIONAL_ATTRIBUTES);
 117
 118       key = (String) anAttributes.get(INDEXER_KEY_ATTRIBUTE);
 119       pathToIndex = (String) anAttributes.get(INDEXER_INDEX_ATTRIBUTE);
 120     }
 121
 122     public ProducerNode constructNode() {
 123       return new IndexingProducerNode(indexBasePath, key, pathToIndex);
 124     }
 125   }
 126
 127   private final static String UNINDEXER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 128   private final static String UNINDEXER_INDEX_ATTRIBUTE = "pathToIndex";
 129   private final static String[] UNINDEXER_REQUIRED_ATTRIBUTES = {UNINDEXER_KEY_ATTRIBUTE, UNINDEXER_INDEX_ATTRIBUTE};
 130   private final static String[] UNINDEXER_OPTIONAL_ATTRIBUTES = {};
 131   private final static String[] UNINDEXER_SUBNODES = {};
 132
 133   public static class ContentUnIndexingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 134     private String key;
 135     private String pathToIndex;
 136
 137     private File indexBasePath;
 138
 139     private static class factory implements ProducerNodeBuilderFactory {
 140       private File indexBasePath;
 141
 142       public factory(File aSourceBasePath) {
 143         indexBasePath = aSourceBasePath;
 144       }
 145
 146       public ProducerNodeBuilder makeBuilder() {
 147         return new ContentUnIndexingProducerNodeBuilder(indexBasePath);
 148       }
 149     }
 150
 151     public ContentUnIndexingProducerNodeBuilder(File anIndexBasePath) {
 152       super(UNINDEXER_SUBNODES);
 153
 154       indexBasePath = anIndexBasePath;
 155     }
 156
 157     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLParserExc {
 158       XMLReaderTool.checkAttributes(anAttributes, UNINDEXER_REQUIRED_ATTRIBUTES, UNINDEXER_OPTIONAL_ATTRIBUTES);
 159
 160       key = (String) anAttributes.get(UNINDEXER_KEY_ATTRIBUTE);
 161       pathToIndex = (String) anAttributes.get(UNINDEXER_INDEX_ATTRIBUTE);
 162     }
 163
 164     public ProducerNode constructNode() {
 165       return new UnIndexingProducerNode(indexBasePath, key, pathToIndex);
 166     }
 167   }
 168
 169   private final static String CONTENT_MODIFIER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 170   private final static String CONTENT_MODIFIER_FIELD_ATTRIBUTE = "field";
 171   private final static String CONTENT_MODIFIER_VALUE_ATTRIBUTE = "value";
 172   private final static String[] CONTENT_MODIFIER_REQUIRED_ATTRIBUTES = {CONTENT_MODIFIER_KEY_ATTRIBUTE, CONTENT_MODIFIER_FIELD_ATTRIBUTE, CONTENT_MODIFIER_VALUE_ATTRIBUTE};
 173   private final static String[] CONTENT_MODIFIER_OPTIONAL_ATTRIBUTES = {};
 174   private final static String[] CONTENT_MODIFIER_SUBNODES = {};
 175
 176   public static class ContentModifyingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 177
 178     private String key;
 179     private String field;
 180     private String value;
 181
 182     public ContentModifyingProducerNodeBuilder() {
 183       super(CONTENT_MODIFIER_SUBNODES);
 184     }
 185
 186     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLParserExc {
 187       XMLReaderTool.checkAttributes(anAttributes, CONTENT_MODIFIER_REQUIRED_ATTRIBUTES, CONTENT_MODIFIER_OPTIONAL_ATTRIBUTES);
 188
 189       key = (String) anAttributes.get(CONTENT_MODIFIER_KEY_ATTRIBUTE);
 190       field = (String) anAttributes.get(CONTENT_MODIFIER_FIELD_ATTRIBUTE);
 191       value = (String) anAttributes.get(CONTENT_MODIFIER_VALUE_ATTRIBUTE);
 192     }
 193
 194     public ProducerNode constructNode() {
 195       return new ContentModifyingProducerNode(key, field, value);
 196     }
 197   }
 198
 199   private final static String MEDIA_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 200   private final static String[] MEDIA_REQUIRED_ATTRIBUTES = {MEDIA_KEY_ATTRIBUTE};
 201   private final static String[] MEDIA_OPTIONAL_ATTRIBUTES = {};
 202   private final static String[] MEDIA_SUBNODES = {};
 203
 204   public static class MediaGeneratingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 205
 206     private String key;
 207
 208     public MediaGeneratingProducerNodeBuilder() {
 209       super(MEDIA_SUBNODES);
 210     }
 211
 212     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLParserExc {
 213       XMLReaderTool.checkAttributes(anAttributes, MEDIA_REQUIRED_ATTRIBUTES, MEDIA_OPTIONAL_ATTRIBUTES);
 214
 215       key = (String) anAttributes.get(MEDIA_KEY_ATTRIBUTE);
 216     }
 217
 218     public ProducerNode constructNode() {
 219       return new MediaGeneratingProducerNode(key);
 220     }
 221   }
 222
 223   public static class RadicalendarProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 224     private final static String RC_KEY_ATTRIBUTE = "key";
 225     private final static String RC_GROUPNAME_ATTRIBUTE = "groupname";
 226     private final static String RC_GMTOFFSET_ATTRIBUTE = "gmtoffset";
 227     private final static String[] RC_REQUIRED_ATTRIBUTES = {RC_KEY_ATTRIBUTE, RC_GROUPNAME_ATTRIBUTE, RC_GMTOFFSET_ATTRIBUTE};
 228     private final static String[] RC_OPTIONAL_ATTRIBUTES = {};
 229     private final static String[] RC_SUBNODES = {};
 230     private String key;
 231     private String groupname;
 232     private String gmtoffset;
 233
 234     public RadicalendarProducerNodeBuilder() {
 235       super(RC_SUBNODES);
 236     }
 237
 238     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLParserExc {
 239       XMLReaderTool.checkAttributes(anAttributes, RC_REQUIRED_ATTRIBUTES, RC_OPTIONAL_ATTRIBUTES);
 240
 241       key = (String) anAttributes.get(RC_KEY_ATTRIBUTE);
 242       groupname = (String) anAttributes.get(RC_GROUPNAME_ATTRIBUTE);
 243       gmtoffset = (String) anAttributes.get(RC_GMTOFFSET_ATTRIBUTE);
 244     }
 245
 246     public ProducerNode constructNode() {
 247       return new RadicalendarProducerNode(key, groupname, gmtoffset);
 248     }
 249   }
 250
 251 }
 252
 253