org.batoo.jpa.core.impl.model.mapping

Class SingularAssociationMapping<Z,X>

java.lang.Object

org.batoo.jpa.core.impl.model.mapping.Mapping<Z,X,Y>

org.batoo.jpa.core.impl.model.mapping.AssociationMapping<Z,X,X>

org.batoo.jpa.core.impl.model.mapping.SingularAssociationMapping<Z,X>

Type Parameters:

Z - the source type

X - the destination type

All Implemented Interfaces:

JoinedMapping<Z,X,X>

public class SingularAssociationMapping<Z,X>
extends AssociationMapping<Z,X,X>

Mappings for one-to-one and many-to-one associations.

Since:

$version

Author:

hceylan

Nested Class Summary

Nested classes/interfaces inherited from interface org.batoo.jpa.core.impl.model.mapping.JoinedMapping

JoinedMapping.MappingType

Constructor Summary

Constructors

Constructor and Description
SingularAssociationMapping(ParentMapping<?,Z> parent, AssociatedSingularAttribute<? super Z,X> attribute)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkTransient(ManagedInstance<?> managedInstance) Checks that the association references not a transient instance
Object	extractKey(Object value) Extracts key from the value.
void	flush(Connection connection, ManagedInstance<?> managedInstance, boolean removals, boolean force) Flushes the associates.
AssociatedSingularAttribute<? super Z,X>	getAttribute() Returns the attribute of the mapping.
ForeignKey	getForeignKey() Returns the foreign key of the mapping.
AssociationMapping<?,?,?>	getInverse() Returns the inverse attribute.
JoinedMapping.MappingType	getMappingType() Returns the type of the mapping.
JoinTable	getTable() Returns the join table of the mapping.
EntityTypeImpl<X>	getType() Returns the bindable entity type.
void	initialize(ManagedInstance<?> managedInstance) Initializes the mapping.
boolean	isAssociation() Returns if the mapping is an association.
boolean	isJoined() Returns if the mapping is a joined mapping.
boolean	isMap() Returns if the mapping is a map collection.
void	link() Links the attribute to its associate entity type and inverse attribute if bidirectional.
void	mergeWith(EntityManagerImpl entityManager, ManagedInstance<?> instance, Object entity, org.apache.commons.lang.mutable.MutableBoolean requiresFlush, IdentityHashMap<Object,Object> processed) Merges the association of the instance with the entity.
boolean	references(Object instance, Object reference)
void	refresh(ManagedInstance<?> instance, Set<Object> processed) Refreshes the association
void	setInverse(AssociationMapping<?,?,?> inverse) Sets the inverse attribute.

Methods inherited from class org.batoo.jpa.core.impl.model.mapping.AssociationMapping

cascadesDetach, cascadesMerge, cascadesPersist, cascadesRefresh, cascadesRemove, getAssociationMetadata, getMappedBy, getMaxFetchJoinDepth, getSelectCriteria, isEager, isOwner, join, removesOrphans

Methods inherited from class org.batoo.jpa.core.impl.model.mapping.Mapping

equals, get, getJavaType, getName, getParent, getPath, getRoot, hashCode, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.batoo.jpa.core.impl.model.mapping.JoinedMapping

getPath

Constructor Detail

SingularAssociationMapping

public SingularAssociationMapping(ParentMapping<?,Z> parent,
                          AssociatedSingularAttribute<? super Z,X> attribute)

Parameters:

parent - the parent mapping

attribute - the attribute

Since:

$version

Method Detail

checkTransient

public void checkTransient(ManagedInstance<?> managedInstance)

Checks that the association references not a transient instance

Specified by:

checkTransient in class AssociationMapping<Z,X,X>

Parameters:

managedInstance - the managed instance

extractKey

public Object extractKey(Object value)

Extracts key from the value.

Parameters:

value - the value

Returns:

the key of the value

flush

public void flush(Connection connection,
         ManagedInstance<?> managedInstance,
         boolean removals,
         boolean force)
           throws SQLException

Flushes the associates.

Parameters:

connection - the connection to use

managedInstance - the managed instance

removals - true if the removals should be flushed and false for the additions

force - true to force, effective only for insertions and for new entities.

Throws:

SQLException - thrown if there is an underlying SQL Exception

getAttribute

public AssociatedSingularAttribute<? super Z,X> getAttribute()

Returns the attribute of the mapping.

Specified by:

getAttribute in interface JoinedMapping<Z,X,X>

Specified by:

getAttribute in class Mapping<Z,X,X>

Returns:

the attribute of the mapping

getForeignKey

public ForeignKey getForeignKey()

Returns the foreign key of the mapping.

Specified by:

getForeignKey in class AssociationMapping<Z,X,X>

Returns:

the foreign key of the mapping

getInverse

public AssociationMapping<?,?,?> getInverse()

Returns the inverse attribute.

Specified by:

getInverse in class AssociationMapping<Z,X,X>

Returns:

the inverse attribute or null

getMappingType

public JoinedMapping.MappingType getMappingType()

Returns the type of the mapping.

Returns:

the type of the mapping

getTable

public JoinTable getTable()

Returns the join table of the mapping.

Specified by:

getTable in interface JoinedMapping<Z,X,X>

Specified by:

getTable in class AssociationMapping<Z,X,X>

Returns:

the join table of the mapping

getType

public EntityTypeImpl<X> getType()

Returns the bindable entity type.

Specified by:

getType in interface JoinedMapping<Z,X,X>

Specified by:

getType in class AssociationMapping<Z,X,X>

Returns:

the bindable entity type

initialize

public void initialize(ManagedInstance<?> managedInstance)

Initializes the mapping.

Parameters:

managedInstance - the instance

isAssociation

public boolean isAssociation()

Returns if the mapping is an association.

Returns:

true if the mapping is an association, false otherwise

isJoined

public boolean isJoined()

Returns if the mapping is a joined mapping.

Returns:

true if the mapping is a joined mapping, false otherwise

isMap

public boolean isMap()

Returns if the mapping is a map collection.

Returns:

true if the mapping is a map collection, false otherwise

link

public void link()
          throws MappingException

Links the attribute to its associate entity type and inverse attribute if bidirectional.

Specified by:

link in class AssociationMapping<Z,X,X>

Throws:

MappingException - thrown in case of a linkage error

mergeWith

public void mergeWith(EntityManagerImpl entityManager,
             ManagedInstance<?> instance,
             Object entity,
             org.apache.commons.lang.mutable.MutableBoolean requiresFlush,
             IdentityHashMap<Object,Object> processed)

Merges the association of the instance with the entity.

Specified by:

mergeWith in class AssociationMapping<Z,X,X>

Parameters:

entityManager - the entity manager

instance - the instance

entity - the entity

requiresFlush - if an implicit flush is required

processed - registry of processed entities

references

public boolean references(Object instance,
                 Object reference)

Specified by:

references in class AssociationMapping<Z,X,X>

Parameters:

instance - the source instance

reference - the associate instance

Returns:

true if source contains reference to the associate, false otherwise

refresh

public void refresh(ManagedInstance<?> instance,
           Set<Object> processed)

Refreshes the association

Specified by:

refresh in class AssociationMapping<Z,X,X>

Parameters:

instance - the instance that is the owner of the association

processed - the set of processed instances

setInverse

public void setInverse(AssociationMapping<?,?,?> inverse)

Sets the inverse attribute.

Specified by:

setInverse in class AssociationMapping<Z,X,X>

Parameters:

inverse - the inverse association