KickJava   Java API By Example, From Geeks To Geeks.

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


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
70 /**
71  * Class that represents a parsed property from the expresso-services.xml
72  * file
73  *
74  * @author Michael Rimov
75  * @version $Revision: 1.6 $ on $Date: 2004/11/17 20:48:17 $
76  */
77
78 abstract public class Property {
79
80     private String JavaDoc name;
81     private String JavaDoc type;
82     private String JavaDoc access;
83     private String JavaDoc description;
84
85     /**
86      * Default constructor
87      */
88     public Property() {
89     }
90
91     /**
92      * Retrieve the name of the property
93      *
94      * @return java.lang.String
95      */
96     public String JavaDoc getName() {
97         return name;
98     }
99
100     /**
101      * Set the name of the property
102      *
103      * @param name the name of the property
104      */
105     public void setName(String JavaDoc name) {
106         this.name = name;
107     }
108
109     /**
110      * Sets the type of the property
111      *
112      * @param type the Java type of this property. Example: java.lang.String
113      */
114     public void setType(String JavaDoc type) {
115         this.type = type;
116     }
117
118     /**
119      * Retrieve the java type of this property
120      *
121      * @return java.lang.String the class name type for this property
122      */
123     public String JavaDoc getType() {
124         return type;
125     }
126
127     /**
128      * Set the access of this property. (Read|Write|ReadWrite)
129      *
130      * @param access the Access of this property
131      */
132     public void setAccess(String JavaDoc access) {
133         this.access = access;
134     }
135
136     /**
137      * Retrieve the access of this property
138      *
139      * @return java.lang.String
140      */
141     public String JavaDoc getAccess() {
142         return access;
143     }
144
145     /**
146      * Set a description of this property
147      *
148      * @param description the friendly description of this property.
149      */
150     public void setDescription(String JavaDoc description) {
151         this.description = description;
152     }
153
154     /**
155      * Retrieve the description for this property. This description will be
156      * used in Management programs to describe the property to the user.
157      *
158      * @return java.lang.String
159      */
160     public String JavaDoc getDescription() {
161         return description;
162     }
163
164     /**
165      * Override in subclasses. Load the configBean with values for this property.
166      * If there are any values present in the ComponentConfig, then use those properties,
167      * if empty, use your own default values as specified in the ComponentMetadata
168      *
169      * @param configBean The configBean to populate with this property.
170      * @param config the current configuration as loaded from the expresso config.xml file
171      * @param metadata the current metadata for this component
172      * @return the Configuration interface (actually uslaly the configbean parameter)
173      */
174     abstract public Configuration createConfigBean(DefaultConfigBean configBean,
175                                                    ComponentConfig config, ComponentMetadata metadata)
176             ;
177 }
Popular Tags