org.jaffa.tools.patternmetaengine
Class BuildObjectViewer_2

java.lang.Object
  org.jaffa.tools.patternmetaengine.BuildObjectViewer_2

All Implemented Interfaces:

IBuilder

public class BuildObjectViewer_2

extends Object

implements IBuilder

Create the meta data for an Object Viewer Pattern, based on a specified Domain Object.

Version:

1.0

Author:

PaulE

Constructor Summary

BuildObjectViewer_2(ApplicationBuilder app, ComponentRegistry comps, Module module, org.jaffa.patterns.library.domain_creator_1_1.domain.Root domain, DomainObjectHelper doList, Properties labels)
Creates a new instance of BuildObjectViewer

Method Summary

void	buildPhase1(boolean fullPackage) Causes the meta data object to be build ready for saving.
void	buildPhase2(boolean fullPackage) Causes the meta data object to be build ready for saving.
String	getApplication() Get Application Name
String	getComponentControllerClass() Get Component Controller Class
String	getComponentControllerPackage() Get Component Controller Package
String	getComponentName() Get Component Name
String	getComponentType() Get Component Type
String	getDomain() Get the domain object
String	getModule() Get Module Name
String	getName() Get Component Name
boolean	save() Saves the generated meta data to the prespecified location as an XML file NOTE: assumes that the build(..) method has been called!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildObjectViewer_2

public BuildObjectViewer_2(ApplicationBuilder app,
                           ComponentRegistry comps,
                           Module module,
                           org.jaffa.patterns.library.domain_creator_1_1.domain.Root domain,
                           DomainObjectHelper doList,
                           Properties labels)

Creates a new instance of BuildObjectViewer

Method Detail

buildPhase1

public void buildPhase1(boolean fullPackage)
                 throws Exception

Causes the meta data object to be build ready for saving.

Specified by:

buildPhase1 in interface IBuilder

Parameters:

fullPackage - If true then the .applications. and .modules. package names are used. If this is false, these are ommited for a much more condensed package naming convention

Throws:

Exception - thrown in the event of a critical error

save

public boolean save()

Saves the generated meta data to the prespecified location as an XML file NOTE: assumes that the build(..) method has been called!

Specified by:

save in interface IBuilder

Returns:

returns true if the file saved ok, false if it failed

getApplication

public String getApplication()

Description copied from interface: IBuilder

Get Application Name

Specified by:

getApplication in interface IBuilder

Returns:

The name of the application this component is in

getComponentControllerClass

public String getComponentControllerClass()

Description copied from interface: IBuilder

Get Component Controller Class

Specified by:

getComponentControllerClass in interface IBuilder

Returns:

The class name of the component controller

getComponentControllerPackage

public String getComponentControllerPackage()

Description copied from interface: IBuilder

Get Component Controller Package

Specified by:

getComponentControllerPackage in interface IBuilder

Returns:

The package name that the component controller will be in

getComponentName

public String getComponentName()

Description copied from interface: IBuilder

Get Component Name

Specified by:

getComponentName in interface IBuilder

Returns:

The name this component is referenced by in Jaffa by the component manager

getComponentType

public String getComponentType()

Description copied from interface: IBuilder

Get Component Type

Specified by:

getComponentType in interface IBuilder

Returns:

The type of component this is "Finder","Viewer","Maintenance","Lookup"

getDomain

public String getDomain()

Description copied from interface: IBuilder

Get the domain object

Specified by:

getDomain in interface IBuilder

Returns:

The full class name of the domain object this component pattern is based on

getModule

public String getModule()

Description copied from interface: IBuilder

Get Module Name

Specified by:

getModule in interface IBuilder

Returns:

The name of the module this component is in. The initial letter will always be capitalized

getName

public String getName()

Description copied from interface: IBuilder

Get Component Name

Specified by:

getName in interface IBuilder

Returns:

The name this component typically this is the same as 'ComponentName' but does not include the module name

buildPhase2

public void buildPhase2(boolean fullPackage)
                 throws Exception

Causes the meta data object to be build ready for saving.

Specified by:

buildPhase2 in interface IBuilder

Parameters:

fullPackage - If true then the .applications. and .modules. package names are used. If this is false, these are ommited for a much more condensed package naming convention

Throws:

Exception - thrown in the event of a critical error