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 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 mircoders.producer.reader;
  33
  34 import java.util.Map;
  35
  36 import mir.entity.adapter.EntityAdapterModel;
  37 import mir.producer.ProducerNode;
  38 import mir.producer.reader.DefaultProducerNodeBuilders;
  39 import mir.producer.reader.ProducerConfigExc;
  40 import mir.producer.reader.ProducerNodeBuilderLibrary;
  41 import mir.util.XMLReader;
  42 import mir.util.XMLReaderTool;
  43 import mircoders.producer.ContentMarkingProducerNode;
  44 import mircoders.producer.ContentModifyingProducerNode;
  45 import mircoders.producer.IndexingProducerNode;
  46 import mircoders.producer.MediaGeneratingProducerNode;
  47 import mircoders.producer.PDFGeneratingProducerNode;
  48 import mircoders.producer.PDFPreFormattingProducerNode;
  49 import mircoders.producer.UnIndexingProducerNode;
  50
  51
  52 public class SupplementalProducerNodeBuilders {
  53
  54   public static void registerBuilders(ProducerNodeBuilderLibrary aBuilderLibrary, EntityAdapterModel aModel) throws ProducerConfigExc {
  55     aBuilderLibrary.registerBuilder("ModifyContent", ContentModifyingProducerNodeBuilder.class);
  56     aBuilderLibrary.registerBuilder("MarkContent", ContentMarkingProducerNodeBuilder.class);
  57     aBuilderLibrary.registerBuilder("GenerateMedia", MediaGeneratingProducerNodeBuilder.class);
  58
  59     aBuilderLibrary.registerBuilder("IndexContent",ContentIndexingProducerNodeBuilder.class);
  60     aBuilderLibrary.registerBuilder("UnIndexContent",ContentUnIndexingProducerNodeBuilder.class);
  61     aBuilderLibrary.registerBuilder("PDFPreFormat", PDFPreFormattingProducerNodeBuilder.class);
  62     aBuilderLibrary.registerBuilder("PDFGenerate", PDFGeneratingProducerNodeBuilder.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, XMLReader.XMLReaderExc {
  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   private final static String   INDEXER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
  89   private final static String   INDEXER_INDEX_ATTRIBUTE = "pathToIndex";
  90   private final static String[] INDEXER_REQUIRED_ATTRIBUTES = { INDEXER_KEY_ATTRIBUTE, INDEXER_INDEX_ATTRIBUTE };
  91   private final static String[] INDEXER_OPTIONAL_ATTRIBUTES = {};
  92   private final static String[] INDEXER_SUBNODES = {};
  93
  94   public static class ContentIndexingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
  95
  96     private String key;
  97     private String pathToIndex;
  98
  99     public ContentIndexingProducerNodeBuilder() {
 100       super(INDEXER_SUBNODES);
 101     }
 102
 103     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLReader.XMLReaderExc {
 104       XMLReaderTool.checkAttributes(anAttributes, INDEXER_REQUIRED_ATTRIBUTES, INDEXER_OPTIONAL_ATTRIBUTES);
 105
 106       key = (String) anAttributes.get(INDEXER_KEY_ATTRIBUTE);
 107       pathToIndex = (String) anAttributes.get(INDEXER_INDEX_ATTRIBUTE);
 108     };
 109
 110     public ProducerNode constructNode() {
 111       return new IndexingProducerNode(key,pathToIndex);
 112     };
 113   }
 114
 115   private final static String   UNINDEXER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 116   private final static String   UNINDEXER_INDEX_ATTRIBUTE = "pathToIndex";
 117   private final static String[] UNINDEXER_REQUIRED_ATTRIBUTES = { UNINDEXER_KEY_ATTRIBUTE, UNINDEXER_INDEX_ATTRIBUTE };
 118   private final static String[] UNINDEXER_OPTIONAL_ATTRIBUTES = {};
 119   private final static String[] UNINDEXER_SUBNODES = {};
 120
 121   public static class ContentUnIndexingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 122
 123     private String key;
 124     private String pathToIndex;
 125
 126     public ContentUnIndexingProducerNodeBuilder() {
 127       super(UNINDEXER_SUBNODES);
 128     }
 129
 130     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLReader.XMLReaderExc {
 131       XMLReaderTool.checkAttributes(anAttributes, UNINDEXER_REQUIRED_ATTRIBUTES, UNINDEXER_OPTIONAL_ATTRIBUTES);
 132
 133       key = (String) anAttributes.get(UNINDEXER_KEY_ATTRIBUTE);
 134       pathToIndex = (String) anAttributes.get(UNINDEXER_INDEX_ATTRIBUTE);
 135     };
 136
 137     public ProducerNode constructNode() {
 138       return new UnIndexingProducerNode(key,pathToIndex);
 139     };
 140   }
 141
 142   private final static String   CONTENT_MODIFIER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 143   private final static String   CONTENT_MODIFIER_FIELD_ATTRIBUTE = "field";
 144   private final static String   CONTENT_MODIFIER_VALUE_ATTRIBUTE = "value";
 145   private final static String[] CONTENT_MODIFIER_REQUIRED_ATTRIBUTES = { CONTENT_MODIFIER_KEY_ATTRIBUTE, CONTENT_MODIFIER_FIELD_ATTRIBUTE, CONTENT_MODIFIER_VALUE_ATTRIBUTE };
 146   private final static String[] CONTENT_MODIFIER_OPTIONAL_ATTRIBUTES = {};
 147   private final static String[] CONTENT_MODIFIER_SUBNODES = {};
 148
 149   public static class ContentModifyingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 150
 151     private String key;
 152     private String field;
 153     private String value;
 154
 155     public ContentModifyingProducerNodeBuilder() {
 156       super(CONTENT_MODIFIER_SUBNODES);
 157     }
 158
 159     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLReader.XMLReaderExc {
 160       XMLReaderTool.checkAttributes(anAttributes, CONTENT_MODIFIER_REQUIRED_ATTRIBUTES, CONTENT_MODIFIER_OPTIONAL_ATTRIBUTES);
 161
 162       key = (String) anAttributes.get(CONTENT_MODIFIER_KEY_ATTRIBUTE);
 163       field = (String) anAttributes.get(CONTENT_MODIFIER_FIELD_ATTRIBUTE);
 164       value = (String) anAttributes.get(CONTENT_MODIFIER_VALUE_ATTRIBUTE);
 165     };
 166
 167     public ProducerNode constructNode() {
 168       return new ContentModifyingProducerNode(key, field, value);
 169     };
 170   }
 171
 172   private final static String   MEDIA_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 173   private final static String[] MEDIA_REQUIRED_ATTRIBUTES = { MEDIA_KEY_ATTRIBUTE };
 174   private final static String[] MEDIA_OPTIONAL_ATTRIBUTES = {};
 175   private final static String[] MEDIA_SUBNODES = {};
 176
 177   public static class MediaGeneratingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 178
 179     private String key;
 180
 181     public MediaGeneratingProducerNodeBuilder() {
 182       super(MEDIA_SUBNODES);
 183     }
 184
 185     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLReader.XMLReaderExc {
 186       XMLReaderTool.checkAttributes(anAttributes, MEDIA_REQUIRED_ATTRIBUTES, MEDIA_OPTIONAL_ATTRIBUTES);
 187
 188       key = (String) anAttributes.get(MEDIA_KEY_ATTRIBUTE);
 189     };
 190
 191     public ProducerNode constructNode() {
 192       return new MediaGeneratingProducerNode(key);
 193     };
 194   }
 195
 196   public static class PDFPreFormattingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 197     private final static String   MARKER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 198     private final static String   PDF_NUM_LINES_ATTRIBUTE = "numLinesBetweenImages";
 199     private final static String   PDF_CONTENT_WIDTH_ATTRIBUTE = "contentAreaWidthCM";
 200     private final static String   PDF_CHAR_WIDTH_ATTRIBUTE = "charWidthCM";
 201     private final static String   PDF_PIXEL_WIDTH_ATTRIBUTE = "pixelWidthCM";
 202     private final static String   PDF_LINE_HEIGHT_ATTRIBUTE = "lineHeightCM";
 203     private final static String[] MARKER_REQUIRED_ATTRIBUTES = { MARKER_KEY_ATTRIBUTE, PDF_NUM_LINES_ATTRIBUTE, PDF_CONTENT_WIDTH_ATTRIBUTE,PDF_CHAR_WIDTH_ATTRIBUTE,PDF_PIXEL_WIDTH_ATTRIBUTE,PDF_LINE_HEIGHT_ATTRIBUTE };
 204     private final static String[] MARKER_OPTIONAL_ATTRIBUTES = {};
 205     private final static String[] MARKER_SUBNODES = {};
 206
 207     private String key;
 208     private String numLinesBetweenImages;
 209     private String contentAreaWidthCM;
 210     private String characterWidthCM;
 211     private String pixelWidthCM;
 212     private String lineHeightCM;
 213
 214     public PDFPreFormattingProducerNodeBuilder() {
 215       super(MARKER_SUBNODES);
 216     }
 217
 218     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLReader.XMLReaderExc {
 219       XMLReaderTool.checkAttributes(anAttributes, MARKER_REQUIRED_ATTRIBUTES, MARKER_OPTIONAL_ATTRIBUTES);
 220
 221       key = (String) anAttributes.get(MARKER_KEY_ATTRIBUTE);
 222       numLinesBetweenImages = (String) anAttributes.get(PDF_NUM_LINES_ATTRIBUTE);
 223       contentAreaWidthCM = (String) anAttributes.get(PDF_CONTENT_WIDTH_ATTRIBUTE);
 224       characterWidthCM = (String) anAttributes.get(PDF_CHAR_WIDTH_ATTRIBUTE);
 225       pixelWidthCM   = (String) anAttributes.get(PDF_PIXEL_WIDTH_ATTRIBUTE);
 226       lineHeightCM = (String) anAttributes.get(PDF_LINE_HEIGHT_ATTRIBUTE);
 227
 228
 229     };
 230
 231     public ProducerNode constructNode() {
 232       return new PDFPreFormattingProducerNode(key,numLinesBetweenImages,contentAreaWidthCM,characterWidthCM,pixelWidthCM,lineHeightCM);
 233     };
 234   }
 235
 236   public static class PDFGeneratingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
 237     private final static String   MARKER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
 238     private final static String   PDF_GENERATOR_ATTRIBUTE = "generator";
 239     private final static String   PDF_DESTINATION_ATTRIBUTE = "destination";
 240     private final static String   PDF_STYLESHEET_ATTRIBUTE = "stylesheet";
 241     private final static String[] MARKER_REQUIRED_ATTRIBUTES = {PDF_GENERATOR_ATTRIBUTE,PDF_DESTINATION_ATTRIBUTE,PDF_STYLESHEET_ATTRIBUTE  };
 242     private final static String[] MARKER_OPTIONAL_ATTRIBUTES = {};
 243     private final static String[] MARKER_SUBNODES = {};
 244
 245     private String generator;
 246     private String destination;
 247     private String stylesheet;
 248
 249
 250     public PDFGeneratingProducerNodeBuilder() {
 251       super(MARKER_SUBNODES);
 252     }
 253
 254     public void setAttributes(Map anAttributes) throws ProducerConfigExc, XMLReader.XMLReaderExc {
 255       XMLReaderTool.checkAttributes(anAttributes, MARKER_REQUIRED_ATTRIBUTES, MARKER_OPTIONAL_ATTRIBUTES);
 256
 257       generator = (String) anAttributes.get(PDF_GENERATOR_ATTRIBUTE);
 258       destination = (String) anAttributes.get(PDF_DESTINATION_ATTRIBUTE);
 259       stylesheet = (String) anAttributes.get(PDF_STYLESHEET_ATTRIBUTE);
 260     };
 261
 262     public ProducerNode constructNode() {
 263       return new PDFGeneratingProducerNode(generator,destination,stylesheet);
 264     };
 265   }
 266 }
 267
 268