io.github.jklingsporn.vertx.jooq.generate

Class VertxGenerator

java.lang.Object

org.jooq.codegen.JavaGenerator

io.github.jklingsporn.vertx.jooq.generate.VertxGenerator

All Implemented Interfaces:

org.jooq.codegen.Generator

Direct Known Subclasses:

DelegatingVertxGenerator

public abstract class VertxGenerator
extends org.jooq.codegen.JavaGenerator

Created by jklingsporn on 17.10.16. Extension of the jOOQ's JavaGenerator. By default, it generates POJO's that have a #fromJson and a #toJson-method which takes/generates a JsonObject out of the generated POJO. When you've enabled Interface-generation, these methods are added to the generated Interface as default-methods. Besides these method there is also a constructor generated which takes a JsonObject. It also generates DAOs which implement VertxDAO and allow you to execute CRUD-operations asynchronously.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jooq.codegen.GeneratorStrategyWrapper	strategy
protected boolean	targetClean
protected String	targetEncoding
protected VertxGeneratorStrategy	vertxGeneratorStrategy

Constructor Summary

Constructors

Constructor and Description
VertxGenerator()
VertxGenerator(boolean generateJson)

Method Summary

Modifier and Type	Method and Description
protected void	empty(File arg0, String arg1)
protected void	empty(File arg0, String arg1, Set<File> arg2, Set<File> arg3)
protected void	generateDao(org.jooq.meta.TableDefinition table, org.jooq.codegen.JavaWriter out1) copied from jOOQ's JavaGenerator
protected void	generateDaos(org.jooq.meta.SchemaDefinition schema)
protected void	generateFetchMethods(org.jooq.meta.TableDefinition table, org.jooq.codegen.JavaWriter out) Copied (more ore less) from JavaGenerator.
protected void	generateFindManyByMethods(org.jooq.codegen.JavaWriter out, String pType, String colName, String colClass, String colType, String colIdentifier)
protected void	generateFindOneByMethods(org.jooq.codegen.JavaWriter out, String pType, String colName, String colClass, String colType, String colIdentifier)
protected void	generateInterfaceClassFooter(org.jooq.meta.TableDefinition table, org.jooq.codegen.JavaWriter out)
protected void	generatePojoClassFooter(org.jooq.meta.TableDefinition table, org.jooq.codegen.JavaWriter out)
protected void	generateRecordClassFooter(org.jooq.meta.TableDefinition table, org.jooq.codegen.JavaWriter out)
String	getJavaType(org.jooq.meta.DataTypeDefinition type)
protected String	getJsonKeyName(org.jooq.meta.TypedElementDefinition<?> column)
String	getKeyType(org.jooq.meta.UniqueKeyDefinition key) Copied from JavaGenerator
protected Class<?>	getPgConverterFromType(String columnType, String converter)
VertxGeneratorStrategy	getVertxGeneratorStrategy()
protected boolean	handleCustomTypeFromJson(org.jooq.meta.TypedElementDefinition<?> column, String setter, String columnType, String javaMemberName, org.jooq.codegen.JavaWriter out) Overwrite this method to handle your custom type.
protected boolean	handleCustomTypeToJson(org.jooq.meta.TypedElementDefinition<?> column, String getter, String columnType, String javaMemberName, org.jooq.codegen.JavaWriter out) Overwrite this method to handle your custom type.
boolean	isEnum(org.jooq.meta.TableDefinition table, org.jooq.meta.TypedElementDefinition<?> column)
protected boolean	isType(String columnType, Class<?> clazz)
protected org.jooq.codegen.JavaWriter	newJavaWriter(File file)
protected void	overwriteDAOMethods(org.jooq.codegen.JavaWriter out, String className, String tableIdentifier, String rType, String pType, String tType) Can be used to overwrite certain methods, e.g.
protected void	printPackage(org.jooq.codegen.JavaWriter out, org.jooq.meta.Definition definition, org.jooq.codegen.GeneratorStrategy.Mode mode)
protected String	renderDaoExtendsClassName()
protected abstract String	renderDAOInterface(String rType, String pType, String tType)
protected abstract String	renderExecType()
protected abstract String	renderFindManyType(String pType)
protected abstract String	renderFindOneType(String pType)
protected String	renderFQVertxName()
protected abstract String	renderInsertReturningType(String tType)
protected abstract String	renderQueryExecutor(String rType, String pType, String tType)
void	setStrategy(org.jooq.codegen.GeneratorStrategy strategy)
protected void	writeDAOClassAnnotation(org.jooq.codegen.JavaWriter out) Write annotations on the DAOs class signature.
protected abstract void	writeDAOConstructor(org.jooq.codegen.JavaWriter out, String className, String tableIdentifier, String rType, String pType, String tType, String schema) Write the DAO constructor.
protected void	writeDAOConstructorAnnotation(org.jooq.codegen.JavaWriter out) Write annotations on the DAOs constructor.
protected void	writeDAOImports(org.jooq.codegen.JavaWriter out) Write imports in the DAO.
protected Collection<org.jooq.codegen.JavaWriter>	writeExtraData(org.jooq.meta.SchemaDefinition definition, Function<File,org.jooq.codegen.JavaWriter> writerGenerator) Write some extra data during code generation

