org.jooq.util

Class JavaGenerator

java.lang.Object

org.jooq.util.JavaGenerator

All Implemented Interfaces:

Generator

Direct Known Subclasses:

DefaultGenerator

public class JavaGenerator
extends Object

A default implementation for code generation.

Replace this code with your own logic, if you need your database schema represented in a different way.

Note that you can also extend this class to generate POJO's or other stuff entirely independent of jOOQ.

Author:

Lukas Eder

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jooq.util.GeneratorStrategyWrapper	strategy

Constructor Summary

Constructors

Constructor and Description
JavaGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	empty(File file, String suffix) If file is a directory, recursively empty its children.
void	generate(Database db) Do the code generation
protected void	generateArray(SchemaDefinition schema, ArrayDefinition array)
protected void	generateArrays(SchemaDefinition schema)
protected void	generateDao(TableDefinition table)
boolean	generateDaos() Whether DAO's should be generated in addition to pojos
protected void	generateDaos(SchemaDefinition schema)
boolean	generateDeprecated() Whether deprecated code should be generated
protected void	generateEnum(EnumDefinition e)
protected void	generateEnums(SchemaDefinition schema)
boolean	generateGeneratedAnnotation() Whether the Generated annotation should be generated
boolean	generateGlobalObjectReferences() Whether global object references should be generated
boolean	generateImmutablePojos() Whether immutable POJO's should be generated in addition to records
boolean	generateInstanceFields() Whether instance fields should be generated (as opposed to static fields)
protected void	generateInterface(TableDefinition table)
boolean	generateInterfaces() Whether interfaces should be generated to be implemented by records and POJO's
protected void	generateInterfaces(SchemaDefinition schema)
boolean	generateJPAAnnotations() Whether POJO's and records should be annotated with JPA annotations
protected void	generatePackage(SchemaDefinition schema, PackageDefinition pkg)
protected void	generatePackages(SchemaDefinition schema)
protected void	generatePojo(TableDefinition table)
boolean	generatePojos() Whether POJO's should be generated in addition to records
protected void	generatePojos(SchemaDefinition schema)
protected void	generateRecord(TableDefinition table)
boolean	generateRecords() Whether TableRecords should be generated in addition to tables
protected void	generateRecords(SchemaDefinition schema)
boolean	generateRelations() Whether foreign key relations should be resolved
protected void	generateRelations(SchemaDefinition schema)
protected void	generateRoutine(SchemaDefinition schema, RoutineDefinition routine)
protected void	generateRoutines(SchemaDefinition schema)
protected void	generateSchema(SchemaDefinition schema)
protected void	generateSequences(SchemaDefinition schema)
protected void	generateTable(SchemaDefinition schema, TableDefinition table)
protected void	generateTableReferences(SchemaDefinition schema) Generating central static table access
protected void	generateTables(SchemaDefinition schema)
protected void	generateUDT(SchemaDefinition schema, UDTDefinition udt)
protected void	generateUDTRecord(UDTDefinition udt)
protected void	generateUDTRecords(SchemaDefinition schema) Generating UDT record classes
protected void	generateUDTReferences(SchemaDefinition schema) Generating central static udt access
protected void	generateUDTRoutines(SchemaDefinition schema)
protected void	generateUDTs(SchemaDefinition schema)
boolean	generateValidationAnnotations() Whether POJO's and records should be annotated with JSR-303 validation annotations
protected String	getExtendsNumberType(DataTypeDefinition type)
protected String	getJavaType(DataTypeDefinition type)
protected String	getJavaTypeReference(Database db, DataTypeDefinition type)
protected String	getNumberType(DataTypeDefinition type)
protected String	getNumberType(DataTypeDefinition type, String prefix)
protected String	getSimpleJavaType(DataTypeDefinition type)
GeneratorStrategy	getStrategy() Get this generator's underlying naming strategy
String	getTargetDirectory() The target directory
String	getTargetPackage()
protected String	getType(Database db, SchemaDefinition schema, String t, int p, int s, String u, String defaultType)
protected String	getTypeReference(Database db, SchemaDefinition schema, String t, int p, int s, int l, String u)
protected boolean	match(DataTypeDefinition type1, DataTypeDefinition type2)
protected void	printClassJavadoc(JavaWriter out, Definition definition)
protected void	printClassJavadoc(JavaWriter out, String comment)
protected void	printColumnJPAAnnotation(JavaWriter out, ColumnDefinition column)
protected void	printColumnValidationAnnotation(JavaWriter out, ColumnDefinition column)
protected void	printConvenienceMethodFunction(JavaWriter out, RoutineDefinition function, boolean instance)
protected void	printConvenienceMethodFunctionAsField(JavaWriter out, RoutineDefinition function, boolean parametersAsField)
protected void	printConvenienceMethodProcedure(JavaWriter out, RoutineDefinition procedure, boolean instance)
protected void	printForeignKey(JavaWriter out, int foreignKeyCounter, ForeignKeyDefinition foreignKey)
protected void	printFromAndInto(JavaWriter out, TableDefinition table)
protected void	printIdentity(JavaWriter out, int identityCounter, IdentityDefinition identity)
protected void	printJavadocParagraph(JavaWriter out, String comment, String indent) This method is used to add line breaks in lengthy javadocs
protected void	printPackage(JavaWriter out, Definition definition)
protected void	printPackage(JavaWriter out, Definition definition, GeneratorStrategy.Mode mode)
protected void	printRecordTypeMethod(JavaWriter out, Definition definition)
protected void	printRoutine(JavaWriter out, RoutineDefinition routine)
protected void	printSchemaReferences(JavaWriter out, List<? extends Definition> definitions, Class<?> type, boolean isGeneric)
protected void	printSingletonInstance(JavaWriter out, Definition definition)
protected void	printTableJPAAnnotation(JavaWriter out, TableDefinition table)
protected void	printUniqueKey(JavaWriter out, int uniqueKeyCounter, UniqueKeyDefinition uniqueKey)
void	setGenerateDaos(boolean generateDaos) Whether DAO's should be generated in addition to pojos
void	setGenerateDeprecated(boolean generateDeprecated) Whether deprecated code should be generated
void	setGenerateGeneratedAnnotation(boolean generateGeneratedAnnotation) Whether the Generated annotation should be generated
void	setGenerateGlobalObjectReferences(boolean generateGlobalObjectReferences) Whether global object references should be generated
void	setGenerateImmutablePojos(boolean generateImmutablePojos) Whether immutable POJO's should be generated in addition to records
void	setGenerateInstanceFields(boolean generateInstanceFields) Whether instance fields should be generated (as opposed to static fields)
void	setGenerateInterfaces(boolean generateInterfaces) Whether interfaces should be generated to be implemented by records and POJO's
void	setGenerateJPAAnnotations(boolean generateJPAAnnotations) Whether POJO's and records should be annotated with JPA annotations
void	setGeneratePojos(boolean generatePojos) Whether POJO's should be generated in addition to records
void	setGenerateRecords(boolean generateRecords) Whether TableRecords should be generated in addition to tables
void	setGenerateRelations(boolean generateRelations) Whether foreign key relations should be resolved
void	setGenerateValidationAnnotations(boolean generateValidationAnnotations) Whether POJO's and records should be annotated with JSR-303 validation annotations
void	setStrategy(GeneratorStrategy strategy) Set a naming strategy to this generator
void	setTargetDirectory(String directory) Initialise the target directory
void	setTargetPackage(String packageName) Initialise the target package name

