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(GeneratorContext context, AttributeAccessor attribute) 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.
abstract String	getIdColumn() The name of the column that contains the ID of the entity that contains this collection.
protected static <T> Class<T>	getPropertyArgument(AttributeAccessor attribute, Class<T> explicitClass, int argumentIndex) Inspects the given attribute and searches for a generic type argument.
abstract String	getTable() The name of the table of this property, if any.
abstract String	getValueColumn() The name of the column that contains the values of the collection.
boolean	isEmbedded() Indicates that this propery is a ElementCollection that references Embeddables.
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.

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

createPostInsertStatements, createPreInsertStatements, failIfRequired, findReferencedEntities, generatePendingStatements, 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(GeneratorContext context,
                      AttributeAccessor attribute)

Creates a new property.

Parameters:

context - the current context

attribute - accessor to the represented attribute

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

getIdColumn

public abstract String getIdColumn()

The name of the column that contains the ID of the entity that contains this collection.

Returns:

the name of the ID column

getTable

public abstract String getTable()

The name of the table of this property, if any.

Returns:

the name of the table

getValueColumn

public abstract String getValueColumn()

The name of the column that contains the values of the collection.

Returns:

the name of the value column or null if embedded

isEmbedded

public boolean isEmbedded()

Indicates that this propery is a ElementCollection that references Embeddables.

Returns:

true if #getEmbeddedProperties() returns a list of properties

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