some javadoc additions some early work on the new producer node to report changes...
[mir.git] / source / mir / producer / reader / ProducerNodeBuilderLibrary.java
1 /*
2  * Copyright (C) 2001-2006 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  * and distribute linked combinations including the two.  You must obey the
23  * GNU General Public License in all respects for all of the code used other than
24  * the above mentioned libraries.  If you modify this file, you may extend this
25  * exception to your version of the file, but you are not obligated to do so.
26  * If you do not wish to do so, delete this exception statement from your version.
27  */
28 package mir.producer.reader;
29
30 import java.util.HashMap;
31 import java.util.Map;
32
33 public class ProducerNodeBuilderLibrary {
34   private Map nodeBuilders;
35
36   public ProducerNodeBuilderLibrary() {
37     nodeBuilders = new HashMap();
38   }
39
40   /**
41    * Register a builder
42    * @param aName
43    * @param aProducerNodeBuilderClass
44    * @throws ProducerConfigExc
45    * @throws ProducerConfigFailure
46    */
47   public void registerBuilder(String aName, Class aProducerNodeBuilderClass) throws ProducerConfigExc, ProducerConfigFailure {
48     try {
49       registerFactory(aName, new ProducerNodeBuilder.DefaultProducerNodeBuilderFactory( aProducerNodeBuilderClass ));
50     }
51     catch (Throwable t) {
52       throw new ProducerConfigFailure("Error while registering builder '"+aName+"': "+t.getMessage(), t);
53     }
54   }
55
56   /**
57    * Register a  {@link ProducerNodeBuilder.ProducerNodeBuilderFactory} for {@link mir.producer.ProducerNode}s
58    * @param aTag the tag to bind this factory to: every producers.xml tag with the name <code>aTag</code>
59    *     will be directed to this factory.
60    *
61    * @param aFactory the factory to bind the tag to.
62    */
63   public void registerFactory(String aTag, ProducerNodeBuilder.ProducerNodeBuilderFactory aFactory) {
64     nodeBuilders.put(aTag, aFactory);
65   }
66
67   public boolean hasBuilderForName(String aName) {
68     return nodeBuilders.containsKey(aName);
69   }
70
71   public ProducerNodeBuilder constructBuilder(String aName) throws ProducerConfigExc {
72     if (hasBuilderForName(aName))
73       return ((ProducerNodeBuilder.ProducerNodeBuilderFactory) nodeBuilders.get(aName)).makeBuilder();
74                 throw new ProducerConfigExc("ProducerNodeBuilder: no builder with name '" + aName + "' found.");
75   }
76 }