Module org.jooq.codegen

Package org.jooq.codegen

Class MatcherStrategy

java.lang.Object

org.jooq.codegen.AbstractGeneratorStrategy

org.jooq.codegen.DefaultGeneratorStrategy

org.jooq.codegen.MatcherStrategy

All Implemented Interfaces:

GeneratorStrategy

public class MatcherStrategy
extends DefaultGeneratorStrategy

A generator strategy that names objects according to a Matchers configuration object.

Author:

Lukas Eder

Nested Class Summary

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

GeneratorStrategy.Mode

Constructor Summary

Constructors

Constructor	Description
MatcherStrategy(Matchers matchers)
MatcherStrategy(Matchers matchers, Patterns patterns)

Method Summary

Modifier and Type	Method	Description
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.
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).
String	getJavaMethodName(Definition definition, GeneratorStrategy.Mode mode)	This is applied to definitions that can result in methods.
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.
Matchers	getMatchers()
String	getOverloadSuffix(Definition definition, GeneratorStrategy.Mode mode, String overloadIndex)
Patterns	getPatterns()

Methods inherited from class org.jooq.codegen.DefaultGeneratorStrategy

getFileHeader, getGlobalReferencesFileHeader, getGlobalReferencesJavaClassExtends, getGlobalReferencesJavaClassImplements, getGlobalReferencesJavaClassName, getGlobalReferencesJavaPackageName, getInstanceFields, getJavaBeansGettersAndSetters, getTargetDirectory, getTargetLanguage, getTargetLocale, getTargetPackage, setInstanceFields, setJavaBeansGettersAndSetters, setTargetDirectory, setTargetLanguage, setTargetLocale, setTargetPackage

Methods inherited from class org.jooq.codegen.AbstractGeneratorStrategy

getFile, getFile, getFile, getFileHeader, getFileName, getFileName, getFileRoot, getFullJavaClassName, getFullJavaClassName, getFullJavaIdentifier, getFullJavaIdentifiers, getFullJavaIdentifiers, 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 Detail

MatcherStrategy

public MatcherStrategy(Matchers matchers)

MatcherStrategy

public MatcherStrategy(Matchers matchers,
                       Patterns patterns)

Method Detail

getMatchers

public Matchers getMatchers()

getPatterns

public Patterns getPatterns()

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

Specified by:

getJavaIdentifier in interface GeneratorStrategy

Overrides:

getJavaIdentifier in class DefaultGeneratorStrategy

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

Specified by:

getJavaSetterName in interface GeneratorStrategy

Overrides:

getJavaSetterName in class DefaultGeneratorStrategy

Returns:

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

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

Specified by:

getJavaGetterName in interface GeneratorStrategy

Overrides:

getJavaGetterName in class DefaultGeneratorStrategy

Returns:

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

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

Specified by:

getJavaMethodName in interface GeneratorStrategy

Overrides:

getJavaMethodName in class DefaultGeneratorStrategy

Returns:

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

getJavaClassExtends

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

Specified by:

getJavaClassExtends in interface GeneratorStrategy

Overrides:

getJavaClassExtends in class DefaultGeneratorStrategy

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

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

Specified by:

getJavaClassImplements in interface GeneratorStrategy

Overrides:

getJavaClassImplements in class DefaultGeneratorStrategy

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

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

Specified by:

getJavaClassName in interface GeneratorStrategy

Overrides:

getJavaClassName in class DefaultGeneratorStrategy

Returns:

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

getJavaEnumLiteral

public String getJavaEnumLiteral(EnumDefinition definition,
                                 String literal)

Description copied from interface: GeneratorStrategy

This is applied to enum literals of a given EnumDefinition.

Specified by:

getJavaEnumLiteral in interface GeneratorStrategy

Overrides:

getJavaEnumLiteral in class DefaultGeneratorStrategy

Returns:

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

getJavaPackageName

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

Specified by:

getJavaPackageName in interface GeneratorStrategy

Overrides:

getJavaPackageName in class DefaultGeneratorStrategy

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

Specified by:

getJavaMemberName in interface GeneratorStrategy

Overrides:

getJavaMemberName in class DefaultGeneratorStrategy

Returns:

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

getOverloadSuffix

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

Specified by:

getOverloadSuffix in interface GeneratorStrategy

Overrides:

getOverloadSuffix in class DefaultGeneratorStrategy

Returns:

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