Methods inherited from class java.lang.Object

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

Field Detail

strategy

protected org.jooq.util.GeneratorStrategyWrapper strategy

Constructor Detail

JavaGenerator

public JavaGenerator()

Method Detail

generate

public final void generate(Database db)

Description copied from interface: Generator

Do the code generation

generateRelations

protected void generateRelations(SchemaDefinition schema)

printIdentity

protected void printIdentity(JavaWriter out,
                 int identityCounter,
                 IdentityDefinition identity)

printUniqueKey

protected void printUniqueKey(JavaWriter out,
                  int uniqueKeyCounter,
                  UniqueKeyDefinition uniqueKey)

printForeignKey

protected void printForeignKey(JavaWriter out,
                   int foreignKeyCounter,
                   ForeignKeyDefinition foreignKey)

generateRecords

protected void generateRecords(SchemaDefinition schema)

generateRecord

protected void generateRecord(TableDefinition table)

generateInterfaces

protected void generateInterfaces(SchemaDefinition schema)

generateInterface

protected void generateInterface(TableDefinition table)

generateUDTs

protected void generateUDTs(SchemaDefinition schema)

generateUDT

protected void generateUDT(SchemaDefinition schema,
               UDTDefinition udt)

generateUDTRecords

protected void generateUDTRecords(SchemaDefinition schema)

