Module org.jooq.codegen

Package org.jooq.codegen

Class DefaultGeneratorStrategy

java.lang.Object

org.jooq.codegen.AbstractGeneratorStrategy

org.jooq.codegen.DefaultGeneratorStrategy

All Implemented Interfaces:

GeneratorStrategy

Direct Known Subclasses:

JPrefixGeneratorStrategy, JVMArgsGeneratorStrategy, KeepNamesGeneratorStrategy, MatcherStrategy, PascalCaseGeneratorStrategy

public class DefaultGeneratorStrategy
extends AbstractGeneratorStrategy

The default naming strategy for the JavaGenerator

Author:

Lukas Eder

Nested Class Summary

Nested classes/interfaces inherited from interface org.jooq.codegen.GeneratorStrategy

GeneratorStrategy.Mode

Constructor Summary

Constructors

Constructor	Description
DefaultGeneratorStrategy()

Method Summary

Modifier and Type	Method	Description
String	getFileHeader(Definition definition, GeneratorStrategy.Mode mode)
String	getGlobalNamesFileHeader(Definition container, Class<? extends Definition> objectType)
String	getGlobalNamesJavaClassExtends(Definition container, Class<? extends Definition> objectType)
List<String>	getGlobalNamesJavaClassImplements(Definition container, Class<? extends Definition> objectType)
String	getGlobalNamesJavaClassName(Definition container, Class<? extends Definition> objectType)
String	getGlobalNamesJavaPackageName(Definition container, Class<? extends Definition> objectType)
String	getGlobalReferencesFileHeader(Definition container, Class<? extends Definition> objectType)
String	getGlobalReferencesJavaClassExtends(Definition container, Class<? extends Definition> objectType)
List<String>	getGlobalReferencesJavaClassImplements(Definition container, Class<? extends Definition> objectType)
String	getGlobalReferencesJavaClassName(Definition container, Class<? extends Definition> objectType)
String	getGlobalReferencesJavaPackageName(Definition container, Class<? extends Definition> objectType)
boolean	getInstanceFields()	Whether fields are instance fields (as opposed to static fields)
boolean	getJavaBeansGettersAndSetters()	Whether getters and setters should be generated JavaBeans style (or jOOQ style).
String	getJavaClassExtends(Definition definition, GeneratorStrategy.Mode mode)
List<String>	getJavaClassImplements(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaClassName(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaEnumLiteral(EnumDefinition definition, String literal)	This is applied to enum literals of a given EnumDefinition.
String	getJavaGetterName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in getters of a container.
boolean	getJavaGetterOverride(Definition definition, GeneratorStrategy.Mode mode)	Whether the GeneratorStrategy.getJavaGetterName(Definition, Mode) produces a method that overrides a member from a parent type unknown to jOOQ, e.g.
String	getJavaIdentifier(Definition definition)	This is applied to definitions that can result in reference static and instance members.
String	getJavaMemberName(Definition definition, GeneratorStrategy.Mode mode)	The "java member name" is applied where a definition is used as a member (for POJOs) or as a method argument (for setters).
boolean	getJavaMemberOverride(Definition definition, GeneratorStrategy.Mode mode)	Whether the GeneratorStrategy.getJavaMemberName(Definition, Mode) produces a member that overrides a member from a parent type unknown to jOOQ, e.g.
String	getJavaMethodName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in methods.
boolean	getJavaMethodOverride(Definition definition, GeneratorStrategy.Mode mode)	Whether the GeneratorStrategy.getJavaMethodName(Definition, Mode) produces a method that overrides a member from a parent type unknown to jOOQ, e.g.
String	getJavaPackageName(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaSetterName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in setters of a container.
boolean	getJavaSetterOverride(Definition definition, GeneratorStrategy.Mode mode)	Whether the GeneratorStrategy.getJavaSetterName(Definition, Mode) produces a method that overrides a member from a parent type unknown to jOOQ, e.g.
String	getOverloadSuffix(Definition definition, GeneratorStrategy.Mode mode, String overloadIndex)
String	getTargetDirectory()	The target directory
Language	getTargetLanguage()
Locale	getTargetLocale()
String	getTargetPackage()
boolean	getUseTableNameForUnambiguousFKs()	Whether names of unambiguous ForeignKeyDefinition should be based on the referenced TableDefinition.
void	setInstanceFields(boolean instanceFields)	Whether fields are instance fields (as opposed to static fields)
void	setJavaBeansGettersAndSetters(boolean javaBeansGettersAndSetters)	Whether getters and setters should be generated JavaBeans style (or jOOQ style).
void	setTargetDirectory(String directory)	Initialise the target directory
void	setTargetLanguage(Language targetLanguage)	Initialise the target language
void	setTargetLocale(Locale targetLocale)	Initialise the target locale
void	setTargetPackage(String packageName)	Initialise the target package name
void	setUseTableNameForUnambiguousFKs(boolean useTableNameForUnambiguousFKs)	Whether names of unambiguous ForeignKeyDefinition should be based on the referenced TableDefinition.

Methods inherited from class org.jooq.codegen.AbstractGeneratorStrategy

getFile, getFile, getFile, getFileHeader, getFileName, getFileName, getFileRoot, getFullJavaClassName, getFullJavaClassName, getFullJavaIdentifier, getFullJavaIdentifiers, getFullJavaIdentifiers, getGlobalNamesFile, getGlobalNamesFileName, getGlobalNamesFullJavaClassName, getGlobalReferencesFile, getGlobalReferencesFileName, getGlobalReferencesFullJavaClassName, getJavaClassExtends, getJavaClassImplements, getJavaClassName, getJavaEnumLiterals, getJavaEnumLiterals, getJavaGetterName, getJavaIdentifiers, getJavaIdentifiers, getJavaMemberName, getJavaMethodName, getJavaPackageName, getJavaSetterName

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultGeneratorStrategy

public DefaultGeneratorStrategy()

Method Details

setInstanceFields

public void setInstanceFields(boolean instanceFields)

Description copied from interface: GeneratorStrategy

Whether fields are instance fields (as opposed to static fields)

getInstanceFields

public boolean getInstanceFields()

Description copied from interface: GeneratorStrategy

Whether fields are instance fields (as opposed to static fields)

setJavaBeansGettersAndSetters

public void setJavaBeansGettersAndSetters(boolean javaBeansGettersAndSetters)

Description copied from interface: GeneratorStrategy

Whether getters and setters should be generated JavaBeans style (or jOOQ style).

getJavaBeansGettersAndSetters

public boolean getJavaBeansGettersAndSetters()

Description copied from interface: GeneratorStrategy

Whether getters and setters should be generated JavaBeans style (or jOOQ style).

setUseTableNameForUnambiguousFKs

public void setUseTableNameForUnambiguousFKs(boolean useTableNameForUnambiguousFKs)

Description copied from interface: GeneratorStrategy

Whether names of unambiguous ForeignKeyDefinition should be based on the referenced TableDefinition.

When a child table has only one ForeignKeyDefinition towards a parent table, then that path is "unambiguous." In that case, some GeneratorStrategy implementations may choose to use the parent table's TableDefinition for implementations of GeneratorStrategy.getJavaMethodName(Definition), instead of the ForeignKeyDefinition, e.g. for implicit join paths.

This flag allows for turning off this default behaviour.

getUseTableNameForUnambiguousFKs

public boolean getUseTableNameForUnambiguousFKs()

Description copied from interface: GeneratorStrategy

Whether names of unambiguous ForeignKeyDefinition should be based on the referenced TableDefinition.

When a child table has only one ForeignKeyDefinition towards a parent table, then that path is "unambiguous." In that case, some GeneratorStrategy implementations may choose to use the parent table's TableDefinition for implementations of GeneratorStrategy.getJavaMethodName(Definition), instead of the ForeignKeyDefinition, e.g. for implicit join paths.

This flag allows for turning off this default behaviour.

getTargetDirectory

public String getTargetDirectory()

Description copied from interface: GeneratorStrategy

The target directory

setTargetDirectory

public void setTargetDirectory(String directory)

Description copied from interface: GeneratorStrategy

Initialise the target directory

getTargetPackage

public String getTargetPackage()

Returns:

Get the target package for the current configuration

setTargetPackage

public void setTargetPackage(String packageName)

Description copied from interface: GeneratorStrategy

Initialise the target package name

getTargetLocale

public Locale getTargetLocale()

Returns:

Get the target locale for the current configuration

setTargetLocale

public void setTargetLocale(Locale targetLocale)

Description copied from interface: GeneratorStrategy

Initialise the target locale

getTargetLanguage

public Language getTargetLanguage()

Returns:

Get the target language for the current configuration

setTargetLanguage

public void setTargetLanguage(Language targetLanguage)

Description copied from interface: GeneratorStrategy

Initialise the target language

getGlobalNamesFileHeader

public String getGlobalNamesFileHeader(Definition container,
 Class<? extends Definition> objectType)

Returns:

The Java class file header of the global names class for a given definition type, e.g.

 This file is generated by jOOQ.
 

getGlobalReferencesFileHeader

public String getGlobalReferencesFileHeader(Definition container,
 Class<? extends Definition> objectType)

Returns:

The Java class file header of the global references class for a given definition type, e.g.

 This file is generated by jOOQ.
 

getFileHeader

public String getFileHeader(Definition definition,
 GeneratorStrategy.Mode mode)

Returns:

The Java class file header, e.g.

 This file is generated by jOOQ.
 

getJavaEnumLiteral

public String getJavaEnumLiteral(EnumDefinition definition,
 String literal)

Description copied from interface: GeneratorStrategy

This is applied to enum literals of a given EnumDefinition.

Returns:

The Java identifier representing this enum literal, e.g. [OK]

getJavaIdentifier

public String getJavaIdentifier(Definition definition)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in reference static and instance members. For instance, the reference instance of a TableDefinition is a java identifier

Returns:

The Java identifier representing this object, e.g. [my_table]

getJavaSetterName

public String getJavaSetterName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in setters of a container. For example, the definition could be a ColumnDefinition, the container a TableDefinition. Then this would apply to records and POJOs. Also, the definition could be an AttributeDefinition and the container a UDTDefinition

Returns:

The Java setter method name representing this object, e.g. [setMyTable]

getJavaSetterOverride

public boolean getJavaSetterOverride(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

Whether the GeneratorStrategy.getJavaSetterName(Definition, Mode) produces a method that overrides a member from a parent type unknown to jOOQ, e.g. from GeneratorStrategy.getJavaClassExtends(Definition, Mode) or GeneratorStrategy.getJavaClassImplements(Definition, Mode).

getJavaGetterName

public String getJavaGetterName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in getters of a container. For example, the definition could be a ColumnDefinition, the container a TableDefinition. Then this would apply to records and POJOs. Also, the definition could be an AttributeDefinition and the container a UDTDefinition

Returns:

The Java getter method name representing this object, e.g. [getMyTable]

getJavaGetterOverride

public boolean getJavaGetterOverride(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

Whether the GeneratorStrategy.getJavaGetterName(Definition, Mode) produces a method that overrides a member from a parent type unknown to jOOQ, e.g. from GeneratorStrategy.getJavaClassExtends(Definition, Mode) or GeneratorStrategy.getJavaClassImplements(Definition, Mode).

getJavaMethodName

public String getJavaMethodName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

This is applied to definitions that can result in methods. For example, the definition could be a RoutineDefinition

Returns:

The Java method name representing this object, e.g. [myFunction]

getJavaMethodOverride

public boolean getJavaMethodOverride(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

Whether the GeneratorStrategy.getJavaMethodName(Definition, Mode) produces a method that overrides a member from a parent type unknown to jOOQ, e.g. from GeneratorStrategy.getJavaClassExtends(Definition, Mode) or GeneratorStrategy.getJavaClassImplements(Definition, Mode).

getGlobalNamesJavaClassExtends

public String getGlobalNamesJavaClassExtends(Definition container,
 Class<? extends Definition> objectType)

Returns:

The super class name of the global names class for a given definition type, e.g. [com.example.AbstractPojo]. If this returns null or an empty string, then no super class is extended.

getGlobalReferencesJavaClassExtends

public String getGlobalReferencesJavaClassExtends(Definition container,
 Class<? extends Definition> objectType)

Returns:

The super class name of the global references class for a given definition type, e.g. [com.example.AbstractPojo]. If this returns null or an empty string, then no super class is extended.

getJavaClassExtends

public String getJavaClassExtends(Definition definition,
 GeneratorStrategy.Mode mode)

Returns:

The super class name of the Java class representing this object, e.g. [com.example.AbstractPojo]. If this returns null or an empty string, then no super class is extended.

getGlobalNamesJavaClassImplements

public List<String> getGlobalNamesJavaClassImplements(Definition container,
 Class<? extends Definition> objectType)

Returns:

The implemented interface names of the global names class for a given definition type, e.g. [com.example.Pojo]. If this returns null or an empty list, then no interfaces are implemented.

getGlobalReferencesJavaClassImplements

public List<String> getGlobalReferencesJavaClassImplements(Definition container,
 Class<? extends Definition> objectType)

Returns:

The implemented interface names of the global references class for a given definition type, e.g. [com.example.Pojo]. If this returns null or an empty list, then no interfaces are implemented.

getJavaClassImplements

public List<String> getJavaClassImplements(Definition definition,
 GeneratorStrategy.Mode mode)

Returns:

The implemented interface names of the Java class name representing this object, e.g. [com.example.Pojo]. If this returns null or an empty list, then no interfaces are implemented.

getGlobalNamesJavaClassName

public String getGlobalNamesJavaClassName(Definition container,
 Class<? extends Definition> objectType)

Returns:

The Java class name of the global names class for a given definition type, e.g. [TableNames]

getGlobalReferencesJavaClassName

public String getGlobalReferencesJavaClassName(Definition container,
 Class<? extends Definition> objectType)

Returns:

The Java class name of the global references class for a given definition type, e.g. [MyTableSuffix]

getJavaClassName

public String getJavaClassName(Definition definition,
 GeneratorStrategy.Mode mode)

Returns:

The Java class name representing this object, e.g. [MyTableSuffix]

getGlobalNamesJavaPackageName

public String getGlobalNamesJavaPackageName(Definition container,
 Class<? extends Definition> objectType)

Returns:

The Java package name of the global names class for a given definition type, e.g. [org.jooq.generated]

getGlobalReferencesJavaPackageName

public String getGlobalReferencesJavaPackageName(Definition container,
 Class<? extends Definition> objectType)

Returns:

The Java package name of the global references class for a given definition type, e.g. [org.jooq.generated]

getJavaPackageName

public String getJavaPackageName(Definition definition,
 GeneratorStrategy.Mode mode)

Returns:

The Java package name of this object, e.g. [org.jooq.generated]

getJavaMemberName

public String getJavaMemberName(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

The "java member name" is applied where a definition is used as a member (for POJOs) or as a method argument (for setters). Example definitions are

• ColumnDefinition
• ParameterDefinition
• AttributeDefinition

Returns:

The Java class name representing this object, starting with a lower case character, e.g. [myTableSuffix]

getJavaMemberOverride

public boolean getJavaMemberOverride(Definition definition,
 GeneratorStrategy.Mode mode)

Description copied from interface: GeneratorStrategy

Whether the GeneratorStrategy.getJavaMemberName(Definition, Mode) produces a member that overrides a member from a parent type unknown to jOOQ, e.g. from GeneratorStrategy.getJavaClassExtends(Definition, Mode) or GeneratorStrategy.getJavaClassImplements(Definition, Mode).

getOverloadSuffix

public String getOverloadSuffix(Definition definition,
 GeneratorStrategy.Mode mode,
 String overloadIndex)

Returns:

The overload suffix to be applied when generating overloaded routine artefacts, e.g. "_OverloadIndex_" + overloadIndex