org.fastnate.generator

Class EntitySqlGenerator

java.lang.Object

org.fastnate.generator.EntitySqlGenerator

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ConnectedEntitySqlGenerator, WriterEntitySqlGenerator

public abstract class EntitySqlGenerator
extends Object
implements Closeable

Creates SQL statements for a set of entities using their JPA annotations. Known limitations:

• Not all databases covered, see GeneratorDialect.
• Only tested with Hibernate.

Author:

Tobias Liefke

Constructor Summary

Constructors

Constructor and Description
EntitySqlGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method and Description
void	close() Writes any missing SQL and closes any open resources.
protected <E> boolean	findEntity(E entity) Tries to find an entity in an online store.
GeneratorContext	getContext() Used to keep the state of indices and to store any configuration.
<E> void	markExistingEntities(Iterable<E> entities) Marks a set of entity references, where we don't know the ID in the database.
<E> void	markExistingEntity(E entity, Number id) Marks an entity reference, where we know the ID in the database.
<E> void	write(E entity) Creates the Import-SQL for an entity.
<E> void	write(Iterable<? extends E> entities) Creates the SQL for the given entities.
void	writeAlignmentStatements() Writes all statements that are necessary to align ID generators in the database with the current IDs.
abstract void	writeComment(String comment) Writes a SQL comment to the target.
abstract void	writeSectionSeparator() Writes a new line to the target to separate different sections in the SQL file.
abstract void	writeStatement(EntityStatement stmt) Writes the given statement to the target.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitySqlGenerator

@ConstructorProperties(value="context")
 @Generated(value="lombok")
public EntitySqlGenerator(GeneratorContext context)

Method Detail

close

public void close()
           throws IOException

Writes any missing SQL and closes any open resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if the target writer throws one

findEntity

protected <E> boolean findEntity(E entity)
                          throws IOException

Tries to find an entity in an online store. Usefull for writing online updates.

Parameters:

entity - the entity to check

Returns:

true if the entity was found and has an id now

Throws:

IOException - if something wents wrong

markExistingEntities

public <E> void markExistingEntities(Iterable<E> entities)
                              throws IOException

Marks a set of entity references, where we don't know the ID in the database. As we write every unknown entity to the SQL file, if it is referenced by one that is just written, we need to mark entities that exist already in the database (and where we possibly have no knowledge of the id of the entity).

Parameters:

entities - the entity to ignore during write(Object)

Throws:

IOException - if the writer throws one

markExistingEntity

public <E> void markExistingEntity(E entity,
                                   Number id)

Marks an entity reference, where we know the ID in the database. As we write every unknown entity to the SQL file, if it is referenced by one that is just written, we need to mark entities that exist already in the database. In difference to markExistingEntities(Iterable), we know the id for the given entity.

Parameters:

entity - the entity to ignore during write(Object)

id - the id of the entity in

write

public <E> void write(E entity)
               throws IOException

Creates the Import-SQL for an entity. If the entity was already written (has an id), it is updated (if nessecary).

Parameters:

entity - the entity to create the SQL for

Throws:

IOException - if the writer throws one

IllegalArgumentException - if the entity is invalid

write

public <E> void write(Iterable<? extends E> entities)
               throws IOException

Creates the SQL for the given entities.

Parameters:

entities - the entities for SQL creation

Throws:

IOException - if the writer throws one

writeAlignmentStatements

public void writeAlignmentStatements()
                              throws IOException

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

Throws:

IOException - if the target writer throws one

writeComment

public abstract void writeComment(String comment)
                           throws IOException

Writes a SQL comment to the target.

Parameters:

comment - the comment to write

Throws:

IOException - if the target throws one

writeSectionSeparator

public abstract void writeSectionSeparator()
                                    throws IOException

Writes a new line to the target to separate different sections in the SQL file.

Throws:

IOException - if the target throws such an exception

writeStatement

public abstract void writeStatement(EntityStatement stmt)
                             throws IOException

Writes the given statement to the target.

Parameters:

stmt - the SQL statement to write

Throws:

IOException - if the target throws one

getContext

@Generated(value="lombok")
public GeneratorContext getContext()

Used to keep the state of indices and to store any configuration.