org.fastnate.generator.context

Class GeneratedIdProperty<E>

java.lang.Object

org.fastnate.generator.context.Property<E,T>

org.fastnate.generator.context.SingularProperty<E,T>

org.fastnate.generator.context.PrimitiveProperty<E,Number>

org.fastnate.generator.context.GeneratedIdProperty<E>

Type Parameters:

E - The type of the container class

public class GeneratedIdProperty<E>
extends PrimitiveProperty<E,Number>

Describes an Id property of an EntityClass.

Author:

Tobias Liefke

Constructor Summary

Constructors

Constructor and Description
GeneratedIdProperty(EntityClass<E> entityClass, AttributeAccessor attribute, javax.persistence.Column column) Creates a new instance of GeneratedIdProperty.

Method Summary

Modifier and Type	Method and Description
void	addInsertExpression(E entity, InsertStatement statement) Adds an expression according to the current value of the property for the given entity to an SQL insert statement.
List<? extends EntityStatement>	createPreInsertStatements(E entity) Creates SQL statements that are necessary before this property is written (e.g. for updating the table generator).
String	getExpression(E entity, boolean whereExpression) Creates the reference of an entity in SQL using its (relative or absolute) id.
boolean	isNew(E entity) Indicates that the given entity needs to be written.
boolean	isReference(E entity) Indicates that the given entity was not written before, but exists already in the database.
void	markReference(E entity) Marks an entity as reference, where we don't know the ID database.
void	markReference(E entity, long id) Marks an entity as reference, where we know the id in the database.
void	postInsert(E entity) Called after the insert statement was written, to update any nessecary state in the context.

Methods inherited from class org.fastnate.generator.context.PrimitiveProperty

createConverter, getDefaultValue, getDialect, getPredicate

Methods inherited from class org.fastnate.generator.context.SingularProperty

getColumn, isTableColumn

Methods inherited from class org.fastnate.generator.context.Property

createPostInsertStatements, failIfRequired, findReferencedEntities, generatePendingStatements, getName, getValue, isRequired, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratedIdProperty

public GeneratedIdProperty(EntityClass<E> entityClass,
                           AttributeAccessor attribute,
                           javax.persistence.Column column)

Creates a new instance of GeneratedIdProperty.

Parameters:

entityClass - the entity class

attribute - the accessor of the id attribute

column - the column annotation

Method Detail

addInsertExpression

public void addInsertExpression(E entity,
                                InsertStatement statement)

Description copied from class: Property

Adds an expression according to the current value of the property for the given entity to an SQL insert statement.

Overrides:

addInsertExpression in class PrimitiveProperty<E,Number>

Parameters:

entity - the inspected entity

statement - the created statement

createPreInsertStatements

public List<? extends EntityStatement> createPreInsertStatements(E entity)

Description copied from class: Property

Creates SQL statements that are necessary before this property is written (e.g. for updating the table generator).

Overrides:

createPreInsertStatements in class Property<E,Number>

Parameters:

entity - the inspected entity

Returns:

the list of addition statements

getExpression

public String getExpression(E entity,
                            boolean whereExpression)

Creates the reference of an entity in SQL using its (relative or absolute) id.

Overrides:

getExpression in class PrimitiveProperty<E,Number>

Parameters:

entity - the entity

whereExpression - indicates that the reference is used in a "where" statement

Returns:

the expression for the ID of that entity or null if the entity was not written up to now

Throws:

IllegalArgumentException - if the entity is a reference without any id

isNew

public boolean isNew(E entity)

Indicates that the given entity needs to be written.

Parameters:

entity - the entity to check

Returns:

true if the id of the given entity is not set up to now

isReference

public boolean isReference(E entity)

Indicates that the given entity was not written before, but exists already in the database.

Parameters:

entity - the entity to check

Returns:

true if the entity was marked as reference

markReference

public void markReference(E entity)

Marks an entity as reference, where we don't know the ID database. A reference is not written during SQL generation, because it exists already in the database when the script is executed. As we don't know the ID during build time we have to reference it using some unique properties.

Parameters:

entity - the entity to mark

markReference

public void markReference(E entity,
                          long id)

Marks an entity as reference, where we know the id in the database. A reference is not written during SQL generation, because it exists already in the database when the script is executed.

Parameters:

entity - the entity to mark

id - the id of the entity in the database

postInsert

public void postInsert(E entity)

Called after the insert statement was written, to update any nessecary state in the context.

Parameters:

entity - the current entity