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