001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049: package org.jaffa.tools.patternmetaengine;
050:
051: /** Interface for any type of builder that can be called.
052: *
053: * @author PaulE
054: */
055: public interface IBuilder {
056:
057: /** Phase 1 of the build should create the initial skeleton component in
058: * as much detail as possible. It is the job of this phase to write
059: * out any module labels if some need to be produced. It should also
060: * guarentee that the 'getters' provided by this interface provide the correct
061: * data so that any component in phase 2 can use this information for linking
062: * <br><br>
063: * <b>Note</b>: To writing out module labels, the label object should be
064: * supplied in the construtor of the implementing class to facilitate this.
065: *
066: * @param fullPackage If true then the .applications. and .modules. package names
067: * are used. If this is false, these are ommited for a much more condensed package
068: * naming convention
069: * @throws Exception thrown in the event of a critical error
070: */
071: public void buildPhase1(boolean fullPackage) throws Exception;
072:
073: /** Phase 2 allows any inter-conponent linking to be performed. At this
074: * point all components have initially been build (by Phase 1), and are available
075: * (via the ComponentRegistry) for access. If you nee to perform linking
076: * in this phase via the Registry, then you should make sure it was passed
077: * into the constructor of the implementing class.
078: * <br>
079: * It is assumed that one the Phase 2 build has been completed, the component
080: * is now ready to have the save() method invoked.
081: *
082: * @param fullPackage If true then the .applications. and .modules. package names
083: * are used. If this is false, these are ommited for a much more condensed package
084: * naming convention
085: * @throws Exception thrown in the event of a critical error
086: */
087: public void buildPhase2(boolean fullPackage) throws Exception;
088:
089: /** Saves the generated meta data to the prespecified location as an XML file
090: * NOTE: assumes that the buildPhase1() and buildPhase2() methods have
091: * already been called!
092: * @return returns true if the file saved ok, false if it failed
093: */
094: public boolean save();
095:
096: /** Get Component Name
097: * @return The name this component typically this is the same as 'ComponentName' but does not
098: * include the module name
099: */
100: public String getName();
101:
102: /** Get the domain object
103: * @return The full class name of the domain object this component pattern is based on
104: */
105: public String getDomain();
106:
107: /** Get Application Name
108: * @return The name of the application this component is in
109: */
110: public String getApplication();
111:
112: /** Get Module Name
113: * @return The name of the module this component is in. The initial letter will
114: * always be capitalized
115: */
116: public String getModule();
117:
118: /** Get Component Controller Package
119: * @return The package name that the component controller will be in
120: */
121: public String getComponentControllerPackage();
122:
123: /** Get Component Controller Class
124: * @return The class name of the component controller
125: */
126: public String getComponentControllerClass();
127:
128: /** Get Component Type
129: * @return The type of component this is "Finder","Viewer","Maintenance","Lookup"
130: */
131: public String getComponentType();
132:
133: /** Get Component Name
134: * @return The name this component is referenced by in Jaffa by the component manager
135: */
136: public String getComponentName();
137: }
|