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