org.jooq.util

Interface GeneratorStrategy

All Known Implementing Classes:

AbstractGeneratorStrategy, DefaultGeneratorStrategy, JPrefixGeneratorStrategy, JVMArgsGeneratorStrategy, MatcherStrategy

public interface GeneratorStrategy

A strategy for naming various artefacts generated from Definition's

Author:

Lukas Eder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GeneratorStrategy.Mode The "mode" by which an artefact should be named

Method Summary

Methods

Modifier and Type	Method and Description
File	getFile(Definition definition)
File	getFile(Definition definition, GeneratorStrategy.Mode mode)
String	getFileName(Definition definition)
String	getFileName(Definition definition, GeneratorStrategy.Mode mode)
String	getFullJavaClassName(Definition definition)
String	getFullJavaClassName(Definition definition, GeneratorStrategy.Mode mode) This is the same as calling getFullJavaClassName(definition, Mode.DEFAULT)
String	getFullJavaIdentifier(Definition definition) This is applied to definitions that can result in singleton static and instance members.
List<String>	getFullJavaIdentifiers(Collection<? extends Definition> definitions)
List<String>	getFullJavaIdentifiers(Definition... definitions)
boolean	getInstanceFields() Whether fields are instance fields (as opposed to static fields)
String	getJavaClassExtends(Definition definition) This is the same as calling getJavaClassExtends(definition, Mode.DEFAULT)
String	getJavaClassExtends(Definition definition, GeneratorStrategy.Mode mode)
List<String>	getJavaClassImplements(Definition definition) This is the same as calling getJavaClassImplements(definition, Mode.DEFAULT)
List<String>	getJavaClassImplements(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaClassName(Definition definition) This is the same as calling getJavaClassName(definition, Mode.DEFAULT)
String	getJavaClassName(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaGetterName(Definition definition) This is applied to definitions that can result in getters of a container.
String	getJavaGetterName(Definition definition, GeneratorStrategy.Mode mode) This is applied to definitions that can result in getters of a container.
String	getJavaIdentifier(Definition definition) This is applied to definitions that can result in singleton static and instance members.
List<String>	getJavaIdentifiers(Collection<? extends Definition> definitions)
List<String>	getJavaIdentifiers(Definition... definitions)
String	getJavaMemberName(Definition definition) The "java member name" is applied where a definition is used as a member (for POJOs) or as a method argument (for setters).
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).
String	getJavaMethodName(Definition definition) This is applied to definitions that can result in methods.
String	getJavaMethodName(Definition definition, GeneratorStrategy.Mode mode) This is applied to definitions that can result in methods.
String	getJavaPackageName(Definition definition) This is the same as calling getJavaPackageName(definition, Mode.DEFAULT)
String	getJavaPackageName(Definition definition, GeneratorStrategy.Mode mode)
String	getJavaSetterName(Definition definition) This is applied to definitions that can result in setters of a container.
String	getJavaSetterName(Definition definition, GeneratorStrategy.Mode mode) This is applied to definitions that can result in setters of a container.
String	getOverloadSuffix(Definition definition, GeneratorStrategy.Mode mode, String overloadIndex)
String	getTargetDirectory() The target directory
String	getTargetPackage()
void	setInstanceFields(boolean instanceFields) Whether fields are instance fields (as opposed to static fields)
void	setTargetDirectory(String directory) Initialise the target directory
void	setTargetPackage(String packageName) Initialise the target package name

Method Detail

getTargetDirectory

String getTargetDirectory()

The target directory

setTargetDirectory

void setTargetDirectory(String directory)

Initialise the target directory

getTargetPackage

String getTargetPackage()

Returns:

Get the target package for the current configuration

setTargetPackage

void setTargetPackage(String packageName)

Initialise the target package name

setInstanceFields

void setInstanceFields(boolean instanceFields)

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

getInstanceFields

boolean getInstanceFields()

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

getJavaIdentifier

String getJavaIdentifier(Definition definition)

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

Returns:

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

getJavaIdentifiers

List<String> getJavaIdentifiers(Collection<? extends Definition> definitions)

See Also:

getJavaIdentifier(Definition)

getJavaIdentifiers

List<String> getJavaIdentifiers(Definition... definitions)

See Also:

getJavaIdentifier(Definition)

getFullJavaIdentifier

String getFullJavaIdentifier(Definition definition)

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

Returns:

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

getFullJavaIdentifiers

List<String> getFullJavaIdentifiers(Collection<? extends Definition> definitions)

See Also:

getFullJavaIdentifier(Definition)

getFullJavaIdentifiers

List<String> getFullJavaIdentifiers(Definition... definitions)

See Also:

getFullJavaIdentifier(Definition)

getJavaSetterName

String getJavaSetterName(Definition definition)

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

This is the same as calling getJavaSetterName(definition, Mode.DEFAULT)

Returns:

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

getJavaSetterName

String getJavaSetterName(Definition definition,
                       GeneratorStrategy.Mode mode)

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]

