org.fastnate.generator.provider

Interface JpaProvider

All Known Implementing Classes:

HibernateProvider

public interface JpaProvider

Encapsulates details specific to the current JPA implementation.

Author:

Tobias Liefke

Method Summary

Modifier and Type	Method and Description
default <T> ValueConverter<T>	createBasicConverter(String attributeName, Class<T> targetType) Creates a converter for a primitive database type.
default <T> ValueConverter<T>	createConverter(AttributeAccessor attribute, Class<T> targetType, boolean mapKey) Creates a converter for an attribute that has a PrimitiveProperty.
default <T> ValueConverter<T>	createFallbackConverter(String attributeName, Class<T> targetType) Creates the converter for a type that is unknown to us.
String	getDefaultGeneratorTable() The name of the default generator TableGenerator.table(), if none was specified for a table generator.
String	getDefaultGeneratorTablePkColumnName() The name of the default generator TableGenerator.pkColumnName(), if none was specified for a table generator.
String	getDefaultGeneratorTablePkColumnValue() The name of the default generator TableGenerator.pkColumnValue(), if none was specified for a table generator.
String	getDefaultGeneratorTableValueColumnName() The name of the default generator TableGenerator.valueColumnName(), if none was specified for a table generator.
String	getDefaultSequence() The name of the default sequence, if none was specified for a sequence generator.
void	initialize(Properties settings) Initializes this provider from the given settings.
boolean	isJoinedDiscriminatorNeeded() Indicates if the current JPA provider needs always a discriminator column for a JOINED table.

Method Detail

createBasicConverter

default <T> ValueConverter<T> createBasicConverter(String attributeName,
                                                   Class<T> targetType)

Creates a converter for a primitive database type.

Type Parameters:

T - the generic type

Parameters:

attributeName - the name of the attribute that contains the value - only to print that name in case of any error

targetType - the primitive database type

Returns:

the converter or an instance of UnsupportedTypeConverter if no converter is available

createConverter

default <T> ValueConverter<T> createConverter(AttributeAccessor attribute,
                                              Class<T> targetType,
                                              boolean mapKey)

Creates a converter for an attribute that has a PrimitiveProperty.

Type Parameters:

T - the generic binding of the type of the value

Parameters:

attribute - the accessor for the attribute that contains the value, not nessecarily of the target type

targetType - the type of the value

mapKey - indicates that the converter is for the key of a map

Returns:

the converter or an instance of UnsupportedTypeConverter if no converter is available

createFallbackConverter

default <T> ValueConverter<T> createFallbackConverter(String attributeName,
                                                      Class<T> targetType)

Creates the converter for a type that is unknown to us. Should be overridden for any provider specific types.

Type Parameters:

T - the generic type

Parameters:

attributeName - the name of the attribute that contains the value - only to print that name in case of any error

targetType - the primitive database type

Returns:

the converter or an instance of UnsupportedTypeConverter if no converter is available

getDefaultGeneratorTable

String getDefaultGeneratorTable()

The name of the default generator TableGenerator.table(), if none was specified for a table generator.

Returns:

the default generator table

getDefaultGeneratorTablePkColumnName

String getDefaultGeneratorTablePkColumnName()

The name of the default generator TableGenerator.pkColumnName(), if none was specified for a table generator.

Returns:

the default primary column name for the generator table

getDefaultGeneratorTablePkColumnValue

String getDefaultGeneratorTablePkColumnValue()

The name of the default generator TableGenerator.pkColumnValue(), if none was specified for a table generator.

Returns:

the default primary column value for the generator table

getDefaultGeneratorTableValueColumnName

String getDefaultGeneratorTableValueColumnName()

The name of the default generator TableGenerator.valueColumnName(), if none was specified for a table generator.

Returns:

the default value column name for the generator table

getDefaultSequence

String getDefaultSequence()

The name of the default sequence, if none was specified for a sequence generator.

Returns:

the default sequence name

initialize

void initialize(Properties settings)

Initializes this provider from the given settings. May as well change the settings according to some other settings found.

Parameters:

settings - the settings of the generator context

isJoinedDiscriminatorNeeded

boolean isJoinedDiscriminatorNeeded()

Indicates if the current JPA provider needs always a discriminator column for a JOINED table.

Returns:

true to always write a discriminator column, false if it should be written only if explicitly given