Generator (Castor JavaDoc)

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: 5951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Le Duc Bao, Ralf Joachim

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`GLOBAL_CONFIG_NAME`	Global configuration file name.
`static java.lang.String`	`GLOBAL_CONFIG_PATH`	Global configuration file path.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.

Interface Generator

Field Summary

Method Summary

Field Detail

GLOBAL_CONFIG_PATH

GLOBAL_CONFIG_NAME

Method Detail

initialize

getEngineName

getEngineConfigPath

getEngineConfigName

setMapping

setKeyGenRegistry

generateDDL