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: /**
067: * Containable is partially 'marker interface' much like
068: * <code>java.lang.Serialiable</code>. If a class implements Containable then
069: * the Expresso Runtime wraps it with a <code>ComponentContainer</code> interface.
070: * This way the Container implementation is fully pluggable without any of the
071: * components knowing about the implementation of their containers.
072: * <p>You use get/setContainerImplementation to get the container implementation
073: * that then allows you to navigate the heirarchy of components and component
074: * containers.
075: * </p>
076: *
077: * @author Michael Rimov
078: * @since Expresso 5.1
079: */
080:
081: public interface Containable extends ExpressoComponent {
082:
083: /**
084: * Sets the marker to the ComponentContainer (which has a 1:1 instance mapping
085: * with Containable). This is often called by the actual implementation
086: * of the ComponentContainer.
087: *
088: * @param newContainer a <code>ComponentCo
089: */
090: public void setContainerImplementation(
091: ComponentContainer newContainer);
092:
093: /**
094: * Retrieves the actual container implementation
095: *
096: * @return ComponentContainer
097: */
098: public ComponentContainer getContainerImplementation();
099:
100: /**
101: * <p>Convenience method for Container clients. Recommended
102: * Implementation:</p>
103: * <p/>
104: * <code>
105: * ExpressoComponent getComponent(String componentName) {<br />
106: * return this.getContainerImplementation().getComponent(componentName);
107: * }<br />
108: * <p/>
109: * </code>
110: * </p>
111: * <h4>Typical usage from an ExpressoComponent.</h4>
112: * <p>This example gets the default Data Context for a component within the context</p>
113: * <p><code>
114: * DataContext default = (DataContext)this.getParent().locateComponent("default");
115: * </code></p>
116: *
117: * @param componentName The name of the component to retrieve
118: * @return an ExpressoComponent or null if the specified name doesn't exist
119: */
120: public ExpressoComponent locateComponent(String componentName);
121:
122: }
|