Mir goes GPL
[mir.git] / 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) {
45     aBuilderLibrary.registerBuilder("ModifyContent", ContentModifyingProducerNodeBuilder.class);
46     aBuilderLibrary.registerBuilder("MarkContent", ContentMartkingProducerNodeBuilder.class);
47   }
48
49   public static class ContentMartkingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
50     private final static String   MARKER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
51     private final static String[] MARKER_REQUIRED_ATTRIBUTES = { MARKER_KEY_ATTRIBUTE };
52     private final static String[] MARKER_OPTIONAL_ATTRIBUTES = {};
53     private final static String[] MARKER_SUBNODES = {};
54
55     private String key;
56
57     public ContentMartkingProducerNodeBuilder() {
58       super(MARKER_SUBNODES);
59     }
60
61     public void setAttributes(Map anAttributes) throws ProducerConfigExc {
62       ReaderTool.checkAttributes(anAttributes, MARKER_REQUIRED_ATTRIBUTES, MARKER_OPTIONAL_ATTRIBUTES);
63
64       key = (String) anAttributes.get(MARKER_KEY_ATTRIBUTE);
65     };
66
67     public ProducerNode constructNode() {
68       return new ContentMarkingProducerNode(key);
69     };
70   }
71
72
73   public static class ContentModifyingProducerNodeBuilder extends DefaultProducerNodeBuilders.AbstractProducerNodeBuilder {
74     private final static String   MODIFYER_KEY_ATTRIBUTE = DefaultProducerNodeBuilders.KEY_ATTRIBUTE;
75     private final static String   MODIFYER_FIELD_ATTRIBUTE = "field";
76     private final static String   MODIFYER_VALUE_ATTRIBUTE = "value";
77     private final static String[] MODIFYER_REQUIRED_ATTRIBUTES = { MODIFYER_KEY_ATTRIBUTE, MODIFYER_FIELD_ATTRIBUTE, MODIFYER_VALUE_ATTRIBUTE };
78     private final static String[] MODIFYER_OPTIONAL_ATTRIBUTES = {};
79     private final static String[] MODIFYER_SUBNODES = {};
80
81     private String key;
82     private String field;
83     private String value;
84
85     public ContentModifyingProducerNodeBuilder() {
86       super(MODIFYER_SUBNODES);
87     }
88
89     public void setAttributes(Map anAttributes) throws ProducerConfigExc {
90       ReaderTool.checkAttributes(anAttributes, MODIFYER_REQUIRED_ATTRIBUTES, MODIFYER_OPTIONAL_ATTRIBUTES);
91
92       key = (String) anAttributes.get(MODIFYER_KEY_ATTRIBUTE);
93       field = (String) anAttributes.get(MODIFYER_FIELD_ATTRIBUTE);
94       value = (String) anAttributes.get(MODIFYER_VALUE_ATTRIBUTE);
95     };
96
97     public ProducerNode constructNode() {
98       return new ContentModifyingProducerNode(key, field, value);
99     };
100   }
101
102
103 /*
104   TODO:
105         [ ] Media Producing
106 */
107
108 }