org.dmd.dmg.generators

Class BaseDMWGenerator

java.lang.Object

org.dmd.dmg.generators.BaseDMWGenerator

All Implemented Interfaces:

DarkMatterGeneratorIF

Direct Known Subclasses:

DMWGenerator

public abstract class BaseDMWGenerator
extends Object
implements DarkMatterGeneratorIF

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<AttributeDefinition>	allAttr
protected boolean	anyAttributes
protected boolean	anyMVAttributes
protected boolean	anyMVRefs
protected boolean	anySVAttributes
protected StringBuffer	attributeInfo
protected String	baseWrapperImport
protected String	dmwdir
protected String	extendedDir
protected String	fileHeader
protected Boolean	fullJavaEnvironment
protected String	genContext
protected String	gendir
protected String	genSuffix
protected String	hierarchicWrapperImport
protected String	namedWrapperImport
protected PrintStream	progress
protected SchemaManager	schema
protected SchemaFormatter	sformatter
protected Boolean	useWrappedObjectRefs

Constructor Summary

Constructors

Constructor and Description
BaseDMWGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	createCloneItMethod(BufferedWriter out, DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd) Derived classes should override this to provide a cloning mechanism if they need it.
protected void	createExtendedWrapperClasses(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm) If a class has wrapperType EXTENDED, we'll generate the extended class if it isn't already there.
protected void	createIfRequired(String outdir) Creates the specified directory is it doesn't already exist.
protected void	createWrappers(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm)
void	dumpAdditionalWrapperDefinitions(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd, BufferedWriter out) At this level, we do nothing.
void	dumpAdditionalWrapperFunctions(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd, BufferedWriter out) At this level, we do nothing.
protected void	dumpAUX(ClassDefinition cd, String outdir) Dumps a file named AUX.java to the specified output directory.
protected void	dumpExtendedClass(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd) At this level, we do nothing.
void	gatherUserInput(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm) In cases where your generator requires some further input from the user, you can overload this method to perform that interaction.
void	getAdditionalWrapperImports(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd, ImportManager imports) At this level, we do nothing.
void	getAdditionalWrapperInterfaces(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd, ImplementsManager implManager) At this level, we do nothing.
void	getAttributesAndImports(ClassDefinition cd, ArrayList<AttributeDefinition> allAttr, ImportManager imports) This method cycles through the class derivation hierarchy and the types required by all attributes associated with this class to determine the appropriate set of import statements required for the DMO.
void	setFileHeader(String fh) In some cases, it's convenient to be able to dump a common header to your generated files.
void	setProgressStream(PrintStream ps) If the overall generation process wants you to provide feedback, this method will be called with a handle to the print stream where you should display progress messages.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmg.DarkMatterGeneratorIF

generateCode

Field Detail

gendir

protected String gendir

dmwdir

protected String dmwdir

extendedDir

protected String extendedDir

fileHeader

protected String fileHeader

allAttr

protected ArrayList<AttributeDefinition> allAttr

progress

protected PrintStream progress

schema

protected SchemaManager schema

sformatter

protected SchemaFormatter sformatter

attributeInfo

protected StringBuffer attributeInfo

anyMVAttributes

protected boolean anyMVAttributes

anySVAttributes

protected boolean anySVAttributes

anyMVRefs

protected boolean anyMVRefs

anyAttributes

protected boolean anyAttributes

genContext

protected String genContext

genSuffix

protected String genSuffix

useWrappedObjectRefs

protected Boolean useWrappedObjectRefs

fullJavaEnvironment

protected Boolean fullJavaEnvironment

baseWrapperImport

protected String baseWrapperImport

namedWrapperImport

protected String namedWrapperImport

hierarchicWrapperImport

protected String hierarchicWrapperImport

Constructor Detail

BaseDMWGenerator

public BaseDMWGenerator()

Method Detail

gatherUserInput

public void gatherUserInput(DmgConfigDMO config,
                            ConfigLocation loc,
                            ConfigFinder f,
                            SchemaManager sm)

Description copied from interface: DarkMatterGeneratorIF

In cases where your generator requires some further input from the user, you can overload this method to perform that interaction.

Specified by:

gatherUserInput in interface DarkMatterGeneratorIF

Parameters:

config - The generator config.

loc - The location where the config was found. Code if often generated relative to this location.

f - The configuration finder

sm - The schema manager that contains the base schema plus any others that were requested in the .dmg config file via the schemaToLoad attribute.

setProgressStream

public void setProgressStream(PrintStream ps)

Description copied from interface: DarkMatterGeneratorIF

If the overall generation process wants you to provide feedback, this method will be called with a handle to the print stream where you should display progress messages.