Generating UDT record classes

generateUDTRecord

protected void generateUDTRecord(UDTDefinition udt)

generateUDTRoutines

protected void generateUDTRoutines(SchemaDefinition schema)

generateUDTReferences

protected void generateUDTReferences(SchemaDefinition schema)

Generating central static udt access

generateArrays

protected void generateArrays(SchemaDefinition schema)

generateArray

protected void generateArray(SchemaDefinition schema,
                 ArrayDefinition array)

generateEnums

protected void generateEnums(SchemaDefinition schema)

generateEnum

protected void generateEnum(EnumDefinition e)

generateRoutines

protected void generateRoutines(SchemaDefinition schema)

printRoutine

protected void printRoutine(JavaWriter out,
                RoutineDefinition routine)

generatePackages

protected void generatePackages(SchemaDefinition schema)

generatePackage

protected void generatePackage(SchemaDefinition schema,
                   PackageDefinition pkg)

generateTableReferences

protected void generateTableReferences(SchemaDefinition schema)

Generating central static table access

generateDaos

protected void generateDaos(SchemaDefinition schema)

generateDao

protected void generateDao(TableDefinition table)

generatePojos

protected void generatePojos(SchemaDefinition schema)

generatePojo

protected void generatePojo(TableDefinition table)

generateTables

protected void generateTables(SchemaDefinition schema)

generateTable

protected void generateTable(SchemaDefinition schema,
                 TableDefinition table)

generateSequences

protected void generateSequences(SchemaDefinition schema)

generateSchema

protected void generateSchema(SchemaDefinition schema)

printFromAndInto

protected void printFromAndInto(JavaWriter out,
                    TableDefinition table)

printSchemaReferences

protected void printSchemaReferences(JavaWriter out,
                         List<? extends Definition> definitions,
                         Class<?> type,
                         boolean isGeneric)

printTableJPAAnnotation

protected void printTableJPAAnnotation(JavaWriter out,
                           TableDefinition table)

printColumnJPAAnnotation

protected void printColumnJPAAnnotation(JavaWriter out,
                            ColumnDefinition column)

printColumnValidationAnnotation

protected void printColumnValidationAnnotation(JavaWriter out,
                                   ColumnDefinition column)

generateRoutine

protected void generateRoutine(SchemaDefinition schema,
                   RoutineDefinition routine)

printConvenienceMethodFunctionAsField

protected void printConvenienceMethodFunctionAsField(JavaWriter out,
                                         RoutineDefinition function,
                                         boolean parametersAsField)

printConvenienceMethodFunction

protected void printConvenienceMethodFunction(JavaWriter out,
                                  RoutineDefinition function,
                                  boolean instance)

printConvenienceMethodProcedure

protected void printConvenienceMethodProcedure(JavaWriter out,
                                   RoutineDefinition procedure,
                                   boolean instance)

