org.dmd.dmg.generators

Class DMWGenerator

java.lang.Object

org.dmd.dmg.generators.BaseDMWGenerator

org.dmd.dmg.generators.DMWGenerator

All Implemented Interfaces:

DarkMatterGeneratorIF

public class DMWGenerator
extends BaseDMWGenerator

Field Summary

Fields inherited from class org.dmd.dmg.generators.BaseDMWGenerator

allAttr, anyAttributes, anyMVAttributes, anyMVRefs, anySVAttributes, attributeInfo, baseWrapperImport, dmwdir, extendedDir, fileHeader, fullJavaEnvironment, genContext, gendir, genSuffix, hierarchicWrapperImport, namedWrapperImport, progress, schema, sformatter, useWrappedObjectRefs

Constructor Summary

Constructors

Constructor and Description
DMWGenerator()

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.
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.
void	dumpExtendedClass(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm, ClassDefinition cd) At this level, we do nothing.
void	generateCode(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm) This method should be overloaded to generate whatever code you need to generate.
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.

Methods inherited from class org.dmd.dmg.generators.BaseDMWGenerator

createExtendedWrapperClasses, createIfRequired, createWrappers, dumpAUX, gatherUserInput, getAttributesAndImports, setFileHeader, setProgressStream

Methods inherited from class java.lang.Object

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

Constructor Detail

DMWGenerator

public DMWGenerator()

Method Detail

generateCode

public void generateCode(DmgConfigDMO config,
                         ConfigLocation loc,
                         ConfigFinder f,
                         SchemaManager sm)
                  throws IOException,
                         ResultException,
                         DmcNameClashException,
                         DmcValueException

Description copied from interface: DarkMatterGeneratorIF

This method should be overloaded to generate whatever code you need to generate.

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.

Throws:

IOException

ResultException

DmcNameClashException

DmcValueException

createCloneItMethod

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

Description copied from class: BaseDMWGenerator

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

Overrides:

createCloneItMethod in class BaseDMWGenerator

Throws:

IOException

getAdditionalWrapperImports

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

Description copied from class: BaseDMWGenerator

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

Overrides:

getAdditionalWrapperImports in class BaseDMWGenerator

Throws:

IOException

getAdditionalWrapperInterfaces

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

Description copied from class: BaseDMWGenerator

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

Overrides:

getAdditionalWrapperInterfaces in class BaseDMWGenerator

Throws:

IOException

dumpAdditionalWrapperDefinitions

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

Description copied from class: BaseDMWGenerator

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

Overrides:

dumpAdditionalWrapperDefinitions in class BaseDMWGenerator

Throws:

IOException

dumpAdditionalWrapperFunctions

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

Description copied from class: BaseDMWGenerator

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

Overrides:

dumpAdditionalWrapperFunctions in class BaseDMWGenerator

Throws:

IOException

dumpExtendedClass

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

Description copied from class: BaseDMWGenerator

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

Overrides:

dumpExtendedClass in class BaseDMWGenerator

Throws:

IOException