GeneratorContext (Fastnate Generator 1.5.0-SNAPSHOT API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addContextModelListener(ContextModelListener listener)` Adds a new listener to this context.
`protected <T> void`	`fireContextObjectAdded(BiConsumer<ContextModelListener,T> listenerFunction, T contextObject)` Fires an event to all `listeners`.
`List<ContextModelListener>`	`getContextModelListeners()` All listeners of this context.
`<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.
`Map<Class<?>,EntityClass<?>>`	`getDescriptions()` Contains the extracted metadata to every known class of an `Entity`.
`Map<String,EntityClass<?>>`	`getDescriptionsByName()` The mapping from the `name of an entity` to the `extracted metadata`.
`GeneratorDialect`	`getDialect()` Identifies the SQL dialect for generating SQL statements.
`IdGenerator`	`getGenerator(javax.persistence.GeneratedValue generatedValue, GeneratorTable table, GeneratorColumn column)` Finds the correct generator for the given annotation.
`int`	`getMaxUniqueProperties()` The maximum count of columns that are used when referencing an entity using it's unique properties.
`JpaProvider`	`getProvider()` Identifies the JPA provider to indicate implementation specific details.
`Properties`	`getSettings()` Contains the settings that were given during creation, resp. as read from the persistence configuration.
`Map<String,Map<Object,GenerationState>>`	`getStates()` Contains the state of single entities, maps from an entity name to the mapping of an id to its state.
`Map<String,GeneratorTable>`	`getTables()` Mapping from the names of all known database table to their description (including column information).
`UniquePropertyQuality`	`getUniquePropertyQuality()` Indicates what kind of properties are used for referencing an entity with its unique properties.
`boolean`	`isPreferSequenceCurentValue()` Indiciates to use "currval" of a sequence if the referenced entity is the last created entity for that sequence before checking for `unique properties`.
`boolean`	`isWriteNullValues()` Indicates to include null values in statements.
`boolean`	`isWriteRelativeIds()` Indicates that we write into a schema that is not empty.
`void`	`registerGenerators(AnnotatedElement element, GeneratorTable table)` Registers the `TableGenerator` and `SequenceGenerator` declared at the given element.
`void`	`removeContextModelListener(ContextModelListener listener)` Removes a listener from this context.
`<A extends Annotation> GeneratorTable`	`resolveTable(A annotation, Function<A,String> catalogName, Function<A,String> schemaName, Function<A,String> tableName, String defaultTableName)` Finds resp. builds the metadata to the given table from the given (optional) annotation.
`GeneratorTable`	`resolveTable(String catalogName, String schemaName, String tableName)` Finds resp. builds the metadata to the given table.
`void`	`setContextModelListeners(List<ContextModelListener> contextModelListeners)` All listeners of this context.
`void`	`setDefaultSequenceGenerator(SequenceIdGenerator defaultSequenceGenerator)` The default sequence generator, if none is explicitly specified in a `GeneratedValue`.
`void`	`setDefaultTableGenerator(TableIdGenerator defaultTableGenerator)` The default table generator, if none is explicitly specified in a `GeneratedValue`.
`void`	`setDialect(GeneratorDialect dialect)` Identifies the SQL dialect for generating SQL statements.
`void`	`setMaxUniqueProperties(int maxUniqueProperties)` The maximum count of columns that are used when referencing an entity using it's unique properties.
`void`	`setPreferSequenceCurentValue(boolean preferSequenceCurentValue)` Indiciates to use "currval" of a sequence if the referenced entity is the last created entity for that sequence before checking for `unique properties`.
`void`	`setProvider(JpaProvider provider)` Identifies the JPA provider to indicate implementation specific details.
`void`	`setUniquePropertyQuality(UniquePropertyQuality uniquePropertyQuality)` Indicates what kind of properties are used for referencing an entity with its unique properties.
`void`	`setWriteNullValues(boolean writeNullValues)` Indicates to include null values in statements.
`void`	`setWriteRelativeIds(boolean writeRelativeIds)` Indicates that we write into a schema that is not empty.
`void`	`writeAlignmentStatements(StatementsWriter writer)` Builds all statements that are necessary to align ID generators in the database with the current IDs.

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
  - addContextModelListener
```
public void addContextModelListener(ContextModelListener listener)
```
    Adds a new listener to this context.
    
    Parameters:
    
    listener - the listener that is interested in new discovered model elements
  - fireContextObjectAdded
```
protected <T> void fireContextObjectAdded(BiConsumer<ContextModelListener,T> listenerFunction,
                                          T contextObject)
```
    Fires an event to all listeners.
    
    Parameters:
    
    listenerFunction - the function that is called on the listeners
    
    contextObject - the object to offer to the listener function
  - 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,
                                GeneratorTable table,
                                GeneratorColumn 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,
                               GeneratorTable table)
