org.castor.anttask

Class CastorDDLGenTask


public final class CastorDDLGenTask
extends MatchingTask

An Ant task to call the Castor DDL Generator. It can be passed a file, a directory, a Fileset or all three.
Version:
$Revision: 6543 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
Author:
Werner Guttmann

Method Summary

void
addFileset(FileSet set)
Adds a fileset to process that contains schemas to process.
void
execute()
Public execute method -- entry point for the Ant task.
void
setDatabaseEngine(String databaseEngine)
Specifies the name of database engine to generate DDL for.
void
setDatabaseEngineProperties(String databaseEngineProperties)
Specifies the name of a database specific properties file to be used during DDL generation.
void
setDdlFileName(String ddlFileName)
Specifies the name of the DDL file to be generated.
void
setDir(File dir)
Sets the directory such that all schemas in this directory will have code generated for them.
void
setFile(File file)
Sets the individual schema that will have code generated for it.
void
setGlobalProperties(String globalProperties)
Specifies the name of a global properties file to be used during DDL generation.

Method Details

addFileset

public void addFileset(FileSet set)
Adds a fileset to process that contains schemas to process.
Parameters:
set - An individual file set containing schemas.

execute

public void execute()
Public execute method -- entry point for the Ant task. Loops over all schema that need code generated and creates needed code generators, then executes them. If anything goes wrong during execution of the Ant task a BuildException will be thrown.
See Also:
org.apache.tools.ant.Task.execute()

setDatabaseEngine

public void setDatabaseEngine(String databaseEngine)
Specifies the name of database engine to generate DDL for.
Parameters:
databaseEngine - Name of the database engine

setDatabaseEngineProperties

public void setDatabaseEngineProperties(String databaseEngineProperties)
Specifies the name of a database specific properties file to be used during DDL generation.
Parameters:
databaseEngineProperties - Database specific properties

setDdlFileName

public void setDdlFileName(String ddlFileName)
Specifies the name of the DDL file to be generated.
Parameters:
ddlFileName - Name of the DDL file to be generated

setDir

public void setDir(File dir)
Sets the directory such that all schemas in this directory will have code generated for them.
Parameters:
dir - The directory containing schemas to process.

setFile

public void setFile(File file)
Sets the individual schema that will have code generated for it.
Parameters:
file - One schema file.

setGlobalProperties

public void setGlobalProperties(String globalProperties)
Specifies the name of a global properties file to be used during DDL generation.
Parameters:
globalProperties - Custom global properties for DDL generation.

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