org.fastnate.generator.context

Class PluralProperty<E,C,T>

java.lang.Object

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

org.fastnate.generator.context.PluralProperty<E,C,T>

Type Parameters:

E - The type of the container class

C - The type of the collection of map

T - The type of the elements in the collection

Direct Known Subclasses:

CollectionProperty, MapProperty

public abstract class PluralProperty<E,C,T>
extends Property<E,C>

Base class for MapProperty and CollectionProperty.

Author:

Tobias Liefke

Constructor Summary

Constructors

Constructor and Description
PluralProperty(EntityClass<?> sourceClass, AttributeAccessor attribute, javax.persistence.AssociationOverride override, int valueArgumentIndex) Creates a new 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.
protected void	buildEmbeddedProperties(Class<?> targetType) Builds the embedded properties of this property.
protected static String	buildIdColumn(AttributeAccessor attribute, javax.persistence.AssociationOverride override, javax.persistence.CollectionTable collectionMetadata, String defaultIdColumn) Builds the name of the column that contains the ID of the entity for the given attribute.
protected static String	buildIdColumn(AttributeAccessor attribute, javax.persistence.AssociationOverride override, javax.persistence.JoinTable joinTable, javax.persistence.CollectionTable tableMetadata, String defaultIdColumn) Builds the name of the column that contains the ID of the entity for the given attribute.
protected static String	buildTableName(AttributeAccessor attribute, javax.persistence.AssociationOverride override, javax.persistence.JoinTable joinTable, javax.persistence.CollectionTable collectionTable, String defaultTableName) Builds the name of the table of the association for the given field.
protected static String	buildTableName(javax.persistence.CollectionTable tableMetadata, String defaultTableName) Builds the name of the table of the association for the given field.
protected static String	buildValueColumn(AttributeAccessor attribute, String defaultValueColumn) Builds the name of the column that contains the value for the collection / map.
protected EntityStatement	createDirectValueStatement(E entity, String sourceId, String key, T value) Creates the statements for a (not embeddable) value from the collection.
protected String	createValueExpression(E entity, String sourceId, T value, String key) Creates a SQL expression for a value of the collection, as long as it is not embedded.
protected EntityStatement	createValueStatement(E entity, String sourceId, String key, T value) Adds a value statement to the list of collection statements.
List<EntityStatement>	generatePendingStatements(E entity, Object writtenEntity, Object... arguments) Generates the update statements for an entity that are required after another entity was generated.
GeneratorContext	getContext() The current context.
List<SingularProperty<T,?>>	getEmbeddedProperties() Contains all properties of an embedded element collection.
String	getIdColumn() The name of the column that contains the id of the entity.
protected abstract String	getKeyColumn() An optional column that contains the index / key of the values.
String	getMappedBy() Indicates that this property is defined by another property on the target type.
String	getMappedId() The property to use, if an id is embedded.
protected static <T> Class<T>	getPropertyArgument(AttributeAccessor attribute, Class<T> explicitClass, int argumentIndex) Inspects the given attribute and searches for a generic type argument.
List<EntityProperty<T,?>>	getRequiredEmbeddedProperties() Contains all properties of an embedded element collection which reference a required entity.
String	getTable() The name of the modified table.
Class<T>	getValueClass() The class of the value of the collection.
String	getValueColumn() The name of the column that contains the value (or the id of the value).
ValueConverter<T>	getValueConverter() The converter for the value of the collection, null if not a primitive value.
EntityClass<T>	getValueEntityClass() The description of the valueClass, null if not an entity.
boolean	isEmbedded() Indicates that this propery is a ElementCollection that references Embeddables.
protected boolean	isEntityReference() Indicates that entities are referenced by the collection.
boolean	isRequired() Indicates if this property is an required field in the database (needs to exist when the insert statement is written).
boolean	isTableColumn() Indicates that this property maps to a column from the parent table.
boolean	isUseTargetTable() Indicates to use a column of the target table.

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

createPostInsertStatements, createPreInsertStatements, failIfRequired, findReferencedEntities, getAttribute, getExpression, getName, getPredicate, getValue, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PluralProperty

public PluralProperty(EntityClass<?> sourceClass,
                      AttributeAccessor attribute,
                      javax.persistence.AssociationOverride override,
                      int valueArgumentIndex)

Creates a new property.

Parameters:

sourceClass - the description of the current inspected class that contains this property

attribute - accessor to the represented attribute

override - the configured assocation override

valueArgumentIndex - the index of the value argument in the collection class (0 for collection, 1 for map)

Method Detail

buildIdColumn

protected static String buildIdColumn(AttributeAccessor attribute,
                                      javax.persistence.AssociationOverride override,
                                      javax.persistence.CollectionTable collectionMetadata,
                                      String defaultIdColumn)

Builds the name of the column that contains the ID of the entity for the given attribute.

Parameters:

attribute - the accessor for the inspected attribute

override - contains optional override options

collectionMetadata - the default join column

defaultIdColumn - the default name for the column, if joinColumn is empty or null

Returns:

the column name

buildIdColumn

protected static String buildIdColumn(AttributeAccessor attribute,
                                      javax.persistence.AssociationOverride override,
                                      javax.persistence.JoinTable joinTable,
                                      javax.persistence.CollectionTable tableMetadata,
                                      String defaultIdColumn)

