org.fastnate.generator.context

Class EntityProperty<E,T>

java.lang.Object

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

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

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

Type Parameters:

E - The type of the container entity

T - The type of the target entity

public class EntityProperty<E,T>
extends SingularProperty<E,T>

Describes a property of an EntityClass that references another entity.

Author:

Tobias Liefke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	EntityProperty.MappingInformation Helper for evaluating correct mapping information from the annotations.

Field Summary

Fields

Modifier and Type	Field and Description
private AnyMapping<T>	anyMapping Contains information about an addition class column, if Any is used.
private GeneratorColumn	column The name of the join column.
private boolean	composition Indicates that, according to the CascadeType, we should remove the target entity when the current entity is removed.
private GeneratorContext	context The current context.
private String	idField The name of the id for referencing an embedded id.
private Property<T,?>	inverseProperty The opposite property of a bidirectional mapping.
private String	mappedBy The optional name of a property in the target type, that owns the relationship.
private boolean	required Indicates, that this property needs a value.
private EntityClass<T>	targetClass The description of the type of this property.

Constructor Summary

Constructors

Constructor and Description
EntityProperty(GeneratorContext context, GeneratorTable containerTable, AttributeAccessor attribute, javax.persistence.AssociationOverride override) Creates a new instance of EntityProperty.

Method Summary

Modifier and Type	Method and Description
void	addInsertExpression(TableStatement statement, E entity) Adds an expression according to the current value of the property for the given entity to an SQL insert statement.
Collection<?>	findReferencedEntities(E entity) Finds all entities in the current property, that are referenced.
void	generatePendingStatements(StatementsWriter writer, E entity, Object writtenEntity, Object... arguments) Generates the update statements for an entity that are required after another entity was generated.
AnyMapping<T>	getAnyMapping() Contains information about an addition class column, if Any is used.
GeneratorColumn	getColumn() The name of the join column.
GeneratorContext	getContext() The current context.
ColumnExpression	getExpression(E entity, boolean whereExpression) Creates the expression for the current value of the given entity in SQL.
String	getIdField() The name of the id for referencing an embedded id.
Property<T,?>	getInverseProperty() The opposite property of a bidirectional mapping.
String	getMappedBy() The optional name of a property in the target type, that owns the relationship.
String	getPredicate(E entity) Creates an SQL predicate that references all entities that have the same value as the given entity.
EntityClass<T>	getTargetClass() The description of the type of this property.
boolean	isComposition() Indicates that, according to the CascadeType, we should remove the target entity when the current entity is removed.
(package private) static boolean	isEntityProperty(AttributeAccessor attribute) Indicates that the given attribute references an entity and may be used by an EntityProperty.
boolean	isRequired() Indicates, that this property needs a value.
boolean	isTableColumn() Indicates that this property maps to a column from the parent table.
(package private) void	setInverseProperty(Property<T,?> inverseProperty) The opposite property of a bidirectional mapping.

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

createPostInsertStatements, createPreInsertStatements, failIfRequired, getAttribute, getName, getType, getValue, isComposition, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

context

private final GeneratorContext context

The current context.

targetClass

private final EntityClass<T> targetClass

The description of the type of this property. Usually null for attributes defined as type Any.

required

private final boolean required

Indicates, that this property needs a value.

composition

private final boolean composition

Indicates that, according to the CascadeType, we should remove the target entity when the current entity is removed.

mappedBy

private final String mappedBy

The optional name of a property in the target type, that owns the relationship.

See Also:

OneToOne.mappedBy()

inverseProperty

private Property<T,?> inverseProperty

The opposite property of a bidirectional mapping.

column

private final GeneratorColumn column

The name of the join column.

idField

private final String idField

The name of the id for referencing an embedded id.

anyMapping

private final AnyMapping<T> anyMapping

Contains information about an addition class column, if Any is used.

Constructor Detail

EntityProperty

public EntityProperty(GeneratorContext context,
                      GeneratorTable containerTable,
                      AttributeAccessor attribute,
                      @Nullable
                      javax.persistence.AssociationOverride override)

Creates a new instance of EntityProperty.

Parameters:

context - the generator context.

containerTable - the table that contains our column

attribute - the accessor of the attribute

override - optional AttributeOverride configuration.

Method Detail

isEntityProperty

static boolean isEntityProperty(AttributeAccessor attribute)

Indicates that the given attribute references an entity and may be used by an EntityProperty.

Parameters:

attribute - accessor of the attribute to check

Returns:

true if an EntityProperty may be created for the given attribute

addInsertExpression

public void addInsertExpression(TableStatement statement,
                                E entity)

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 Property<E,T>

Parameters:

statement - the created statement

entity - the inspected entity

findReferencedEntities

public Collection<?> findReferencedEntities(E entity)

Description copied from class: Property

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

Overrides:

findReferencedEntities in class Property<E,T>

Parameters:

entity - the inspected entity

Returns:

all referenced entities

generatePendingStatements

public void generatePendingStatements(StatementsWriter writer,
                                      E entity,
                                      Object writtenEntity,
                                      Object... arguments)
                               throws IOException

Description copied from class: Property

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

Overrides:

generatePendingStatements in class Property<E,T>

Parameters:

writer - the target of the generated statements

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

Throws:

IOException - if the writer throws one

getExpression

public ColumnExpression getExpression(E entity,
                                      boolean whereExpression)

Description copied from class: Property

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

Overrides:

getExpression in class Property<E,T>

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

getPredicate

public String getPredicate(E entity)

Description copied from class: Property

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.

Overrides:

getPredicate in class Property<E,T>

Parameters:

entity - the entity

Returns:

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

isTableColumn

public boolean isTableColumn()

Description copied from class: Property

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

Overrides:

isTableColumn in class SingularProperty<E,T>

Returns:

true if Property.addInsertExpression(org.fastnate.generator.statements.TableStatement, E) will add the corresponding value to the given statement

getContext

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

The current context.

getTargetClass

@Generated(value="lombok")
public EntityClass<T> getTargetClass()

The description of the type of this property. Usually null for attributes defined as type Any.

isRequired

@Generated(value="lombok")
public boolean isRequired()

Indicates, that this property needs a value.

Overrides:

isRequired in class Property<E,T>

Returns:

true if the field is required

isComposition

@Generated(value="lombok")
public boolean isComposition()

Indicates that, according to the CascadeType, we should remove the target entity when the current entity is removed.

getMappedBy

@Generated(value="lombok")
public String getMappedBy()

The optional name of a property in the target type, that owns the relationship.

See Also:

OneToOne.mappedBy()

getInverseProperty

@Generated(value="lombok")
public Property<T,?> getInverseProperty()

The opposite property of a bidirectional mapping.

getColumn

@Generated(value="lombok")
public GeneratorColumn getColumn()

The name of the join column.

Specified by:

getColumn in class SingularProperty<E,T>

Returns:

the column name

getIdField

@Generated(value="lombok")
public String getIdField()

The name of the id for referencing an embedded id.

getAnyMapping

@Generated(value="lombok")
public AnyMapping<T> getAnyMapping()

Contains information about an addition class column, if Any is used.

setInverseProperty

@Generated(value="lombok")
void setInverseProperty(Property<T,?> inverseProperty)

The opposite property of a bidirectional mapping.