```
    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
    
    table - the table of the current entity
  - removeContextModelListener
```
public void removeContextModelListener(ContextModelListener listener)
```
    Removes a listener from this context.
    
    Parameters:
    
    listener - the listener that is not interested anymore
  - resolveTable
```
public <A extends Annotation> GeneratorTable resolveTable(A annotation,
                                                          Function<A,String> catalogName,
                                                          Function<A,String> schemaName,
                                                          Function<A,String> tableName,
                                                          String defaultTableName)
```
    Finds resp. builds the metadata to the given table from the given (optional) annotation.
    
    Parameters:
    
    annotation - the optional annotation that contains any metadata to the table
    
    catalogName - finds the optional name of the catalog that contains the table
    
    schemaName - finds the optional name of the schema that contains the table
    
    tableName - finds the name of the table
    
    defaultTableName - the name of the talbe, if the annotation is null or contains no value for the table name
    
    Returns:
    
    the metadata for the given table
  - resolveTable
```
public GeneratorTable resolveTable(String catalogName,
                                   String schemaName,
                                   String tableName)
```
    Finds resp. builds the metadata to the given table.
    
    Parameters:
    
    catalogName - the optional name of the catalog that contains the table
    
    schemaName - the optional name of the schema that contains the table
    
    tableName - the name of the table from the database
    
    Returns:
    
    the metadata for the given table
  - writeAlignmentStatements
```
public void writeAlignmentStatements(StatementsWriter writer)
                              throws IOException
