org.dmd.concinnity.server.generated.dsd

Class ConcinnityModuleConfigLoader

java.lang.Object

org.dmd.concinnity.server.generated.dsd.ConcinnityModuleGenUtility

org.dmd.concinnity.server.generated.dsd.ConcinnityModuleConfigLoader

All Implemented Interfaces:

ConcinnityModuleGeneratorInterface

public class ConcinnityModuleConfigLoader
extends ConcinnityModuleGenUtility

Field Summary

Fields inherited from class org.dmd.concinnity.server.generated.dsd.ConcinnityModuleGenUtility

commandLine, debug, helpFlag, jars, outdir, parser, searchPaths, srcdir, targets, workspace

Constructor Summary

Constructors

Constructor and Description
ConcinnityModuleConfigLoader()

Method Summary

Modifier and Type	Method and Description
void	addSrcDir(String dir) Adds a directory that will be recursively searched for modules.
ConcinnityModuleDefinitionManager	definitionManager()
void	displayHelp() Called if the help flag is found anywhere on the commandline.
void	generate(ConcinnityModule module, ConfigLocation location, ConcinnityModuleDefinitionManager definitions) Derived classes should overload this method to perform artifact generation.
void	generate(ConcinnityModuleDefinitionManager definitions) Derived classes should overload this method to perform artifact generation when no target module has been specified on the commandline.
void	loadAllModules(String srcdir) Load all modules from the specified directory.
void	loadModule(String srcdir, String module) Load the specified module and all of its dependencies.
void	objectResolutionComplete(ConcinnityModule module, ConfigLocation location, ConcinnityModuleDefinitionManager definitions) Called after object resolution has completely successfully.
void	parsingComplete(ConcinnityModule module, ConfigLocation location, ConcinnityModuleDefinitionManager definitions) Called prior to the object resolution phase so that derived classes can perform intermediate processing such as generation of internal types.

Methods inherited from class org.dmd.concinnity.server.generated.dsd.ConcinnityModuleGenUtility

getLocation, initialize, run

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcinnityModuleConfigLoader

public ConcinnityModuleConfigLoader()

Method Detail

loadAllModules

public void loadAllModules(String srcdir)
                    throws ResultException,
                           DmcValueException,
                           IOException,
                           DmcRuleExceptionSet,
                           DmcNameClashException,
                           DmcValueExceptionSet

Load all modules from the specified directory.

Parameters:

srcdir - the directory from which to load modules

Throws:

ResultException

DmcValueException

IOException

DmcRuleExceptionSet

DmcNameClashException

DmcValueExceptionSet

loadModule

public void loadModule(String srcdir,
                       String module)
                throws ResultException,
                       DmcValueException,
                       IOException,
                       DmcRuleExceptionSet,
                       DmcNameClashException,
                       DmcValueExceptionSet

Load the specified module and all of its dependencies.

Parameters:

srcdir - the directory from which to load modules

module - the name of the module (without the file extension)

Throws:

ResultException

DmcValueException

IOException

DmcRuleExceptionSet

DmcNameClashException

DmcValueExceptionSet

addSrcDir

public void addSrcDir(String dir)

Adds a directory that will be recursively searched for modules.

Parameters:

dir - the directory to be searched

definitionManager

public ConcinnityModuleDefinitionManager definitionManager()

parsingComplete

public void parsingComplete(ConcinnityModule module,
                            ConfigLocation location,
                            ConcinnityModuleDefinitionManager definitions)
                     throws ResultException

Description copied from interface: ConcinnityModuleGeneratorInterface

Called prior to the object resolution phase so that derived classes can perform intermediate processing such as generation of internal types.

Parameters:

module - the module that was just parsed

location - the module's location

definitions - the current set of definitions

Throws:

ResultException - if there are problems

objectResolutionComplete

public void objectResolutionComplete(ConcinnityModule module,
                                     ConfigLocation location,
                                     ConcinnityModuleDefinitionManager definitions)
                              throws ResultException

Description copied from interface: ConcinnityModuleGeneratorInterface

Called after object resolution has completely successfully. This allows for application of business logic not defined as part of rules etc.

Parameters:

module - the module that was just parsed

location - the module's location

definitions - the current set of definitions

Throws:

ResultException - if there are problems

generate

public void generate(ConcinnityModule module,
                     ConfigLocation location,
                     ConcinnityModuleDefinitionManager definitions)
              throws ResultException,
                     IOException

Description copied from interface: ConcinnityModuleGeneratorInterface

Derived classes should overload this method to perform artifact generation.

Parameters:

module - the module for which generation is being performed

location - where the module was found

definitions - the current set of definitions

Throws:

ResultException - if there are problems

IOException - if IO problems

generate

public void generate(ConcinnityModuleDefinitionManager definitions)
              throws ResultException,
                     IOException

Description copied from interface: ConcinnityModuleGeneratorInterface

Derived classes should overload this method to perform artifact generation when no target module has been specified on the commandline. This is useful when doing things like generating documentation where you want to load and resolve objects across many modules.

Parameters:

definitions - the current set of definitions

Throws:

ResultException - is there are problems

IOException - if IO problems

displayHelp

public void displayHelp()

Description copied from interface: ConcinnityModuleGeneratorInterface

Called if the help flag is found anywhere on the commandline.