org.fastnate.generator.context

Class GeneratorContext

java.lang.Object

org.fastnate.generator.context.GeneratorContext

public class GeneratorContext
extends Object

Represents the configuration and state for one or more EntitySqlGenerators.

Author:

Tobias Liefke

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIALECT_KEY The settings key for the target SQL dialect.
static String	NULL_VALUES_KEY The settings key for writeNullValues.
static String	PERSISTENCE_FILE_KEY The settings key for the path to the persistence.xml, either relative to the current directory or absolute.
static String	PERSISTENCE_UNIT_KEY The settings key for the name of the persistence unit in the persistence.xml.
static String	PREFER_SEQUENCE_CURRENT_VALUE The settings key for preferSequenceCurentValue.
static String	PROVIDER_KEY The settings key for the JPA provider.
static String	RELATIVE_IDS_KEY The settings key for writeRelativeIds.
static String	UNIQUE_PROPERTIES_MAX_KEY The settings key for the maxUniqueProperties.
static String	UNIQUE_PROPERTIES_QUALITY_KEY The settings key for the uniquePropertyQuality.

Constructor Summary

Constructors

Constructor and Description
GeneratorContext() Creates a default generator context.
GeneratorContext(GeneratorDialect dialect) Creates a generator context for a dialect.
GeneratorContext(Properties settings) Creates a new instance of GeneratorContext.

Method Summary

Modifier and Type	Method and Description
List<EntityStatement>	getAlignmentStatements() Builds all statements that are necessary to align ID generators in the database with the current IDs.
<E> EntityClass<E>	getDescription(Class<E> entityClass) Finds the description for a class.
<E> EntityClass<E>	getDescription(E entity) Finds the description for the class of an entity.
IdGenerator	getGenerator(javax.persistence.GeneratedValue generatedValue, String table, String column) Finds the correct generator for the given annotation.
void	registerGenerators(AnnotatedElement element) Registers the TableGenerator and SequenceGenerator declared at the given element.

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER_KEY

public static final String PROVIDER_KEY

The settings key for the JPA provider. Contains either the fully qualified class name of an extension of JpaProvider or the simple name of one of the classes from org.fastnate.generator.provider. Defaults to HibernateProvider.

See Also:

Constant Field Values

PERSISTENCE_FILE_KEY

public static final String PERSISTENCE_FILE_KEY

The settings key for the path to the persistence.xml, either relative to the current directory or absolute.

See Also:

Constant Field Values

PERSISTENCE_UNIT_KEY

public static final String PERSISTENCE_UNIT_KEY

The settings key for the name of the persistence unit in the persistence.xml. The first persistence unit is used, if none is explicitly set.

See Also:

Constant Field Values

DIALECT_KEY

public static final String DIALECT_KEY

The settings key for the target SQL dialect.

Contains either the fully qualified name of a class that extends GeneratorDialect or the simple class name of one of the classes from org.fastnate.generator.dialect. The suffix 'Dialect' may be omitted in that case. For example 'MySql' would map to org.fastnate.generator.dialect.MySqlDialect.

If no dialect is set explicitly then the configured persistence.xml is scanned for a connection URL or provider specific dialect, which would be converted to our known dialects.

If nothing is found, H2 is used as default.

See Also:

Constant Field Values

NULL_VALUES_KEY

public static final String NULL_VALUES_KEY

The settings key for writeNullValues.

See Also:

Constant Field Values

RELATIVE_IDS_KEY

public static final String RELATIVE_IDS_KEY

The settings key for writeRelativeIds.

See Also:

Constant Field Values

UNIQUE_PROPERTIES_QUALITY_KEY

public static final String UNIQUE_PROPERTIES_QUALITY_KEY

The settings key for the uniquePropertyQuality.

See Also:

Constant Field Values

UNIQUE_PROPERTIES_MAX_KEY

public static final String UNIQUE_PROPERTIES_MAX_KEY

The settings key for the maxUniqueProperties.

See Also:

Constant Field Values

PREFER_SEQUENCE_CURRENT_VALUE

public static final String PREFER_SEQUENCE_CURRENT_VALUE

The settings key for preferSequenceCurentValue.

See Also:

Constant Field Values

Constructor Detail

GeneratorContext

public GeneratorContext()

Creates a default generator context.

GeneratorContext

public GeneratorContext(GeneratorDialect dialect)

Creates a generator context for a dialect.

Parameters:

dialect - the database dialect to use during generation

GeneratorContext

public GeneratorContext(Properties settings)

Creates a new instance of GeneratorContext.

Parameters:

settings - contains the settings

Method Detail

getAlignmentStatements

public List<EntityStatement> getAlignmentStatements()

Builds all statements that are necessary to align ID generators in the database with the current IDs.

Returns:

the list of statements

getDescription

public <E> EntityClass<E> getDescription(Class<E> entityClass)

Finds the description for a class.

Parameters:

entityClass - the class to lookup

Returns:

the description for the class or null if the class is not an Entity

getDescription

public <E> EntityClass<E> getDescription(E entity)

Finds the description for the class of an entity.

Parameters:

entity - the entity to lookup

Returns:

the description for the class of the entity

Throws:

IllegalArgumentException - if the given object is no Entity

getGenerator

public IdGenerator getGenerator(javax.persistence.GeneratedValue generatedValue,
                                String table,
                                String column)

Finds the correct generator for the given annotation.

Parameters:

generatedValue - the annotation of the current primary key

table - the name of the current table

column - the name of the current column

Returns:

the generator that is responsible for managing the values

registerGenerators

public void registerGenerators(AnnotatedElement element)

Registers the TableGenerator and SequenceGenerator declared at the given element. If neither annotation is present, nothing happens.

Parameters:

element - the inspected class, method or field