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