KickJava   Java API By Example, From Geeks To Geeks.

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


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.core.dbobj.ValidValue;
67 import com.jcorporate.expresso.kernel.Configuration;
68 import com.jcorporate.expresso.kernel.digester.ComponentConfig;
69 import com.jcorporate.expresso.kernel.internal.DefaultConfigBean;
70 import com.jcorporate.expresso.kernel.util.ClassLocator;
71 import org.apache.commons.beanutils.ConvertUtils;
72 import org.apache.log4j.Logger;
73
74 import java.util.ArrayList JavaDoc;
75 import java.util.List JavaDoc;
76
77 /**
78  * Metadata class that represents a simple property for an Expresso component
79  *
80  * @author Michael Rimov
81  * @version $Revision: 1.6 $ on $Date: 2004/11/17 20:48:17 $
82  */
83
84 public class SimpleProperty extends Property {
85     List JavaDoc validValues;
86     String JavaDoc value;
87
88     /**
89      * Default Constructor
90      */
91     public SimpleProperty() {
92         super();
93         validValues = new ArrayList JavaDoc();
94     }
95
96     /**
97      * Set the value of the property
98      *
99      * @param value java.lang.String
100      */
101     public void setValue(String JavaDoc value) {
102         this.value = value;
103     }
104
105     /**
106      * Retrieve the value of the property
107      *
108      * @return java.lang.String
109      */
110     public String JavaDoc getValue() {
111         return value;
112     }
113
114     /**
115      * Add a valid value for the property
116      *
117      * @param key the 'key' or internal value
118      * @param value the friendly value to be displayed in management systems.
119      */
120     public void addValidValue(String JavaDoc key, String JavaDoc value) {
121         ValidValue vv = new ValidValue(key, value);
122         validValues.add(vv);
123     }
124
125     /**
126      * Retrieve a list of valid values for this particular property.
127      *
128      * @return List of valid value objects
129      */
130     public List JavaDoc retrieveValidValues() {
131         return validValues;
132     }
133
134     /**
135      * Load the configBean with values for this property.
136      * If there are any values present in the ComponentConfig, then use those properties,
137      * if empty, use your own default values as specified in the ComponentMetadata
138      *
139      * @param targetBean The configBean to populate with this property.
140      * @param config the current configuration as loaded from the expresso config.xml file
141      * @param metadata the current metadata for this component
142      * @return the Configuration interface (actually uslaly the configbean parameter)
143      */
144     public Configuration createConfigBean(DefaultConfigBean targetBean,
145                                           ComponentConfig config,
146                                           ComponentMetadata metadata) {
147         String JavaDoc newValue = config.getProperty(this.getName());
148         if (newValue == null || newValue.length() == 0) {
149             newValue = this.getValue();
150         }
151
152         String JavaDoc type = this.getType();
153
154         try {
155             targetBean.set(this.getName(), ConvertUtils.convert(newValue, ClassLocator.loadClass(type)));
156         } catch (ClassNotFoundException JavaDoc ex) {
157             Logger log = Logger.getLogger(this.getClass());
158             log.error("Error converting value " + value
159                     + " to class : " + type + " class not found.", ex);
160             throw new IllegalArgumentException JavaDoc("Class not found: " + type);
161         }
162
163         return targetBean;
164     }
165
166 }
Popular Tags