KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > kernel > ComponentBase


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;
65
66 import com.jcorporate.expresso.kernel.metadata.ComponentMetadata;
67
68 import java.net.URL JavaDoc;
69
70 /**
71  * This class provides a convienience base class for the majority of the ExpressoComponent
72  * interfaces. Derive from this class if you wish to create a component that is not
73  * a component container.
74  * <p>If you derive from this class, the class expresso runtime system automatically
75  * looks in the same package as the component's class name. And looks for an xml file
76  * with the same class as your derived component. </p>
77  *
78  * @author Michael Rimov
79  */
80 abstract public class ComponentBase implements ExpressoComponent, Describable {
81
82     /**
83      * The parent Container
84      */
85     private Containable parent = null;
86
87     /**
88      * The metadata for the component.
89      */
90     private ComponentMetadata metadata = null;
91
92
93     /**
94      * Default do nothing constructor
95      */
96     public ComponentBase() {
97     }
98
99     /**
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 JavaDoc getMetadataLocation() {
152         String JavaDoc 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 }
Popular Tags