printRecordTypeMethod

protected void printRecordTypeMethod(JavaWriter out,
                         Definition definition)

printSingletonInstance

protected void printSingletonInstance(JavaWriter out,
                          Definition definition)

printClassJavadoc

protected void printClassJavadoc(JavaWriter out,
                     Definition definition)

printClassJavadoc

protected void printClassJavadoc(JavaWriter out,
                     String comment)

printJavadocParagraph

protected void printJavadocParagraph(JavaWriter out,
                         String comment,
                         String indent)

This method is used to add line breaks in lengthy javadocs

printPackage

protected void printPackage(JavaWriter out,
                Definition definition)

printPackage

protected void printPackage(JavaWriter out,
                Definition definition,
                GeneratorStrategy.Mode mode)

getExtendsNumberType

protected String getExtendsNumberType(DataTypeDefinition type)

getNumberType

protected String getNumberType(DataTypeDefinition type)

getNumberType

protected String getNumberType(DataTypeDefinition type,
                   String prefix)

getSimpleJavaType

protected String getSimpleJavaType(DataTypeDefinition type)

getJavaTypeReference

protected String getJavaTypeReference(Database db,
                          DataTypeDefinition type)

getJavaType

protected String getJavaType(DataTypeDefinition type)

getType

protected String getType(Database db,
             SchemaDefinition schema,
             String t,
             int p,
             int s,
             String u,
             String defaultType)

getTypeReference

protected String getTypeReference(Database db,
                      SchemaDefinition schema,
                      String t,
                      int p,
                      int s,
                      int l,
                      String u)

match

protected boolean match(DataTypeDefinition type1,
            DataTypeDefinition type2)

setStrategy

public void setStrategy(GeneratorStrategy strategy)

Description copied from interface: Generator

Set a naming strategy to this generator

Specified by:

setStrategy in interface Generator

getStrategy

public GeneratorStrategy getStrategy()

Description copied from interface: Generator

Get this generator's underlying naming strategy

Specified by:

getStrategy in interface Generator

generateDeprecated

public boolean generateDeprecated()

Description copied from interface: Generator

Whether deprecated code should be generated

Specified by:

generateDeprecated in interface Generator

setGenerateDeprecated

public void setGenerateDeprecated(boolean generateDeprecated)

Description copied from interface: Generator

Whether deprecated code should be generated

Specified by:

setGenerateDeprecated in interface Generator

generateRelations

public boolean generateRelations()

Description copied from interface: Generator

Whether foreign key relations should be resolved

Specified by:

generateRelations in interface Generator

setGenerateRelations

public void setGenerateRelations(boolean generateRelations)

Description copied from interface: Generator

Whether foreign key relations should be resolved

Specified by:

setGenerateRelations in interface Generator

generateInstanceFields

public boolean generateInstanceFields()

Description copied from interface: Generator

Whether instance fields should be generated (as opposed to static fields)

Specified by:

generateInstanceFields in interface Generator

setGenerateInstanceFields

public void setGenerateInstanceFields(boolean generateInstanceFields)

Description copied from interface: Generator

Whether instance fields should be generated (as opposed to static fields)

Specified by:

setGenerateInstanceFields in interface Generator

generateGeneratedAnnotation

public boolean generateGeneratedAnnotation()

Description copied from interface: Generator

Whether the Generated annotation should be generated

Specified by:

generateGeneratedAnnotation in interface Generator

setGenerateGeneratedAnnotation

public void setGenerateGeneratedAnnotation(boolean generateGeneratedAnnotation)

Description copied from interface: Generator

Whether the Generated annotation should be generated

Specified by:

setGenerateGeneratedAnnotation in interface Generator

generateRecords

public boolean generateRecords()

Description copied from interface: Generator

Whether TableRecords should be generated in addition to tables

Specified by:

generateRecords in interface Generator

setGenerateRecords

public void setGenerateRecords(boolean generateRecords)

