org.apache.cayenne.tools
Class DbGeneratorTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.apache.cayenne.tools.CayenneTask
              extended by org.apache.cayenne.tools.DbGeneratorTask

public class DbGeneratorTask
extends CayenneTask

An Ant Task that is a frontend to Cayenne DbGenerator allowing schema generation from DataMap using Ant.

Since:
1.2
Author:
nirvdrum, Andrei Adamchik

Field Summary
protected  DbAdapter adapter
           
protected  boolean createFK
           
protected  boolean createPK
           
protected  boolean createTables
           
protected  java.lang.String driver
           
protected  boolean dropPK
           
protected  boolean dropTables
           
protected  java.io.File map
           
protected  java.lang.String password
           
protected  java.lang.String url
           
protected  java.lang.String userName
           
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
DbGeneratorTask()
           
 
Method Summary
 void execute()
           
protected  DataMap loadDataMap()
          Loads and returns DataMap based on map attribute.
 void setAdapter(java.lang.String adapter)
          Sets the db adapter.
 void setCreateFK(boolean createFK)
           
 void setCreatePK(boolean createPK)
           
 void setCreateTables(boolean createTables)
           
 void setDriver(java.lang.String driver)
          Sets the JDBC driver used to connect to the database server.
 void setDropPK(boolean dropPK)
           
 void setDropTables(boolean dropTables)
           
 void setMap(java.io.File map)
          Sets the map.
 void setPassword(java.lang.String password)
          Sets the password used to connect to the database server.
 void setUrl(java.lang.String url)
          Sets the JDBC URL used to connect to the database server.
 void setUserName(java.lang.String username)
          Sets the username used to connect to the database server.
protected  void validateAttributes()
          Validates atttributes that are not related to internal DefaultClassGenerator.
 
Methods inherited from class org.apache.cayenne.tools.CayenneTask
configureLogging
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

adapter

protected DbAdapter adapter

map

protected java.io.File map

driver

protected java.lang.String driver

url

protected java.lang.String url

userName

protected java.lang.String userName

password

protected java.lang.String password

dropTables

protected boolean dropTables

dropPK

protected boolean dropPK

createTables

protected boolean createTables

createPK

protected boolean createPK

createFK

protected boolean createFK
Constructor Detail

DbGeneratorTask

public DbGeneratorTask()
Method Detail

execute

public void execute()
Overrides:
execute in class org.apache.tools.ant.Task

validateAttributes

protected void validateAttributes()
                           throws org.apache.tools.ant.BuildException
Validates atttributes that are not related to internal DefaultClassGenerator. Throws BuildException if attributes are invalid.

Throws:
org.apache.tools.ant.BuildException

loadDataMap

protected DataMap loadDataMap()
                       throws java.lang.Exception
Loads and returns DataMap based on map attribute.

Throws:
java.lang.Exception

setCreateFK

public void setCreateFK(boolean createFK)

setCreatePK

public void setCreatePK(boolean createPK)

setCreateTables

public void setCreateTables(boolean createTables)

setDropPK

public void setDropPK(boolean dropPK)

setDropTables

public void setDropTables(boolean dropTables)

setMap

public void setMap(java.io.File map)
Sets the map.

Parameters:
map - The map to set

setAdapter

public void setAdapter(java.lang.String adapter)
Sets the db adapter.

Parameters:
adapter - The db adapter to set.

setDriver

public void setDriver(java.lang.String driver)
Sets the JDBC driver used to connect to the database server.

Parameters:
driver - The driver to set.

setUrl

public void setUrl(java.lang.String url)
Sets the JDBC URL used to connect to the database server.

Parameters:
url - The url to set.

setUserName

public void setUserName(java.lang.String username)
Sets the username used to connect to the database server.

Parameters:
username - The username to set.

setPassword

public void setPassword(java.lang.String password)
Sets the password used to connect to the database server.

Parameters:
password - The password to set.


Copyright © 2001-2006 Apache.org All Rights Reserved.