Methods inherited from class org.jooq.codegen.JavaGenerator

closeJavaWriter, escapeEntities, generate, generateArray, generateArray, generateArrayClassFooter, generateArrayClassJavadoc, generateArrays, generateCatalog, generateCatalog, generateCatalogClassFooter, generateCatalogClassJavadoc, generateDao, generateDaoClassFooter, generateDaoClassJavadoc, generateDomain, generateDomain, generateDomainClassFooter, generateDomainClassJavadoc, generateDomains, generateEmbeddable, generateEmbeddableClassFooter, generateEmbeddableClassJavadoc, generateEmbeddableGetter, generateEmbeddables, generateEmbeddableSetter, generateEnum, generateEnum, generateEnumClassFooter, generateEnumClassJavadoc, generateEnums, generateIndexes, generateInterface, generateInterface, generateInterfaceClassJavadoc, generateInterfaceGetter, generateInterfaces, generateInterfaceSetter, generatePackage, generatePackage, generatePackageClassFooter, generatePackageClassJavadoc, generatePackages, generatePojo, generatePojo, generatePojoClassJavadoc, generatePojoCopyConstructor, generatePojoDefaultConstructor, generatePojoEqualsAndHashCode, generatePojoGetter, generatePojoMultiConstructor, generatePojos, generatePojoSetter, generatePojoToString, generateRecord, generateRecord, generateRecordClassJavadoc, generateRecordGetter, generateRecords, generateRecordSetter, generateRelations, generateRoutine, generateRoutine, generateRoutineClassFooter, generateRoutineClassJavadoc, generateRoutines, generateSchema, generateSchema, generateSchemaClassFooter, generateSchemaClassJavadoc, generateSequences, generateTable, generateTable, generateTableClassFooter, generateTableClassJavadoc, generateTableReferences, generateTables, generateUDT, generateUDT, generateUDTClassFooter, generateUDTClassJavadoc, generateUDTInterface, generateUDTInterface, generateUDTInterfaceClassFooter, generateUDTInterfaceClassJavadoc, generateUDTInterfaceGetter, generateUDTInterfaces, generateUDTInterfaceSetter, generateUDTPojo, generateUDTPojo, generateUDTPojoClassFooter, generateUDTPojoClassJavadoc, generateUDTPojoGetter, generateUDTPojos, generateUDTPojoSetter, generateUDTRecord, generateUDTRecord, generateUDTRecordClassFooter, generateUDTRecordClassJavadoc, generateUDTRecordGetter, generateUDTRecords, generateUDTRecordSetter, generateUDTReferences, generateUDTRoutines, generateUDTs, getExtendsNumberType, getFile, getFile, getJavaType, getJavaTypeReference, getNumberType, getNumberType, getSimpleJavaType, getType, getType, getType, getType, getTypeReference, match, printClassAnnotations, printClassAnnotations, printClassJavadoc, printClassJavadoc, printColumnJPAAnnotation, printColumnValidationAnnotation, printConstant, printConvenienceMethodFunction, printConvenienceMethodFunctionAsField, printConvenienceMethodProcedure, printConvenienceMethodTableValuedFunction, printConvenienceMethodTableValuedFunctionAsField, printForeignKey, printFromAndInto, printIdentity, printIndex, printJavadocParagraph, printNonnullAnnotation, printNullableAnnotation, printPackage, printPackageComment, printParagraph, printRecordTypeMethod, printReferences, printRoutine, printSingletonInstance, printTableJPAAnnotation, printTableValuedFunction, printUniqueKey, refExtendsNumberType, refNumberType, resolver, resolver

Methods inherited from class java.lang.Object

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

Field Detail

vertxGeneratorStrategy

protected VertxGeneratorStrategy vertxGeneratorStrategy

strategy

protected org.jooq.codegen.GeneratorStrategyWrapper strategy

targetEncoding

protected String targetEncoding

targetClean

protected boolean targetClean

Constructor Detail

