org.apache.openjpa.jdbc.ant

Class ReverseMappingToolTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

org.apache.openjpa.lib.ant.AbstractTask

org.apache.openjpa.jdbc.ant.ReverseMappingToolTask

All Implemented Interfaces:

Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer

public class ReverseMappingToolTask
extends AbstractTask

Executes the ReverseMappingTool on the specified XML files. This task can take the following arguments:

• package
• directory
• useSchemaName
• useSchemaElement
• useForeignKeyName
• nullableAsObject
• blobAsObject
• typeMap
• primaryKeyOnJoin
• useDatastoreIdentity
• useBuiltinIdentityClass
• detachable
• inverseRelations
• discriminatorStrategy
• versionStrategy
• innerIdentityClasses
• identityClassSuffix
• metadata
• customizerClass
• customizerProperties

The task also accepts an embedded codeFormat element with attributes for the bean properties of the CodeFormat.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReverseMappingToolTask.AccessType
static class	ReverseMappingToolTask.Level

Field Summary

Fields

Modifier and Type	Field and Description
protected String	customizerClass
protected String	customizerProperties
protected String	dirName
protected ReverseMappingTool.Flags	flags
protected String	typeMap

Fields inherited from class org.apache.openjpa.lib.ant.AbstractTask

classpath, fileSets, haltOnError, isolate, useParent

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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
ReverseMappingToolTask() Default constructor.

Method Summary

Modifier and Type	Method and Description
Object	createCodeFormat()
protected void	executeOn(String[] files) Perform the task action on the given files.
protected ConfigurationImpl	newConfiguration() Implement this method to return a configuration object for the product in use.
void	setAccessType(ReverseMappingToolTask.AccessType accessType) Whether to use field or property-based access on generated code.
void	setBlobAsObject(boolean blobAsObject) Set whether to represent blob columns as Java objects rather than byte[] fields.
void	setCustomizerClass(String customizerClass) Set a customizer class to use.
void	setCustomizerProperties(String customizerProperties) Set a properties file to pass to the customizer class.
void	setDetachable(boolean detachable) Set whether to make generated classes detachable.
void	setDirectory(String dirName) Set the output directory for the generated classes.
void	setDiscriminatorStrategy(String discStrat) Default discriminator strategy for base class mappings.
void	setGenerateAnnotations(boolean genAnnotations) Whether to generate annotations along with generated code.
void	setIdentityClassSuffix(String suffix) The suffix to use to create the identity class name for a class, or for inner classes, the name of the inner class.
void	setInnerIdentityClasses(boolean innerAppId) Whether or not to generate application identity classes as inner classes.
void	setInverseRelations(boolean inverseRelations) Set whether to generate inverse 1-many/1-1 relations for all many-1/1-1 relations.
void	setMetadata(ReverseMappingToolTask.Level level) Set the level of the generated metadata.
void	setNullableAsObject(boolean nullableAsObject) Set whether to represent nullable columns as primitive wrappers.
void	setPackage(String pkg) Set the package name for the generated classes.
void	setPrimaryKeyOnJoin(boolean primaryKeyOnJoin) Set whether to allow primary keys on join tables.
void	setTypeMap(String typeMap) Set the SQL type map overrides.
void	setUseBuiltinIdentityClass(boolean useBuiltinIdentityClass) Set whether to use single field identity where possible.
void	setUseDataStoreIdentity(boolean useDataStoreIdentity) Set whether to use datastore identity by default.
void	setUseForeignKeyName(boolean useForeignKeyName) Set whether to use foreign key names to name relations.
void	setUseGenericCollections(boolean useGenericCollections) Set whether to use generic collections on one-to-many and many-to-many relations instead of untyped collections.
void	setUseSchemaElement(boolean useSchemaElement) Set whether to use the schema name in generated files
void	setUseSchemaName(boolean useSchemaName) Set whether to use the schema name when naming the classes.
void	setVersionStrategy(String versionStrat) Default version strategy for base class mappings.

Methods inherited from class org.apache.openjpa.lib.ant.AbstractTask

