001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 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:
065: package com.jcorporate.expresso.kernel;
066:
067: import java.util.Collections;
068: import java.util.HashMap;
069: import java.util.Map;
070:
071: /**
072: * Installation is a combination metadata and installation flags for
073: * a particular component. Typical Usage Inside a Component:
074: * <p/>
075: * Creating an Installation Options:
076: * </p><p>
077: * <code><pre>
078: * InstallationOptions returnOptions = new InstallationOptions();
079: * InstallationMetadata newMetadata = returnOptions.createNewMetadata();
080: * newMetadata.setName("Test");
081: * newMetadata.setDefaultValue(Boolean.TRUE);
082: * newMetadata.setType("java.lang.Boolean");
083: * returnOptions.addMetaData(newMetadata);
084: * return returnOptions;
085: * </code></pre></p>
086: * <p/>
087: * Using Installation Options:
088: * </p><p>
089: * <code><pre>
090: * //In the installation section
091: * Boolean deleteTables = installOptions.getInstallOption("Test");
092: * if (deleteTables.booleanValue()) {
093: * //Do some stuff
094: * }
095: * </code</pre>
096: * </p>
097: *
098: * @author Michael Rimov
099: */
100:
101: public class InstallationOptions {
102:
103: /**
104: * All the installation values keyed by the metadata
105: */
106: protected Map installValues = new HashMap();
107:
108: /**
109: * A map for mapping names to metdata
110: */
111: protected Map nameMetadataMap = new HashMap();
112:
113: public InstallationOptions() {
114:
115: }
116:
117: /**
118: * Kind of a factory method. Instantiates a new metadata object
119: *
120: * @return
121: */
122: public InstallationMetadata createNewMetadata(String name,
123: Object defaultValue) {
124: InstallationMetadata metadata = new InstallationMetadata();
125: metadata.setName(name);
126: metadata.setDefaultValue(defaultValue);
127: metadata.setDescription(name);
128: return metadata;
129: }
130:
131: /**
132: * Called by the <code>Installable</code> implementation to add a filled out
133: * metadata object to the Install Options
134: *
135: * @param metadata the Created and populated metadata
136: */
137: public void addMetaData(InstallationMetadata metadata) {
138: installValues.put(metadata, null);
139: nameMetadataMap.put(metadata.getName(), metadata);
140: }
141:
142: /**
143: * Sets the given install option by name
144: *
145: * @param name the name of the installation object
146: * @param newValue the value to set it to.
147: */
148: public void setInstallOption(String name, Object newValue) {
149: InstallationMetadata metadata = (InstallationMetadata) nameMetadataMap
150: .get(name);
151: if (metadata == null) {
152: throw new IllegalArgumentException(
153: "Invalid Install Option Name: " + name);
154: }
155:
156: installValues.put(metadata, newValue);
157: }
158:
159: /**
160: * Retrieves the installation option keyed by name. If the value was never
161: * set then the system returns the default value as defined by the metadata.
162: *
163: * @param name the name of the install option
164: * @return java.lang.Object
165: */
166: public Object getInstallOption(String name) {
167: InstallationMetadata metadata = (InstallationMetadata) nameMetadataMap
168: .get(name);
169: if (metadata == null) {
170: throw new IllegalArgumentException(
171: "Invalid Install Option Name: " + name);
172: }
173:
174: Object returnValue = installValues.get(metadata);
175:
176: if (returnValue == null) {
177: returnValue = metadata.getDefaultValue();
178: }
179:
180: return returnValue;
181: }
182:
183: public Map getAllInstallValues() {
184: return Collections.unmodifiableMap(installValues);
185: }
186:
187: public java.util.Set getAllInstallNames() {
188: return nameMetadataMap.keySet();
189: }
190:
191: /**
192: * This class provides metadata about any options available.
193: */
194: public class InstallationMetadata {
195:
196: public InstallationMetadata() {
197:
198: }
199:
200: /**
201: * The default value for this particular setting
202: */
203: private Object defaultValue;
204:
205: /**
206: * Description for the setting
207: */
208: private String description;
209:
210: /**
211: * Type of object the setting is
212: */
213: private String type = null;
214:
215: /**
216: * The name of the metadata
217: */
218: private String name;
219:
220: public Object getDefaultValue() {
221: return defaultValue;
222: }
223:
224: public void setDefaultValue(Object newValue) {
225: defaultValue = newValue;
226:
227: //
228: //Automatically set the type if we haven't got any yet.
229: //
230: if (type == null) {
231: type = newValue.getClass().getName();
232: }
233: }
234:
235: public void setDescription(String newValue) {
236: description = newValue;
237: }
238:
239: public String getDescription() {
240: return description;
241: }
242:
243: public void setType(String newValue) {
244: type = newValue;
245: }
246:
247: public String getType() {
248: return type;
249: }
250:
251: public void setName(String newValue) {
252: name = newValue;
253: }
254:
255: public String getName() {
256: return name;
257: }
258:
259: /**
260: * Override of normal hashcode. Here we generate the hashcode
261: * off of the name only. [Since that's unique]
262: *
263: * @return integer
264: */
265: public int hashCode() {
266: return name.hashCode();
267: }
268: }
269: }
|