| org.jaffa.tools.patternmetaengine.IBuilder
All known Subclasses: org.jaffa.tools.patternmetaengine.BuildObjectFinder_2, org.jaffa.tools.patternmetaengine.BuildObjectViewer, org.jaffa.tools.patternmetaengine.BuildObjectMaintenance, org.jaffa.tools.patternmetaengine.BuildObjectMaintenance_1, org.jaffa.tools.patternmetaengine.BuildObjectLookup_1, org.jaffa.tools.patternmetaengine.BuildObjectMaintenance_2, org.jaffa.tools.patternmetaengine.BuildObjectFinder, org.jaffa.tools.patternmetaengine.BuildObjectLookup_2, org.jaffa.tools.patternmetaengine.BuildObjectLookup, org.jaffa.tools.patternmetaengine.BuildObjectViewer_1, org.jaffa.tools.patternmetaengine.BuildObjectViewer_2, org.jaffa.tools.patternmetaengine.BuildObjectFinder_1,
| IBuilder | | public interface IBuilder (Code) | | Interface for any type of builder that can be called.
author:
PaulE |
| buildPhase1 | | public void buildPhase1(boolean fullPackage) throws Exception(Code) | | Phase 1 of the build should create the initial skeleton component in
as much detail as possible. It is the job of this phase to write
out any module labels if some need to be produced. It should also
guarentee that the 'getters' provided by this interface provide the correct
data so that any component in phase 2 can use this information for linking
Note: To writing out module labels, the label object should be
supplied in the construtor of the implementing class to facilitate this.
Parameters:
fullPackage - If true then the .applications. and .modules. package namesare used. If this is false, these are ommited for a much more condensed packagenaming convention
throws:
Exception - thrown in the event of a critical error |
| buildPhase2 | | public void buildPhase2(boolean fullPackage) throws Exception(Code) | | Phase 2 allows any inter-conponent linking to be performed. At this
point all components have initially been build (by Phase 1), and are available
(via the ComponentRegistry) for access. If you nee to perform linking
in this phase via the Registry, then you should make sure it was passed
into the constructor of the implementing class.
It is assumed that one the Phase 2 build has been completed, the component
is now ready to have the save() method invoked.
Parameters:
fullPackage - If true then the .applications. and .modules. package namesare used. If this is false, these are ommited for a much more condensed packagenaming convention
throws:
Exception - thrown in the event of a critical error |
| getApplication | | public String getApplication()(Code) | | Get Application Name
The name of the application this component is in |
| getComponentControllerClass | | public String getComponentControllerClass()(Code) | | Get Component Controller Class
The class name of the component controller |
| getComponentControllerPackage | | public String getComponentControllerPackage()(Code) | | Get Component Controller Package
The package name that the component controller will be in |
| getComponentName | | public String getComponentName()(Code) | | Get Component Name
The name this component is referenced by in Jaffa by the component manager |
| getComponentType | | public String getComponentType()(Code) | | Get Component Type
The type of component this is "Finder","Viewer","Maintenance","Lookup" |
| getDomain | | public String getDomain()(Code) | | Get the domain object
The full class name of the domain object this component pattern is based on |
| getModule | | public String getModule()(Code) | | Get Module Name
The name of the module this component is in. The initial letter willalways be capitalized |
| getName | | public String getName()(Code) | | Get Component Name
The name this component typically this is the same as 'ComponentName' but does notinclude the module name |
| save | | public boolean save()(Code) | | Saves the generated meta data to the prespecified location as an XML file
NOTE: assumes that the buildPhase1() and buildPhase2() methods have
already been called!
returns true if the file saved ok, false if it failed |
|
|