org.dmd.dmg

Interface DarkMatterGeneratorIF

All Known Implementing Classes:

BaseDMWGenerator, DMWGenerator

public interface DarkMatterGeneratorIF

The DarkMatterGeneratorIF interface must be implemented by classes that are referred to in Dark Matter Generator (DMG) configurations as objects that will generate code based on Dark Matter Schemas (DMS) or other kinds of configuration files.

Method Summary

Modifier and Type	Method and Description
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	generateCode(DmgConfigDMO config, ConfigLocation loc, ConfigFinder f, SchemaManager sm) This method should be overloaded to generate whatever code you need to generate.
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.

Method Detail

gatherUserInput

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.

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.

generateCode

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

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

setProgressStream

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.

Parameters:

ps - The print stream

setFileHeader

void setFileHeader(String fh)

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.

Parameters:

fh - The header text.