Specified by:

setProgressStream in interface DarkMatterGeneratorIF

Parameters:

ps - The print stream

setFileHeader

public void setFileHeader(String fh)

Description copied from interface: DarkMatterGeneratorIF

In some cases, it's convenient to be able to dump a common header to your generated files. This method lets you set that header.

Specified by:

setFileHeader in interface DarkMatterGeneratorIF

Parameters:

fh - The header text.

createExtendedWrapperClasses

protected void createExtendedWrapperClasses(DmgConfigDMO config,
                                            ConfigLocation loc,
                                            ConfigFinder f,
                                            SchemaManager sm)
                                     throws IOException,
                                            ResultException

If a class has wrapperType EXTENDED, we'll generate the extended class if it isn't already there.

Throws:

IOException

ResultException

dumpExtendedClass

protected void dumpExtendedClass(DmgConfigDMO config,
                                 ConfigLocation loc,
                                 ConfigFinder f,
                                 SchemaManager sm,
                                 ClassDefinition cd)
                          throws IOException

At this level, we do nothing. Derived classes can overload this to generate the extended wrapper class if it doesn't already exist.

Throws:

IOException

createWrappers

protected void createWrappers(DmgConfigDMO config,
                              ConfigLocation loc,
                              ConfigFinder f,
                              SchemaManager sm)
                       throws IOException,
                              ResultException

Throws:

IOException

ResultException

getAdditionalWrapperImports

public void getAdditionalWrapperImports(DmgConfigDMO config,
                                        ConfigLocation loc,
                                        ConfigFinder f,
                                        SchemaManager sm,
                                        ClassDefinition cd,
                                        ImportManager imports)
                                 throws IOException

At this level, we do nothing. Derived classes can overload this to insert additional required imports into a generated wrapper.

Parameters:

config -

loc -

f -

sm -

cd -

imports -

Throws:

IOException

getAdditionalWrapperInterfaces

public void getAdditionalWrapperInterfaces(DmgConfigDMO config,
                                           ConfigLocation loc,
                                           ConfigFinder f,
                                           SchemaManager sm,
                                           ClassDefinition cd,
                                           ImplementsManager implManager)
                                    throws IOException

At this level, we do nothing. Derived classes can overload this to insert additional required interfaces into the implements statement of a generated wrapper.

Parameters:

config -

loc -

f -

sm -

cd -

imports -

Throws:

IOException

dumpAdditionalWrapperDefinitions

public void dumpAdditionalWrapperDefinitions(DmgConfigDMO config,
                                             ConfigLocation loc,
                                             ConfigFinder f,
                                             SchemaManager sm,
                                             ClassDefinition cd,
                                             BufferedWriter out)
                                      throws IOException

At this level, we do nothing. Derived classes can overload this to insert additional definitions and properties in the wrapper.

Parameters:

config -

loc -

f -

sm -

cd -

out -

Throws:

IOException

dumpAdditionalWrapperFunctions

public void dumpAdditionalWrapperFunctions(DmgConfigDMO config,
                                           ConfigLocation loc,
                                           ConfigFinder f,
                                           SchemaManager sm,
                                           ClassDefinition cd,
                                           BufferedWriter out)
                                    throws IOException

At this level, we do nothing. Derived classes can overload this to insert additional behaviour in individual class wrappers.

Parameters:

config -

loc -

f -

sm -

cd -

out -

Throws:

IOException

createCloneItMethod

protected void createCloneItMethod(BufferedWriter out,
                                   DmgConfigDMO config,
                                   ConfigLocation loc,
                                   ConfigFinder f,
                                   SchemaManager sm,
                                   ClassDefinition cd)
                            throws IOException

Derived classes should override this to provide a cloning mechanism if they need it.

Parameters:

config -

loc -

f -

sm -

cd -

Throws:

IOException

dumpAUX

protected void dumpAUX(ClassDefinition cd,
                       String outdir)
                throws IOException

Dumps a file named AUX.java to the specified output directory.

Parameters:

cd - The definition of the class.

outdir - The output directory.

Throws:

IOException

getAttributesAndImports

public void getAttributesAndImports(ClassDefinition cd,
                                    ArrayList<AttributeDefinition> allAttr,
                                    ImportManager imports)

This method cycles through the class derivation hierarchy and the types required by all attributes associated with this class to determine the appropriate set of import statements required for the DMO.

Parameters:

cd - The class definition of the object.

allAttr - An array that will be populated with all attribute definitions of the class.

imports - The import manager where we accumulate required imports.

createIfRequired

protected void createIfRequired(String outdir)

Creates the specified directory is it doesn't already exist.