org.fastnate.generator.context

Class Property<E,T>

java.lang.Object

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

Type Parameters:

E - The type of the container class

T - The type of the value of the property

Direct Known Subclasses:

EmbeddedProperty, PluralProperty, SingularProperty

public abstract class Property<E,T>
extends Object

Base class for the description of properties of an EntityClass.

Author:

Tobias Liefke

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Property(AttributeAccessor attribute) Creates a new instance of a property.

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<EntityStatement>	createPostInsertStatements(E entity) Creates additional SQL statements that are necessary after this property is written (e.g. for mapping tables) .
List<? extends EntityStatement>	createPreInsertStatements(E entity) Creates SQL statements that are necessary before this property is written (e.g. for updating the table generator).
protected void	failIfRequired() Throws an IllegalArgumentException if the field was not filled.
Collection<?>	findReferencedEntities(E entity) Finds all entities in the current property, that are referenced.
List<EntityStatement>	generatePendingStatements(E entity, Object writtenEntity, Object... arguments) Generates the update statements for an entity that are required after another entity was generated.
String	getExpression(E entity, boolean whereExpression) Creates the expression for the current value of the given entity in SQL.
String	getName() The name of this property.
String	getPredicate(E entity) Creates an SQL predicate that references all entities that have the same value as the given entity.
T	getValue(E entity) Resolves the current value for this property on the given entity.
boolean	isRequired() Indicates if this property is an required field in the database (needs to exist when the insert statement is written).
abstract boolean	isTableColumn() Indicates that this property maps to a column from the parent table.
protected void	setValue(E entity, T value) Sets a new value for this property on the given entity.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

protected Property(AttributeAccessor attribute)

Creates a new instance of a property.

Parameters:

attribute - the accessor of the target attribute

Method Detail

addInsertExpression

public 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.

Parameters:

entity - the inspected entity

statement - the created statement

createPostInsertStatements

public List<EntityStatement> createPostInsertStatements(E entity)

Creates additional SQL statements that are necessary after this property is written (e.g. for mapping tables) .

Parameters:

entity - the inspected entity

Returns:

the list of addition insert statements

createPreInsertStatements

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

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

Parameters:

entity - the inspected entity

Returns:

the list of addition statements

failIfRequired

protected void failIfRequired()

Throws an IllegalArgumentException if the field was not filled.

findReferencedEntities

public Collection<?> findReferencedEntities(E entity)

Finds all entities in the current property, that are referenced.

Parameters:

entity - the inspected entity

Returns:

all referenced entities

generatePendingStatements

public List<EntityStatement> generatePendingStatements(E entity,
                                                       Object writtenEntity,
                                                       Object... arguments)

Generates the update statements for an entity that are required after another entity was generated. Only called, if EntityClass.markPendingUpdates(E, V, org.fastnate.generator.context.Property<V, ?>, java.lang.Object...) was called before for writtenEntity

Parameters:

entity - the entity that needs to be updated

writtenEntity - the entity that exists now in the database

arguments - additional arguments that where given to markPendingUpdates

Returns:

the list of pending statements

getExpression

public String getExpression(E entity,
                            boolean whereExpression)

Creates the expression for the current value of the given entity in SQL.

Parameters:

entity - the entity

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

Returns:

the expression for the value of this property or null if no exists

getName

public String getName()

The name of this property.

Returns:

the name

getPredicate

public String getPredicate(E entity)

Creates an SQL predicate that references all entities that have the same value as the given entity. Used to reference entites by their (unique) properties or ids.

Parameters:

entity - the entity

Returns:

the predicate for the value of that entity or null if no such expression is available

getValue

public T getValue(E entity)

Resolves the current value for this property on the given entity.

Parameters:

entity - the entity to inspect

Returns:

the value, null if entity is null

isRequired

public boolean isRequired()

Indicates if this property is an required field in the database (needs to exist when the insert statement is written).

Returns:

true if the field is required

isTableColumn

public abstract boolean isTableColumn()

Indicates that this property maps to a column from the parent table.

Returns:

true if addInsertExpression(Object, InsertStatement) will add the corresponding value to the given statement

setValue

protected void setValue(E entity,
                        T value)

Sets a new value for this property on the given entity.

Parameters:

entity - the entity to inspect

value - the new value

toString

public String toString()

Overrides:

toString in class Object