getJavaGetterName

String getJavaGetterName(Definition definition)

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

This is the same as calling getJavaGetterName(definition, Mode.DEFAULT)

Returns:

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

getJavaGetterName

String getJavaGetterName(Definition definition,
                       GeneratorStrategy.Mode mode)

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]

getJavaMethodName

String getJavaMethodName(Definition definition)

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

This is the same as calling getJavaMethodName(definition, Mode.DEFAULT)

Returns:

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

getJavaMethodName

String getJavaMethodName(Definition definition,
                       GeneratorStrategy.Mode mode)

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]

getJavaClassExtends

String getJavaClassExtends(Definition definition)

This is the same as calling getJavaClassExtends(definition, Mode.DEFAULT)

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.

getJavaClassExtends

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.

getJavaClassImplements

List<String> getJavaClassImplements(Definition definition)

This is the same as calling getJavaClassImplements(definition, Mode.DEFAULT)

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.

getJavaClassImplements

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.

getJavaClassName

String getJavaClassName(Definition definition)

This is the same as calling getJavaClassName(definition, Mode.DEFAULT)

Returns:

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

getJavaClassName

String getJavaClassName(Definition definition,
                      GeneratorStrategy.Mode mode)

Returns:

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

getJavaPackageName

String getJavaPackageName(Definition definition)

This is the same as calling getJavaPackageName(definition, Mode.DEFAULT)

Returns:

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

getJavaPackageName

String getJavaPackageName(Definition definition,
                        GeneratorStrategy.Mode mode)

Returns:

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

getJavaMemberName

String getJavaMemberName(Definition definition)

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

This is the same as calling getJavaMemberName(definition, Mode.DEFAULT)

Returns:

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

getJavaMemberName

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). Example definitions are

• ColumnDefinition
• ParameterDefinition
• AttributeDefinition

Returns:

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

getFullJavaClassName

String getFullJavaClassName(Definition definition)

Returns:

The full Java class name representing this object, e.g. [org.jooq.generated.MyTable]

getFullJavaClassName

String getFullJavaClassName(Definition definition,
                          GeneratorStrategy.Mode mode)

This is the same as calling getFullJavaClassName(definition, Mode.DEFAULT)

Returns:

The full Java class name representing this object, e.g. [org.jooq.generated.MyTable][suffix]

getFileName

String getFileName(Definition definition)

Returns:

The Java class file name representing this object, e.g. [MyTable.java]

getFileName

String getFileName(Definition definition,
                 GeneratorStrategy.Mode mode)

Returns:

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

getFile

File getFile(Definition definition)

Returns:

The Java class file name representing this object, e.g. [C:\org\jooq\generated\MyTable.java]

getFile

File getFile(Definition definition,
           GeneratorStrategy.Mode mode)

Returns:

The Java class file name representing this object, e.g. [C:\org\jooq\generated\MyTableSuffix.java]

getOverloadSuffix

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