addFileset, assertFiles, createClasspath, createConfig, execute, getClassLoader, getConfiguration, setClasspath, setHaltOnError, setIsolate, setUseParentClassloader

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

Methods inherited from class java.lang.Object

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

Field Detail

flags

protected ReverseMappingTool.Flags flags

dirName

protected String dirName

typeMap

protected String typeMap

customizerProperties

protected String customizerProperties

customizerClass

protected String customizerClass

Constructor Detail

ReverseMappingToolTask

public ReverseMappingToolTask()

Default constructor.

Method Detail

setPackage

public void setPackage(String pkg)

Set the package name for the generated classes.

setDirectory

public void setDirectory(String dirName)

Set the output directory for the generated classes.

setUseSchemaName

public void setUseSchemaName(boolean useSchemaName)

Set whether to use the schema name when naming the classes.

setUseSchemaElement

public void setUseSchemaElement(boolean useSchemaElement)

Set whether to use the schema name in generated files

setUseForeignKeyName

public void setUseForeignKeyName(boolean useForeignKeyName)

Set whether to use foreign key names to name relations.

setNullableAsObject

public void setNullableAsObject(boolean nullableAsObject)

Set whether to represent nullable columns as primitive wrappers.

setBlobAsObject

public void setBlobAsObject(boolean blobAsObject)

Set whether to represent blob columns as Java objects rather than byte[] fields.

setUseGenericCollections

public void setUseGenericCollections(boolean useGenericCollections)

Set whether to use generic collections on one-to-many and many-to-many relations instead of untyped collections.

setTypeMap

public void setTypeMap(String typeMap)

Set the SQL type map overrides.

setPrimaryKeyOnJoin

public void setPrimaryKeyOnJoin(boolean primaryKeyOnJoin)

Set whether to allow primary keys on join tables.

setUseDataStoreIdentity

public void setUseDataStoreIdentity(boolean useDataStoreIdentity)

Set whether to use datastore identity by default.

setUseBuiltinIdentityClass

public void setUseBuiltinIdentityClass(boolean useBuiltinIdentityClass)

Set whether to use single field identity where possible.

setInverseRelations

public void setInverseRelations(boolean inverseRelations)

Set whether to generate inverse 1-many/1-1 relations for all many-1/1-1 relations.

setDetachable

public void setDetachable(boolean detachable)

Set whether to make generated classes detachable.

setDiscriminatorStrategy

public void setDiscriminatorStrategy(String discStrat)

Default discriminator strategy for base class mappings.

setVersionStrategy

public void setVersionStrategy(String versionStrat)

Default version strategy for base class mappings.

setInnerIdentityClasses

public void setInnerIdentityClasses(boolean innerAppId)

Whether or not to generate application identity classes as inner classes.

setIdentityClassSuffix

public void setIdentityClassSuffix(String suffix)

The suffix to use to create the identity class name for a class, or for inner classes, the name of the inner class.

setMetadata

public void setMetadata(ReverseMappingToolTask.Level level)

Set the level of the generated metadata.

setGenerateAnnotations

public void setGenerateAnnotations(boolean genAnnotations)

Whether to generate annotations along with generated code. Defaults to false.

setAccessType

public void setAccessType(ReverseMappingToolTask.AccessType accessType)

Whether to use field or property-based access on generated code. Defaults to field-based access.

setCustomizerClass

public void setCustomizerClass(String customizerClass)

Set a customizer class to use.

setCustomizerProperties

public void setCustomizerProperties(String customizerProperties)

Set a properties file to pass to the customizer class.

createCodeFormat

public Object createCodeFormat()

newConfiguration

protected ConfigurationImpl newConfiguration()

Description copied from class: AbstractTask

Implement this method to return a configuration object for the product in use.

Specified by:

newConfiguration in class AbstractTask

executeOn

protected void executeOn(String[] files)
                  throws Exception

Description copied from class: AbstractTask

Perform the task action on the given files.

Specified by:

executeOn in class AbstractTask

Throws:

Exception