Description copied from interface: Generator

Whether TableRecords should be generated in addition to tables

Specified by:

setGenerateRecords in interface Generator

generatePojos

public boolean generatePojos()

Description copied from interface: Generator

Whether POJO's should be generated in addition to records

Specified by:

generatePojos in interface Generator

setGeneratePojos

public void setGeneratePojos(boolean generatePojos)

Description copied from interface: Generator

Whether POJO's should be generated in addition to records

Specified by:

setGeneratePojos in interface Generator

generateImmutablePojos

public boolean generateImmutablePojos()

Description copied from interface: Generator

Whether immutable POJO's should be generated in addition to records

Specified by:

generateImmutablePojos in interface Generator

setGenerateImmutablePojos

public void setGenerateImmutablePojos(boolean generateImmutablePojos)

Description copied from interface: Generator

Whether immutable POJO's should be generated in addition to records

Specified by:

setGenerateImmutablePojos in interface Generator

generateInterfaces

public boolean generateInterfaces()

Description copied from interface: Generator

Whether interfaces should be generated to be implemented by records and POJO's

Specified by:

generateInterfaces in interface Generator

setGenerateInterfaces

public void setGenerateInterfaces(boolean generateInterfaces)

Description copied from interface: Generator

Whether interfaces should be generated to be implemented by records and POJO's

Specified by:

setGenerateInterfaces in interface Generator

generateDaos

public boolean generateDaos()

Description copied from interface: Generator

Whether DAO's should be generated in addition to pojos

Specified by:

generateDaos in interface Generator

setGenerateDaos

public void setGenerateDaos(boolean generateDaos)

Description copied from interface: Generator

Whether DAO's should be generated in addition to pojos

Specified by:

setGenerateDaos in interface Generator

generateJPAAnnotations

public boolean generateJPAAnnotations()

Description copied from interface: Generator

Whether POJO's and records should be annotated with JPA annotations

Specified by:

generateJPAAnnotations in interface Generator

setGenerateJPAAnnotations

public void setGenerateJPAAnnotations(boolean generateJPAAnnotations)

Description copied from interface: Generator

Whether POJO's and records should be annotated with JPA annotations

Specified by:

setGenerateJPAAnnotations in interface Generator

generateValidationAnnotations

public boolean generateValidationAnnotations()

Description copied from interface: Generator

Whether POJO's and records should be annotated with JSR-303 validation annotations

Specified by:

generateValidationAnnotations in interface Generator

setGenerateValidationAnnotations

public void setGenerateValidationAnnotations(boolean generateValidationAnnotations)

Description copied from interface: Generator

Whether POJO's and records should be annotated with JSR-303 validation annotations

Specified by:

setGenerateValidationAnnotations in interface Generator

generateGlobalObjectReferences

public boolean generateGlobalObjectReferences()

Description copied from interface: Generator

Whether global object references should be generated

Specified by:

generateGlobalObjectReferences in interface Generator

setGenerateGlobalObjectReferences

public void setGenerateGlobalObjectReferences(boolean generateGlobalObjectReferences)

Description copied from interface: Generator

Whether global object references should be generated

Specified by:

setGenerateGlobalObjectReferences in interface Generator

setTargetDirectory

public void setTargetDirectory(String directory)

Description copied from interface: Generator

Initialise the target directory

Specified by:

setTargetDirectory in interface Generator

getTargetDirectory

public String getTargetDirectory()

Description copied from interface: Generator

The target directory

Specified by:

getTargetDirectory in interface Generator

setTargetPackage

public void setTargetPackage(String packageName)

Description copied from interface: Generator

Initialise the target package name

Specified by:

setTargetPackage in interface Generator

getTargetPackage

public String getTargetPackage()

Specified by:

getTargetPackage in interface Generator

Returns:

Get the target package for the current configuration

empty

protected void empty(File file,
         String suffix)

If file is a directory, recursively empty its children. If file is a file, delete it