KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > myvietnam > mvncore > configuration > BaseConfigurationXMLReader


1 package net.myvietnam.mvncore.configuration;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if
22  * any, must include the following acknowledgement:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgement may appear in the software itself,
26  * if and wherever such third-party acknowledgements normally appear.
27  *
28  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
29  * Foundation" must not be used to endorse or promote products derived
30  * from this software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * nor may "Apache" appear in their names without prior written
35  * permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import java.io.IOException JavaDoc;
58
59 import org.xml.sax.SAXException JavaDoc;
60
61 /**
62  * <p>A specialized SAX2 XML parser that processes configuration objects.</p>
63  * <p>This class mimics to be a SAX compliant XML parser. It is able to iterate
64  * over the keys in a configuration object and to generate corresponding SAX
65  * events. By registering a <code>ContentHandler</code> at an instance
66  * it is possible to perform XML processing on a configuration object.</p>
67  *
68  * @author <a HREF="mailto:oliver.heger@t-online.de">Oliver Heger</a>
69  * @version $Id: BaseConfigurationXMLReader.java,v 1.1 2003/12/09 08:25:30 huumai Exp $
70  */
71 public class BaseConfigurationXMLReader extends ConfigurationXMLReader
72 {
73     /** Stores the actual configuration.*/
74     private Configuration config;
75
76     /**
77      * Creates a new instance of <code>BaseConfigurationXMLReader</code>.
78      */
79     public BaseConfigurationXMLReader()
80     {
81         super();
82     }
83
84     /**
85      * Creates a new instance of <code>BaseConfigurationXMLReader</code> and
86      * sets the configuration object to be parsed.
87      * @param conf the configuration to be parsed
88      */
89     public BaseConfigurationXMLReader(Configuration conf)
90     {
91         this();
92         setConfiguration(conf);
93     }
94
95     /**
96      * Returns the actual configuration to be processed.
97      * @return the actual configuration
98      */
99     public Configuration getConfiguration()
100     {
101         return config;
102     }
103
104     /**
105      * Sets the configuration to be processed.
106      * @param conf the configuration
107      */
108     public void setConfiguration(Configuration conf)
109     {
110         config = conf;
111     }
112
113     /**
114      * Returns the configuration to be processed.
115      * @return the actual configuration
116      */
117     public Configuration getParsedConfiguration()
118     {
119         return getConfiguration();
120     }
121
122     /**
123      * The main SAX event generation method. This element uses an internal
124      * <code>HierarchicalConfigurationConverter</code> object to iterate over
125      * all keys in the actual configuration and to generate corresponding SAX
126      * events.
127      * @throws IOException if no configuration object is specified
128      * @throws SAXException if a SAXException occurs during parsing
129      */
130     protected void processKeys() throws IOException JavaDoc, SAXException JavaDoc
131     {
132         fireElementStart(getRootName(), null);
133         new SAXConverter().process(getConfiguration());
134         fireElementEnd(getRootName());
135     }
136
137     /**
138      * An internally used helper class to iterate over all configuration keys
139      * ant to generate corresponding SAX events.
140      *
141      * @author <a HREF="mailto:oliver.heger@t-online.de">Oliver Heger</a>
142      */
143     class SAXConverter extends HierarchicalConfigurationConverter
144     {
145         /**
146          * Callback for the start of an element.
147          * @param name the element name
148          * @param value the element value
149          */
150         protected void elementStart(String JavaDoc name, Object JavaDoc value)
151         {
152             fireElementStart(name, null);
153             if(value != null)
154             {
155                 fireCharacters(value.toString());
156             } /* if */
157         }
158
159         /**
160          * Callback for the end of an element.
161          * @param name the element name
162          */
163         protected void elementEnd(String JavaDoc name)
164         {
165             fireElementEnd(name);
166         }
167     }
168 }
169
Popular Tags