org.castor.ddlgen
Interface Generator

All Known Implementing Classes:
AbstractGenerator, Db2Generator, DerbyGenerator, HsqlGenerator, MssqlGenerator, MysqlGenerator, OracleGenerator, PointBaseGenerator, PostgresqlGenerator, SapdbGenerator, SybaseGenerator

public interface Generator

Generator is the interface for various generators.

Since:
1.1
Version:
$Revision: 8993 $ $Date: 2011-08-02 01:28:52 +0200 (Di, 02 Aug 2011) $
Author:
Le Duc Bao, Ralf Joachim

Field Summary
static java.lang.String GLOBAL_CONFIG_NAME
          Global configuration file name.
static java.lang.String GLOBAL_CONFIG_PATH
          Global configuration file path.
 
Method Summary
 void generateDDL(java.io.OutputStream output)
          Generate DDL for a mapping document.
 java.lang.String getEngineConfigName()
          Get engine configuration file name.
 java.lang.String getEngineConfigPath()
          Get engine configuration file path.
 java.lang.String getEngineName()
          Get engine name.
 void initialize()
          Initialize generator.
 void setKeyGenRegistry(KeyGeneratorRegistry keygenRegistry)
          Set key generator registry.
 void setMapping(Mapping mappingDoc)
          Set mapping document.
 

Field Detail

GLOBAL_CONFIG_PATH

static final java.lang.String GLOBAL_CONFIG_PATH
Global configuration file path.

See Also:
Constant Field Values

GLOBAL_CONFIG_NAME

static final java.lang.String GLOBAL_CONFIG_NAME
Global configuration file name.

See Also:
Constant Field Values
Method Detail

initialize

void initialize()
Initialize generator.


getEngineName

java.lang.String getEngineName()
Get engine name.

Returns:
Engine name

getEngineConfigPath

java.lang.String getEngineConfigPath()
Get engine configuration file path.

Returns:
Engine configuration file path

getEngineConfigName

java.lang.String getEngineConfigName()
Get engine configuration file name.

Returns:
Engine configuration file name

setMapping

void setMapping(Mapping mappingDoc)
Set mapping document.

Parameters:
mappingDoc - Mapping document.

setKeyGenRegistry

void setKeyGenRegistry(KeyGeneratorRegistry keygenRegistry)
Set key generator registry.

Parameters:
keygenRegistry - Key generator registry.

generateDDL

void generateDDL(java.io.OutputStream output)
                 throws GeneratorException
Generate DDL for a mapping document.

Parameters:
output - Output stream for output.
Throws:
GeneratorException - If failed to generate DDL.


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com