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