KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > kernel > metadata > MappedProperty


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64 package com.jcorporate.expresso.kernel.metadata;
65
66 import com.jcorporate.expresso.kernel.Configuration;
67 import com.jcorporate.expresso.kernel.digester.ComponentConfig;
68 import com.jcorporate.expresso.kernel.internal.DefaultConfigBean;
69 import com.jcorporate.expresso.kernel.util.ClassLocator;
70 import org.apache.commons.beanutils.ConvertUtils;
71 import org.apache.log4j.Logger;
72
73 import java.util.Iterator JavaDoc;
74 import java.util.Map JavaDoc;
75 import java.util.TreeMap JavaDoc;
76
77 /**
78  * Metadata class that represents a MappedProperty
79  *
80  * @author Michael Rimov
81  * @version $Revision: 1.6 $ on $Date: 2004/11/17 20:48:17 $
82  * @since Expresso 5.1
83  */
84
85 public class MappedProperty extends Property {
86     Map JavaDoc values;
87
88     /**
89      * Default constructor
90      */
91     public MappedProperty() {
92         super();
93         values = new TreeMap JavaDoc();
94     }
95
96     /**
97      * Set the Mapped property's value
98      *
99      * @param key the key of the mapped property.
100      * @param value the value of the mapped property
101      */
102     public void setMappedValue(String JavaDoc key, String JavaDoc value) {
103         if (key == null || key.length() == 0) {
104             throw new IllegalArgumentException JavaDoc("key must be non-zero length, non null string");
105         }
106
107         values.put(key, value);
108     }
109
110     /**
111      * Retrieve the value of the mapped property.
112      *
113      * @param key the key of the mapped property
114      * @return java.lang.String
115      */
116     public String JavaDoc getMappedValue(String JavaDoc key) {
117         if (key == null || key.length() == 0) {
118             throw new IllegalArgumentException JavaDoc("key must be non-zero length, non null string");
119         }
120
121         return (String JavaDoc) values.get(key);
122     }
123
124     /**
125      * Retrieve a list of all mapped property values.
126      *
127      * @return java.util.map
128      */
129     public Map JavaDoc getValues() {
130         return values;
131     }
132
133     /**
134      * Load the configBean with values for this property.
135      * If there are any values present in the ComponentConfig, then use those properties,
136      * if empty, use your own default values as specified in the ComponentMetadata
137      *
138      * @param targetBean The configBean to populate with this property.
139      * @param config the current configuration as loaded from the expresso config.xml file
140      * @param metadata the current metadata for this component
141      * @return the Configuration interface (actually uslaly the configbean parameter)
142      */
143     public Configuration createConfigBean(DefaultConfigBean targetBean,
144                                           ComponentConfig config,
145                                           ComponentMetadata metadata) {
146         Map JavaDoc parsedProperties = config.getMappedProperties(this.getName());
147         if (parsedProperties == null) {
148             //
149 //Fill all the default values we have from the metadata instead since
150 //no config data exists
151 //
152 for (Iterator JavaDoc i = values.keySet().iterator(); i.hasNext();) {
153                 String JavaDoc key = (String JavaDoc) i.next();
154                 String JavaDoc value = (String JavaDoc) values.get(key);
155                 String JavaDoc type = this.getType();
156                 try {
157                     targetBean.set(this.getName(), ConvertUtils.convert(value, ClassLocator.loadClass(type)));
158                 } catch (ClassNotFoundException JavaDoc ex) {
159                     Logger log = Logger.getLogger(this.getClass());
160                     log.error("Error converting value " + value
161                             + " to class : " + type + " class not found.", ex);
162                     throw new IllegalArgumentException JavaDoc("Class not found: " + type);
163                 }
164             }
165
166             return targetBean;
167         }
168
169         for (Iterator JavaDoc i = parsedProperties.keySet().iterator(); i.hasNext();) {
170             String JavaDoc key = (String JavaDoc) i.next();
171             String JavaDoc value = config.getMappedProperty(this.getName(), key);
172
173             if (value == null || value.length() == 0) {
174                 value = this.getMappedValue(key);
175             }
176             String JavaDoc type = this.getType();
177             try {
178                 targetBean.set(this.getName(), key, ConvertUtils.convert(value, ClassLocator.loadClass(type)));
179             } catch (ClassNotFoundException JavaDoc ex) {
180                 Logger log = Logger.getLogger(this.getClass());
181                 log.error("Error converting value " + value
182                         + " to class : " + type + " class not found.", ex);
183                 throw new IllegalArgumentException JavaDoc("Class not found: " + type);
184             }
185         }
186
187         //
188 //Now, finally, check for any indicies that ARE NOT in the config file,
189 //but ARE in metadata
190 //
191 for (Iterator JavaDoc i = values.keySet().iterator(); i.hasNext();) {
192             String JavaDoc key = (String JavaDoc) i.next();
193
194             if (!config.getMappedProperties(this.getName()).containsKey(key)) {
195                 String JavaDoc value = (String JavaDoc) values.get(key);
196                 String JavaDoc type = this.getType();
197                 try {
198                     targetBean.set(this.getName(), ConvertUtils.convert(value, ClassLocator.loadClass(type)));
199                 } catch (ClassNotFoundException JavaDoc ex) {
200                     Logger log = Logger.getLogger(this.getClass());
201                     log.error("Error converting value " + value
202                             + " to class : " + type + " class not found.", ex);
203                     throw new IllegalArgumentException JavaDoc("Class not found: " + type);
204                 }
205             }
206         }
207         return targetBean;
208     }
209 }
Popular Tags