Builds the name of the column that contains the ID of the entity for the given attribute.

Parameters:

attribute - the inspected attribute

override - contains optional override options

joinTable - the optional join table date

tableMetadata - the optional

defaultIdColumn - the default name for the column, if joinColumn is empty or null

Returns:

the column name

buildTableName

protected static String buildTableName(AttributeAccessor attribute,
                                       javax.persistence.AssociationOverride override,
                                       javax.persistence.JoinTable joinTable,
                                       javax.persistence.CollectionTable collectionTable,
                                       String defaultTableName)

Builds the name of the table of the association for the given field.

Parameters:

attribute - the inspected field

override - contains optional override options

joinTable - the optional join table

collectionTable - the optional metadata of the table

defaultTableName - the default name for the table

Returns:

the table name

buildTableName

protected static String buildTableName(javax.persistence.CollectionTable tableMetadata,
                                       String defaultTableName)

Builds the name of the table of the association for the given field.

Parameters:

tableMetadata - the current metadata of the field

defaultTableName - the default name for the table

Returns:

the column name

buildValueColumn

protected static String buildValueColumn(AttributeAccessor attribute,
                                         String defaultValueColumn)

Builds the name of the column that contains the value for the collection / map.

Parameters:

attribute - the inspected attribute

defaultValueColumn - the default name

Returns:

the column name

getPropertyArgument

protected static <T> Class<T> getPropertyArgument(AttributeAccessor attribute,
                                                  Class<T> explicitClass,
                                                  int argumentIndex)

Inspects the given attribute and searches for a generic type argument.

Parameters:

attribute - the attribute to inspect

explicitClass - an explicit class to use, if the metadata specified one

argumentIndex - the index of the argument, for maps there are two: the key and the value

Returns:

the found class

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

Parameters:

entity - the inspected entity

statement - the created statement

buildEmbeddedProperties

protected void buildEmbeddedProperties(Class<?> targetType)

Builds the embedded properties of this property.

Parameters:

targetType - the target type

createDirectValueStatement

protected EntityStatement createDirectValueStatement(E entity,
                                                     String sourceId,
                                                     String key,
                                                     T value)

Creates the statements for a (not embeddable) value from the collection.

Parameters:

entity - the entity that contains the collection resp. map.

sourceId - the ID of the current entity

key - the value of the getKeyColumn() - either the index or the map key

value - the current value in the collection

Returns:

the list of statements to apply for the given value

createValueExpression

protected String createValueExpression(E entity,
                                       String sourceId,
                                       T value,
                                       String key)

Creates a SQL expression for a value of the collection, as long as it is not embedded.

Parameters:

entity - the entity that contains the collection

sourceId - the id of the entity as SQL expression

key - the key/index of the entity in the collection as SQL expression

value - the value that is written

Returns:

the statement or null if the insert is still pending

createValueStatement

protected EntityStatement createValueStatement(E entity,
                                               String sourceId,
                                               String key,
                                               T value)

Adds a value statement to the list of collection statements.

Parameters:

entity - the entity that contains the collection

sourceId - the id of the entity as SQL expression

key - the key/index of the entity in the collection as SQL expression

value - the value that is written

Returns:

the statement or null if the insert is still pending

generatePendingStatements

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

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,C>

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

getKeyColumn

protected abstract String getKeyColumn()

An optional column that contains the index / key of the values.

Returns:

the key column for map properties resp. the index column for list properties

isEmbedded

public boolean isEmbedded()

Indicates that this propery is a ElementCollection that references Embeddables.

Returns:

true if getEmbeddedProperties() returns a list of properties

isEntityReference

protected boolean isEntityReference()

Indicates that entities are referenced by the collection.

Returns:

true if the values of the collection are entities

isRequired

public boolean isRequired()

Description copied from class: Property

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

Overrides:

isRequired in class Property<E,C>

Returns:

true if the field is required

isTableColumn

public boolean isTableColumn()

Description copied from class: Property

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

Specified by:

isTableColumn in class Property<E,C>

Returns:

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

getContext

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

The current context.

getEmbeddedProperties

@Generated(value="lombok")
public List<SingularProperty<T,?>> getEmbeddedProperties()

Contains all properties of an embedded element collection.

getRequiredEmbeddedProperties

@Generated(value="lombok")
public List<EntityProperty<T,?>> getRequiredEmbeddedProperties()

Contains all properties of an embedded element collection which reference a required entity.

getMappedId

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

The property to use, if an id is embedded.

getTable

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

The name of the modified table.

getIdColumn

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

The name of the column that contains the id of the entity.

getMappedBy

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

Indicates that this property is defined by another property on the target type.

isUseTargetTable

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

Indicates to use a column of the target table.

getValueColumn

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

The name of the column that contains the value (or the id of the value).

getValueClass

@Generated(value="lombok")
public Class<T> getValueClass()

The class of the value of the collection.

getValueEntityClass

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

The description of the valueClass, null if not an entity.

getValueConverter

@Generated(value="lombok")
public ValueConverter<T> getValueConverter()

The converter for the value of the collection, null if not a primitive value.