VertxGenerator

public VertxGenerator()

VertxGenerator

public VertxGenerator(boolean generateJson)

Method Detail

handleCustomTypeFromJson

protected boolean handleCustomTypeFromJson(org.jooq.meta.TypedElementDefinition<?> column,
                                           String setter,
                                           String columnType,
                                           String javaMemberName,
                                           org.jooq.codegen.JavaWriter out)

Overwrite this method to handle your custom type. This is needed especially when you have custom converters.

Parameters:

column - the column definition

setter - the setter name

columnType - the type of the column

javaMemberName - the java member name

out - the JavaWriter

Returns:

true if the column was handled.

See Also:

generateFromJson(TableDefinition, JavaWriter, org.jooq.codegen.GeneratorStrategy.Mode)

handleCustomTypeToJson

protected boolean handleCustomTypeToJson(org.jooq.meta.TypedElementDefinition<?> column,
                                         String getter,
                                         String columnType,
                                         String javaMemberName,
                                         org.jooq.codegen.JavaWriter out)

Overwrite this method to handle your custom type. This is needed especially when you have custom converters.

Parameters:

column - the column definition

getter - the getter name

columnType - the type of the column

javaMemberName - the java member name

out - the JavaWriter

Returns:

true if the column was handled.

See Also:

generateToJson(TableDefinition, JavaWriter, org.jooq.codegen.GeneratorStrategy.Mode)

renderFindOneType

protected abstract String renderFindOneType(String pType)

Parameters:

pType - the POJO type

Returns:

the type returned by QueryExecutor#insertReturningPrimary.

renderFindManyType

protected abstract String renderFindManyType(String pType)

Parameters:

pType - the POJO type

Returns:

the type returned by QueryExecutor#findMany.

renderExecType

protected abstract String renderExecType()

Returns:

the type returned by QueryExecutor#execute.

renderInsertReturningType

protected abstract String renderInsertReturningType(String tType)

Parameters:

tType - the primary key type

Returns:

the type returned by QueryExecutor#insertReturningPrimary.

renderQueryExecutor

protected abstract String renderQueryExecutor(String rType,
                                              String pType,
                                              String tType)

Parameters:

rType - the record type

pType - the POJO type

tType - the primary key type

Returns:

the QueryExecutor used for query execution.

renderDAOInterface

protected abstract String renderDAOInterface(String rType,
                                             String pType,
                                             String tType)

Parameters:

rType - the record type

pType - the POJO type

tType - the primary key type

Returns:

the interface implemented by the generated DAO.

writeDAOConstructor

protected abstract void writeDAOConstructor(org.jooq.codegen.JavaWriter out,
                                            String className,
                                            String tableIdentifier,
                                            String rType,
                                            String pType,
                                            String tType,
                                            String schema)

Write the DAO constructor.

Parameters:

out - the JavaWriter

className - the class name of the generated DAO

tableIdentifier - the table identifier

rType - the record type

pType - the POJO type

tType - the primary key type

schema -

writeDAOImports

protected void writeDAOImports(org.jooq.codegen.JavaWriter out)

Write imports in the DAO.

Parameters:

out - the JavaWriter

writeDAOClassAnnotation

protected void writeDAOClassAnnotation(org.jooq.codegen.JavaWriter out)

Write annotations on the DAOs class signature.

Parameters:

out - the JavaWriter

writeDAOConstructorAnnotation

protected void writeDAOConstructorAnnotation(org.jooq.codegen.JavaWriter out)

Write annotations on the DAOs constructor.

Parameters:

out - the JavaWriter

overwriteDAOMethods

protected void overwriteDAOMethods(org.jooq.codegen.JavaWriter out,
                                   String className,
                                   String tableIdentifier,
                                   String rType,
                                   String pType,
                                   String tType)

Can be used to overwrite certain methods, e.g. AsyncXYZ-strategies shouldn't allow insertReturning for non-numeric or compound primary keys due to limitations of the AsyncMySQL/Postgres client.

Parameters:

out - the JavaWriter

className - the class name of the generated DAO

tableIdentifier - the table identifier

rType - the record type

pType - the POJO type

tType - the primary key type

renderDaoExtendsClassName

protected String renderDaoExtendsClassName()

Returns:

the fully qualified class name of the DAO's extension

renderFQVertxName

protected String renderFQVertxName()

Returns:

the fully qualified class name of the vertx instance

writeExtraData

protected Collection<org.jooq.codegen.JavaWriter> writeExtraData(org.jooq.meta.SchemaDefinition definition,
                                                                 Function<File,org.jooq.codegen.JavaWriter> writerGenerator)

