KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Bean describing an indexed property. Note because of the potential
79  * weirdness of receiving indexed values, this class simply implements the
80  * index as a key in a TreeMap so that we can retrieve all the values in
81  * order
82  *
83  * @author Michael Rimov
84  * @version $Revision: 1.6 $ on $Date: 2004/11/17 20:48:17 $
85  */
86
87 public class IndexedProperty extends Property {
88     Map JavaDoc values;
89
90     /**
91      * Default Constructor
92      */
93     public IndexedProperty() {
94         super();
95         values = new TreeMap JavaDoc();
96     }
97
98     /**
99      * Set an indexed value
100      *
101      * @param index the index of the property
102      * @param value the value to set for that index
103      */
104     public void setIndexedValue(int index, String JavaDoc value) {
105         if (index < 0) {
106             throw new IllegalArgumentException JavaDoc("index must be >= 0");
107         }
108
109         values.put(new Integer JavaDoc(index), value);
110     }
111
112     /**
113      * Retrieve a map of all indicies and their corresponding values for this
114      * property
115      *
116      * @return java.util.Map
117      */
118     public Map JavaDoc getValues() {
119         return values;
120     }
121
122     /**
123      * Retrieve a value at a certain index
124      *
125      * @param index the index to retrieve the value for
126      * @return java.lang.String
127      */
128     public String JavaDoc getIndexedValue(int index) {
129         if (index < 0) {
130             throw new IllegalArgumentException JavaDoc("index must be >= 0");
131         }
132
133         return (String JavaDoc) values.get(new Integer JavaDoc(index));
134     }
135
136     /**
137      * Load the configBean with values for this property.
138      * If there are any values present in the ComponentConfig, then use those properties,
139      * if empty, use your own default values as specified in the ComponentMetadata
140      *
141      * @param targetBean The configBean to populate with this property.
142      * @param config the current configuration as loaded from the expresso config.xml file
143      * @param metadata the current metadata for this component
144      * @return the Configuration interface (actually uslaly the configbean parameter)
145      */
146     public Configuration createConfigBean(DefaultConfigBean targetBean,
147                                           ComponentConfig config,
148                                           ComponentMetadata metadata) {
149         Map JavaDoc parsedProperties = config.getIndexedProperties(this.getName());
150         if (parsedProperties == null) {
151             //
152 //Fill all the default values we have from the metadata instead since
153 //no config data exists
154 //
155 for (Iterator JavaDoc i = values.keySet().iterator(); i.hasNext();) {
156                 Integer JavaDoc index = (Integer JavaDoc) i.next();
157                 String JavaDoc value = (String JavaDoc) values.get(index);
158                 String JavaDoc type = this.getType();
159                 try {
160                     targetBean.set(this.getName(), ConvertUtils.convert(value, ClassLocator.loadClass(type)));
161                 } catch (ClassNotFoundException JavaDoc ex) {
162                     Logger log = Logger.getLogger(this.getClass());
163                     log.error("Error converting value " + value
164                             + " to class : " + type + " class not found.", ex);
165                     throw new IllegalArgumentException JavaDoc("Class not found: " + type);
166                 }
167             }
168
169             return targetBean;
170         }
171
172         for (Iterator JavaDoc i = parsedProperties.keySet().iterator(); i.hasNext();) {
173             Integer JavaDoc index = (Integer JavaDoc) i.next();
174             String JavaDoc value = config.getIndexedProperty(this.getName(), index.intValue());
175
176             if (value == null || value.length() == 0) {
177                 value = this.getIndexedValue(index.intValue());
178             }
179             String JavaDoc type = this.getType();
180             try {
181                 targetBean.set(this.getName(), index.intValue(),
182                         ConvertUtils.convert(value, ClassLocator.loadClass(type)));
183             } catch (ClassNotFoundException JavaDoc ex) {
184                 Logger log = Logger.getLogger(this.getClass());
185                 log.error("Error converting value " + value
186                         + " to class : " + type + " class not found.", ex);
187                 throw new IllegalArgumentException JavaDoc("Class not found: " + type);
188             }
189         }
190
191         //
192 //Now, finally, check for any indicies that ARE NOT in the config file,
193 //but ARE in metadata
194 //
195 for (Iterator JavaDoc i = values.keySet().iterator(); i.hasNext();) {
196             Integer JavaDoc index = (Integer JavaDoc) i.next();
197
198             if (!config.getIndexedProperties(this.getName()).containsKey(index)) {
199                 String JavaDoc value = (String JavaDoc) values.get(index);
200                 String JavaDoc type = this.getType();
201                 try {
202                     targetBean.set(this.getName(), ConvertUtils.convert(value, ClassLocator.loadClass(type)));
203                 } catch (ClassNotFoundException JavaDoc ex) {
204                     Logger log = Logger.getLogger(this.getClass());
205                     log.error("Error converting value " + value
206                             + " to class : " + type + " class not found.", ex);
207                     throw new IllegalArgumentException JavaDoc("Class not found: " + type);
208                 }
209             }
210         }
211         return targetBean;
212     }
213 }
Popular Tags