Package org.fastnate.generator.context

Class MapProperty<E,K,T>

java.lang.Object

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

org.fastnate.generator.context.PluralProperty<E,Map<K,T>,T>

org.fastnate.generator.context.MapProperty<E,K,T>

Type Parameters:

E - The type of the container entity

K - The type of the key of the map

T - The type of the entity inside of the collection

public class MapProperty<E,K,T>
extends PluralProperty<E,Map<K,T>,T>

Describes a property of an EntityClass that is a Map.

Author:

Tobias Liefke

Nested Class Summary

Nested classes/interfaces inherited from class org.fastnate.generator.context.PluralProperty

PluralProperty.EntityMappingInformation

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<K>	keyClass	The class of the key of the map.
private final GeneratorColumn	keyColumn	The name of the column that contains the key.
private final ValueConverter<K>	keyConverter	The converter for the target value, null if not a primitive value.
private final EntityClass<K>	keyEntityClass	The description of the key class, null if not an entity.

Constructor Summary

Constructors

Constructor	Description
MapProperty(EntityClass<?> sourceClass, AttributeAccessor attribute, jakarta.persistence.AssociationOverride associationOverride, jakarta.persistence.AttributeOverride attributeOverride)	Creates a new map property.

Method Summary

Modifier and Type	Method	Description
private static GeneratorColumn	buildKeyColumn(GeneratorTable table, jakarta.persistence.MapKeyColumn keyColumn, String defaultKeyColumn)
private static GeneratorColumn	buildKeyColumn(GeneratorTable table, jakarta.persistence.MapKeyJoinColumn keyColumn, String defaultKeyColumn)
void	createPostInsertStatements(StatementsWriter writer, E entity)	Creates additional SQL statements that are necessary after this property is written (e.g. for mapping tables).
Collection<?>	findReferencedEntities(E entity)	Finds all entities in the current property, that are referenced.
Class<K>	getKeyClass()	The class of the key of the map.
GeneratorColumn	getKeyColumn()	The name of the column that contains the key.
ValueConverter<K>	getKeyConverter()	The converter for the target value, null if not a primitive value.
EntityClass<K>	getKeyEntityClass()	The description of the key class, null if not an entity.
Map<K,T>	getValue(E entity)	Resolves the current value for this property on the given entity.
static boolean	isMapProperty(AttributeAccessor attribute)	Indicates that the given attribute references a map and may be used by an MapProperty.

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

addInsertExpression, buildEmbeddedProperties, buildIdColumn, createDirectValueStatement, createValueExpression, createValueStatement, findEntityMappingInformation, generatePendingStatements, getContext, getDialect, getEmbeddedProperties, getEmbeddedPropertiesByName, getIdColumn, getInverseProperty, getMappedBy, getMappedId, getPropertyArgument, getRequiredEmbeddedProperties, getTable, getValueClass, getValueColumn, getValueConstructor, getValueConverter, getValueEntityClass, hasPluralAnnotation, isComposition, isEmbedded, isEntityReference, isRequired, isTableColumn, isUseTargetTable, newElement, writeValueExpression

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

createPreInsertStatements, failIfRequired, getAttribute, getExpression, getName, getPredicate, getType, isComposition, setValue, toString

Methods inherited from class java.lang.Object

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

Field Details

keyClass

private final Class<K> keyClass

The class of the key of the map.

keyEntityClass

private final EntityClass<K> keyEntityClass

The description of the key class, null if not an entity.

keyConverter

private final ValueConverter<K> keyConverter

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

keyColumn

private final GeneratorColumn keyColumn

The name of the column that contains the key.

Constructor Details

MapProperty

public MapProperty(EntityClass<?> sourceClass,
 AttributeAccessor attribute,
 jakarta.persistence.AssociationOverride associationOverride,
 jakarta.persistence.AttributeOverride attributeOverride)

Creates a new map property.

Parameters:

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

attribute - the accessor of the represented attribute

associationOverride - the configured assocation override

attributeOverride - the configured attribute override, if we reference an ElementCollection

Method Details

buildKeyColumn

private static GeneratorColumn buildKeyColumn(GeneratorTable table,
 jakarta.persistence.MapKeyColumn keyColumn,
 String defaultKeyColumn)

buildKeyColumn

private static GeneratorColumn buildKeyColumn(GeneratorTable table,
 jakarta.persistence.MapKeyJoinColumn keyColumn,
 String defaultKeyColumn)

isMapProperty

public static boolean isMapProperty(AttributeAccessor attribute)

Indicates that the given attribute references a map and may be used by an MapProperty.

Parameters:

attribute - the attribute to check

Returns:

true if an MapProperty may be created for the given attribute

createPostInsertStatements

public void createPostInsertStatements(StatementsWriter writer,
 E entity)
                                throws IOException

Description copied from class: Property

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

Overrides:

createPostInsertStatements in class Property<E,Map<K,T>>

Parameters:

writer - the target of the created statements

entity - the inspected entity

Throws:

IOException - if the writer throws one

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,Map<K,T>>

Parameters:

entity - the inspected entity

Returns:

all referenced entities

getValue

public Map<K,T> getValue(E entity)

Description copied from class: Property

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

Overrides:

getValue in class Property<E,Map<K,T>>

Parameters:

entity - the entity to inspect

Returns:

the value, null if entity is null

getKeyClass

public Class<K> getKeyClass()

The class of the key of the map.

getKeyEntityClass

public EntityClass<K> getKeyEntityClass()

The description of the key class, null if not an entity.

getKeyConverter

public ValueConverter<K> getKeyConverter()

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

getKeyColumn

public GeneratorColumn getKeyColumn()

The name of the column that contains the key.

Specified by:

getKeyColumn in class PluralProperty<E,Map<K,T>,T>

Returns:

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