Write some extra data during code generation

Parameters:

definition - the schema

writerGenerator - a Function that returns a new JavaWriter based on a File.

Returns:

a Collection of JavaWriters with data init.

generatePojoClassFooter

protected void generatePojoClassFooter(org.jooq.meta.TableDefinition table,
                                       org.jooq.codegen.JavaWriter out)

Overrides:

generatePojoClassFooter in class org.jooq.codegen.JavaGenerator

generateInterfaceClassFooter

protected void generateInterfaceClassFooter(org.jooq.meta.TableDefinition table,
                                            org.jooq.codegen.JavaWriter out)

Overrides:

generateInterfaceClassFooter in class org.jooq.codegen.JavaGenerator

generateRecordClassFooter

protected void generateRecordClassFooter(org.jooq.meta.TableDefinition table,
                                         org.jooq.codegen.JavaWriter out)

Overrides:

generateRecordClassFooter in class org.jooq.codegen.JavaGenerator

newJavaWriter

protected org.jooq.codegen.JavaWriter newJavaWriter(File file)

Overrides:

newJavaWriter in class org.jooq.codegen.JavaGenerator

printPackage

protected void printPackage(org.jooq.codegen.JavaWriter out,
                            org.jooq.meta.Definition definition,
                            org.jooq.codegen.GeneratorStrategy.Mode mode)

Overrides:

printPackage in class org.jooq.codegen.JavaGenerator

generateDaos

protected void generateDaos(org.jooq.meta.SchemaDefinition schema)

Overrides:

generateDaos in class org.jooq.codegen.JavaGenerator

isEnum

public boolean isEnum(org.jooq.meta.TableDefinition table,
                      org.jooq.meta.TypedElementDefinition<?> column)

isType

protected boolean isType(String columnType,
                         Class<?> clazz)

getPgConverterFromType

protected Class<?> getPgConverterFromType(String columnType,
                                          String converter)

getJavaType

public String getJavaType(org.jooq.meta.DataTypeDefinition type)

Overrides:

getJavaType in class org.jooq.codegen.JavaGenerator

getJsonKeyName

protected String getJsonKeyName(org.jooq.meta.TypedElementDefinition<?> column)

Parameters:

column -

Returns:

the JSON-key name of this column. Starting from version 2.4.0 this defaults to the name of that database column. There are different ways to change this behaviour:
- subclass and override this method
- subclass and override VertxGeneratorStrategy#getJsonKeyName
- plug-in a custom GeneratorStrategy into the VertxGeneratorStrategy that returns a strategy of your choice for GeneratorStrategy#getJavaMemberName(column, DefaultGeneratorStrategy.Mode.POJO)

setStrategy

public void setStrategy(org.jooq.codegen.GeneratorStrategy strategy)

Specified by:

setStrategy in interface org.jooq.codegen.Generator

Overrides:

setStrategy in class org.jooq.codegen.JavaGenerator

getVertxGeneratorStrategy

public VertxGeneratorStrategy getVertxGeneratorStrategy()

Returns:

the VertxGeneratorStrategy used. Unfortunately getStrategy() cannot be used because every GeneratorStrategy is wrapped into a package local jOOQ-class, so casting doesn't work.

generateFetchMethods

protected void generateFetchMethods(org.jooq.meta.TableDefinition table,
                                    org.jooq.codegen.JavaWriter out)

Copied (more ore less) from JavaGenerator. Generates fetchByCYZ- and fetchOneByCYZ-methods

Parameters:

table -

out -

generateFindOneByMethods

protected void generateFindOneByMethods(org.jooq.codegen.JavaWriter out,
                                        String pType,
                                        String colName,
                                        String colClass,
                                        String colType,
                                        String colIdentifier)

generateFindManyByMethods

protected void generateFindManyByMethods(org.jooq.codegen.JavaWriter out,
                                         String pType,
                                         String colName,
                                         String colClass,
                                         String colType,
                                         String colIdentifier)

getKeyType

public String getKeyType(org.jooq.meta.UniqueKeyDefinition key)

Copied from JavaGenerator

Parameters:

key -

Returns:

generateDao

protected void generateDao(org.jooq.meta.TableDefinition table,
                           org.jooq.codegen.JavaWriter out1)

copied from jOOQ's JavaGenerator

Overrides:

generateDao in class org.jooq.codegen.JavaGenerator

Parameters:

table -

out1 -

empty

protected void empty(File arg0,
                     String arg1)

empty

protected void empty(File arg0,
                     String arg1,
                     Set<File> arg2,
                     Set<File> arg3)