Package 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.

  • Field Details

  • Constructor Details

    • ReverseMappingToolTask

      public ReverseMappingToolTask()
      Default constructor.

  • Method Details

    • 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