001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064: package com.jcorporate.expresso.kernel.metadata;
065:
066: import com.jcorporate.expresso.kernel.Configuration;
067: import com.jcorporate.expresso.kernel.digester.ComponentConfig;
068: import com.jcorporate.expresso.kernel.internal.DefaultConfigBean;
069:
070: /**
071: * Class that represents a parsed property from the expresso-services.xml
072: * file
073: *
074: * @author Michael Rimov
075: * @version $Revision: 1.6 $ on $Date: 2004/11/17 20:48:17 $
076: */
077:
078: abstract public class Property {
079:
080: private String name;
081: private String type;
082: private String access;
083: private String description;
084:
085: /**
086: * Default constructor
087: */
088: public Property() {
089: }
090:
091: /**
092: * Retrieve the name of the property
093: *
094: * @return java.lang.String
095: */
096: public String getName() {
097: return name;
098: }
099:
100: /**
101: * Set the name of the property
102: *
103: * @param name the name of the property
104: */
105: public void setName(String 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 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 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 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 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 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 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(
175: DefaultConfigBean configBean, ComponentConfig config,
176: ComponentMetadata metadata);
177: }
|