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;
065:
066: import com.jcorporate.expresso.kernel.metadata.ComponentMetadata;
067:
068: import java.net.URL;
069:
070: /**
071: * This class provides a convienience base class for the majority of the ExpressoComponent
072: * interfaces. Derive from this class if you wish to create a component that is not
073: * a component container.
074: * <p>If you derive from this class, the class expresso runtime system automatically
075: * looks in the same package as the component's class name. And looks for an xml file
076: * with the same class as your derived component. </p>
077: *
078: * @author Michael Rimov
079: */
080: abstract public class ComponentBase implements ExpressoComponent,
081: Describable {
082:
083: /**
084: * The parent Container
085: */
086: private Containable parent = null;
087:
088: /**
089: * The metadata for the component.
090: */
091: private ComponentMetadata metadata = null;
092:
093: /**
094: * Default do nothing constructor
095: */
096: public ComponentBase() {
097: }
098:
099: /**
100: * Constructor that takes the parent container as the argument
101: *
102: * @param parent The parent container
103: */
104: public ComponentBase(Containable parent) {
105: this .parent = parent;
106: }
107:
108: /**
109: * Retrieve the metadata for the component
110: *
111: * @return ComponentMetadata
112: */
113: public synchronized ComponentMetadata getMetaData() {
114: return metadata;
115: }
116:
117: /**
118: * Retrieve reference to the component container
119: *
120: * @return the Container reference
121: */
122: public synchronized Containable getParent() {
123: return parent;
124: }
125:
126: /**
127: * Set the component container reference
128: *
129: * @param parent the parent container
130: */
131: public synchronized void setParent(Containable parent) {
132: this .parent = parent;
133: }
134:
135: /**
136: * Allows the metadata to be set by the system factory.
137: *
138: * @param metadata the Metadata for this particular component.
139: */
140: public synchronized void setMetaData(ComponentMetadata metadata) {
141: this .metadata = metadata;
142: }
143:
144: /**
145: * Return the metadata of this class. This implementation looks for
146: * an xml file by the same name as the component class itself and in the same
147: * package location as the original class.
148: *
149: * @return URL of the metadata location
150: */
151: public synchronized URL getMetadataLocation() {
152: String className = this .getClass().getName();
153: int spliceLoc = className.lastIndexOf(".");
154: className = className.substring(spliceLoc + 1);
155: return this .getClass().getResource(className + ".xml");
156: }
157:
158: }
|