org.apache.cayenne.tools

Class CayenneGeneratorTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.cayenne.tools.CayenneTask

org.apache.cayenne.tools.CayenneGeneratorTask

All Implemented Interfaces:

Cloneable

public class CayenneGeneratorTask
extends CayenneTask

An Ant task to perform class generation based on CayenneDataMap.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected File[]	additionalMaps
protected boolean	client
protected File	destDir
protected String	embeddablesupertemplate
protected String	embeddabletemplate
protected String	encoding
protected String	excludeEntitiesPattern
protected String	includeEntitiesPattern
protected boolean	makepairs
protected File	map
protected String	mode
protected String	outputPattern
protected boolean	overwrite
protected String	querysupertemplate
protected String	querytemplate
protected String	superpkg
protected String	supertemplate
protected String	template
protected boolean	usepkgpath
protected foundrylogic.vpp.VPPConfig	vppConfig

Fields inherited from class org.apache.cayenne.tools.CayenneTask

adapter, classpath, driver, password, url, userName

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
CayenneGeneratorTask()

Method Summary

Methods

Modifier and Type	Method and Description
Object	createConfig() Provides a VPPConfig object to configure.
protected ClassGenerationAction	createGeneratorAction()
void	execute() Executes the task.
protected org.apache.velocity.VelocityContext	getVppContext()
void	setAdditionalMaps(org.apache.tools.ant.types.Path additionalMapsPath) Sets the additional DataMaps.
void	setClient(boolean client) Sets client property.
void	setDestDir(File destDir) Sets the destDir.
void	setEmbeddablesupertemplate(String embeddablesupertemplate)
void	setEmbeddabletemplate(String embeddabletemplate)
void	setEncoding(String encoding) Sets encoding property that allows to generate files using non-default encoding.
void	setExcludeEntities(String excludeEntitiesPattern) Sets excludeEntitiesPattern property.
void	setIncludeEntities(String includeEntitiesPattern) Sets includeEntitiesPattern property.
void	setMakepairs(boolean makepairs) Sets makepairs property.
void	setMap(File map) Sets the map.
void	setMode(String mode) Sets mode property.
void	setOutputPattern(String outputPattern) Sets outputPattern property.
void	setOverwrite(boolean overwrite) Sets overwrite property.
void	setQuerySupertemplate(String querysupertemplate) Sets querysupertemplate property.
void	setQueryTemplate(String querytemplate) Sets querytemplate property.
void	setSuperpkg(String superpkg) Sets superpkg property.
void	setSupertemplate(String supertemplate) Sets supertemplate property.
void	setTemplate(String template) Sets template property.
void	setUsepkgpath(boolean usepkgpath) Sets usepkgpath property.
protected void	validateAttributes() Validates attributes that are not related to internal DefaultClassGenerator.

Methods inherited from class org.apache.cayenne.tools.CayenneTask

getAdapter, loadDataMap, setAdapter, setClasspath, setClasspathRef, setDriver, setPassword, setUrl, setUserName

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

includeEntitiesPattern

protected String includeEntitiesPattern

excludeEntitiesPattern

protected String excludeEntitiesPattern

vppConfig

protected foundrylogic.vpp.VPPConfig vppConfig

map

protected File map

additionalMaps

protected File[] additionalMaps

client

protected boolean client

destDir

protected File destDir

encoding

protected String encoding

makepairs

protected boolean makepairs

mode

protected String mode

outputPattern

protected String outputPattern

overwrite

protected boolean overwrite

superpkg

protected String superpkg

supertemplate

protected String supertemplate

template

protected String template

embeddabletemplate

protected String embeddabletemplate

embeddablesupertemplate

protected String embeddablesupertemplate

querytemplate

protected String querytemplate

querysupertemplate

protected String querysupertemplate

usepkgpath

protected boolean usepkgpath

Constructor Detail

CayenneGeneratorTask

public CayenneGeneratorTask()

Method Detail

getVppContext

protected org.apache.velocity.VelocityContext getVppContext()

createGeneratorAction

protected ClassGenerationAction createGeneratorAction()

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Executes the task. It will be called by ant framework.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

validateAttributes

protected void validateAttributes()
                           throws org.apache.tools.ant.BuildException

Validates attributes that are not related to internal DefaultClassGenerator. Throws BuildException if attributes are invalid.

Throws:

org.apache.tools.ant.BuildException

setMap

public void setMap(File map)

Sets the map.

Overrides:

setMap in class CayenneTask

Parameters:

map - The map to set

setAdditionalMaps

public void setAdditionalMaps(org.apache.tools.ant.types.Path additionalMapsPath)

Sets the additional DataMaps.

Parameters:

additionalMapsPath - The additional DataMaps to set

setDestDir

public void setDestDir(File destDir)

Sets the destDir.

setOverwrite

public void setOverwrite(boolean overwrite)

Sets overwrite property.

setMakepairs

public void setMakepairs(boolean makepairs)

Sets makepairs property.

setTemplate

public void setTemplate(String template)

Sets template property.

setSupertemplate

public void setSupertemplate(String supertemplate)

Sets supertemplate property.

setQueryTemplate

public void setQueryTemplate(String querytemplate)

Sets querytemplate property.

setQuerySupertemplate

public void setQuerySupertemplate(String querysupertemplate)

Sets querysupertemplate property.

setUsepkgpath

public void setUsepkgpath(boolean usepkgpath)

Sets usepkgpath property.

setSuperpkg

public void setSuperpkg(String superpkg)

Sets superpkg property.

setClient

public void setClient(boolean client)

Sets client property.

setEncoding

public void setEncoding(String encoding)

Sets encoding property that allows to generate files using non-default encoding.

setExcludeEntities

public void setExcludeEntities(String excludeEntitiesPattern)

Sets excludeEntitiesPattern property.

setIncludeEntities

public void setIncludeEntities(String includeEntitiesPattern)

Sets includeEntitiesPattern property.

setOutputPattern

public void setOutputPattern(String outputPattern)

Sets outputPattern property.

setMode

public void setMode(String mode)

Sets mode property.

setEmbeddabletemplate

public void setEmbeddabletemplate(String embeddabletemplate)

setEmbeddablesupertemplate

public void setEmbeddablesupertemplate(String embeddablesupertemplate)

createConfig

public Object createConfig()

Provides a VPPConfig object to configure. (Written with createConfig() instead of addConfig() to avoid run-time dependency on VPP).