```
    Builds all statements that are necessary to align ID generators in the database with the current IDs.
    
    Parameters:
    
    writer - the target of any write operation
    
    Throws:
    
    IOException - if the writer throws one
  - getDialect
```
@Generated(value="lombok")
public GeneratorDialect getDialect()
```
    Identifies the SQL dialect for generating SQL statements. Encapsulates the database specifica.
  - getProvider
```
@Generated(value="lombok")
public JpaProvider getProvider()
```
    Identifies the JPA provider to indicate implementation specific details.
  - getMaxUniqueProperties
```
@Generated(value="lombok")
public int getMaxUniqueProperties()
```
    The maximum count of columns that are used when referencing an entity using it's unique properties.
  - getUniquePropertyQuality
```
@Generated(value="lombok")
public UniquePropertyQuality getUniquePropertyQuality()
```
    Indicates what kind of properties are used for referencing an entity with its unique properties.
  - isPreferSequenceCurentValue
```
@Generated(value="lombok")
public boolean isPreferSequenceCurentValue()
```
    Indiciates to use "currval" of a sequence if the referenced entity is the last created entity for that sequence before checking for unique properties.
  - isWriteRelativeIds
```
@Generated(value="lombok")
public boolean isWriteRelativeIds()
```
    Indicates that we write into a schema that is not empty. By default we write all IDs as absolute values and change the sequences / table generators at the end. But this would crash if there is data in the database already that uses the same IDs. So in the case of incremental updates, one should set this setting to true - which will generate relative IDs which respect the existing IDs.
  - isWriteNullValues
```
@Generated(value="lombok")
public boolean isWriteNullValues()
```
    Indicates to include null values in statements.
  - getSettings
```
@Generated(value="lombok")
public Properties getSettings()
```
    Contains the settings that were given during creation, resp. as read from the persistence configuration.
  - getDescriptions
```
@Generated(value="lombok")
public Map<Class<?>,EntityClass<?>> getDescriptions()
```
    Contains the extracted metadata to every known class of an Entity.
  - getDescriptionsByName
```
@Generated(value="lombok")
public Map<String,EntityClass<?>> getDescriptionsByName()
```
    The mapping from the name of an entity to the extracted metadata.
  - getTables
```
@Generated(value="lombok")
public Map<String,GeneratorTable> getTables()
```
    Mapping from the names of all known database table to their description (including column information).
  - getStates
```
@Generated(value="lombok")
public Map<String,Map<Object,GenerationState>> getStates()
```
    Contains the state of single entities, maps from an entity name to the mapping of an id to its state.
  - getContextModelListeners
```
@Generated(value="lombok")
public List<ContextModelListener> getContextModelListeners()
```
    All listeners of this context.
  - setDialect
```
@Generated(value="lombok")
public void setDialect(GeneratorDialect dialect)
```
    Identifies the SQL dialect for generating SQL statements. Encapsulates the database specifica.
  - setProvider
```
@Generated(value="lombok")
public void setProvider(JpaProvider provider)
```
    Identifies the JPA provider to indicate implementation specific details.
  - setMaxUniqueProperties
```
@Generated(value="lombok")
public void setMaxUniqueProperties(int maxUniqueProperties)
```
    The maximum count of columns that are used when referencing an entity using it's unique properties.
  - setUniquePropertyQuality
```
@Generated(value="lombok")
public void setUniquePropertyQuality(UniquePropertyQuality uniquePropertyQuality)
```
    Indicates what kind of properties are used for referencing an entity with its unique properties.
  - setPreferSequenceCurentValue
```
@Generated(value="lombok")
public void setPreferSequenceCurentValue(boolean preferSequenceCurentValue)
```
    Indiciates to use "currval" of a sequence if the referenced entity is the last created entity for that sequence before checking for unique properties.
  - setWriteRelativeIds
```
@Generated(value="lombok")
public void setWriteRelativeIds(boolean writeRelativeIds)
```
    Indicates that we write into a schema that is not empty. By default we write all IDs as absolute values and change the sequences / table generators at the end. But this would crash if there is data in the database already that uses the same IDs. So in the case of incremental updates, one should set this setting to true - which will generate relative IDs which respect the existing IDs.
  - setWriteNullValues
```
@Generated(value="lombok")
public void setWriteNullValues(boolean writeNullValues)
```
    Indicates to include null values in statements.
  - setDefaultSequenceGenerator
```
@Generated(value="lombok")
public void setDefaultSequenceGenerator(SequenceIdGenerator defaultSequenceGenerator)
```
    The default sequence generator, if none is explicitly specified in a GeneratedValue.
  - setDefaultTableGenerator
```
@Generated(value="lombok")
public void setDefaultTableGenerator(TableIdGenerator defaultTableGenerator)
```
    The default table generator, if none is explicitly specified in a GeneratedValue.
  - setContextModelListeners
```
@Generated(value="lombok")
public void setContextModelListeners(List<ContextModelListener> contextModelListeners)
```
    All listeners of this context.

Class GeneratorContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROVIDER_KEY

PERSISTENCE_FILE_KEY

PERSISTENCE_UNIT_KEY

DIALECT_KEY

NULL_VALUES_KEY

RELATIVE_IDS_KEY

UNIQUE_PROPERTIES_QUALITY_KEY

UNIQUE_PROPERTIES_MAX_KEY

PREFER_SEQUENCE_CURRENT_VALUE

Constructor Detail

GeneratorContext

GeneratorContext

GeneratorContext

Method Detail

addContextModelListener

fireContextObjectAdded

getDescription

getDescription

getGenerator

registerGenerators

removeContextModelListener

resolveTable

resolveTable

writeAlignmentStatements

getDialect

getProvider

getMaxUniqueProperties

getUniquePropertyQuality

isPreferSequenceCurentValue

isWriteRelativeIds

isWriteNullValues

getSettings

getDescriptions

getDescriptionsByName

getTables

getStates

getContextModelListeners

setDialect

setProvider

setMaxUniqueProperties

setUniquePropertyQuality

setPreferSequenceCurentValue

setWriteRelativeIds

setWriteNullValues

setDefaultSequenceGenerator

setDefaultTableGenerator

setContextModelListeners