org.hibernate.envers.internal.entities.mapper

Class ComponentPropertyMapper

java.lang.Object

org.hibernate.envers.internal.entities.mapper.AbstractPropertyMapper

org.hibernate.envers.internal.entities.mapper.ComponentPropertyMapper

All Implemented Interfaces:

CompositeMapperBuilder, DynamicComponentMapperSupport, ModifiedFlagMapperSupport, PropertyMapper, SimpleMapperBuilder

public class ComponentPropertyMapper
extends AbstractPropertyMapper
implements CompositeMapperBuilder

Author:

Adam Warski (adam at warski dot org), Michal Skowronek (mskowr at o2 dot pl), Lukasz Zuchowski (author at zuchos dot com), Chris Cranford

Constructor Summary

Constructors

Constructor and Description
ComponentPropertyMapper(PropertyData propertyData, Class componentClass)

Method Summary

Modifier and Type	Method and Description
void	add(PropertyData propertyData)
CompositeMapperBuilder	addComponent(PropertyData propertyData, Class componentClass)
void	addComposite(PropertyData propertyData, PropertyMapper propertyMapper)
Map<PropertyData,PropertyMapper>	getProperties()
boolean	hasPropertiesWithModifiedFlag() Returns whether the associated PropertyMapper has any properties that use the witModifiedFlag feature.
List<PersistentCollectionChangeData>	mapCollectionChanges(SessionImplementor session, String referencingPropertyName, PersistentCollection newColl, Serializable oldColl, Serializable id) Maps collection changes.
void	mapModifiedFlagsToMapForCollectionChange(String collectionPropertyName, Map<String,Object> data)
void	mapModifiedFlagsToMapFromEntity(SessionImplementor session, Map<String,Object> data, Object newObj, Object oldObj)
void	mapToEntityFromMap(EnversService enversService, Object obj, Map data, Object primaryKey, AuditReaderImplementor versionsReader, Number revision) Maps properties from the given map to the given object.
boolean	mapToMapFromEntity(SessionImplementor session, Map<String,Object> data, Object newObj, Object oldObj) Maps properties to the given map, basing on differences between properties of new and old objects.

Methods inherited from class org.hibernate.envers.internal.entities.mapper.AbstractPropertyMapper

isDynamicComponentMap, markAsDynamicComponentMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentPropertyMapper

public ComponentPropertyMapper(PropertyData propertyData,
                               Class componentClass)

Method Detail

add

public void add(PropertyData propertyData)

Specified by:

add in interface SimpleMapperBuilder

addComponent

public CompositeMapperBuilder addComponent(PropertyData propertyData,
                                           Class componentClass)

Specified by:

addComponent in interface CompositeMapperBuilder

addComposite

public void addComposite(PropertyData propertyData,
                         PropertyMapper propertyMapper)

Specified by:

addComposite in interface CompositeMapperBuilder

mapToMapFromEntity

public boolean mapToMapFromEntity(SessionImplementor session,
                                  Map<String,Object> data,
                                  Object newObj,
                                  Object oldObj)

Description copied from interface: PropertyMapper

Maps properties to the given map, basing on differences between properties of new and old objects.

Specified by:

mapToMapFromEntity in interface PropertyMapper

Parameters:

session - The current session.

data - Data to map to.

newObj - New state of the entity.

oldObj - Old state of the entity.

Returns:

True if there are any differences between the states represented by newObj and oldObj.

mapModifiedFlagsToMapFromEntity

public void mapModifiedFlagsToMapFromEntity(SessionImplementor session,
                                            Map<String,Object> data,
                                            Object newObj,
                                            Object oldObj)

Specified by:

mapModifiedFlagsToMapFromEntity in interface PropertyMapper

mapModifiedFlagsToMapForCollectionChange

public void mapModifiedFlagsToMapForCollectionChange(String collectionPropertyName,
                                                     Map<String,Object> data)

Specified by:

mapModifiedFlagsToMapForCollectionChange in interface PropertyMapper

mapToEntityFromMap

public void mapToEntityFromMap(EnversService enversService,
                               Object obj,
                               Map data,
                               Object primaryKey,
                               AuditReaderImplementor versionsReader,
                               Number revision)

Description copied from interface: PropertyMapper

Maps properties from the given map to the given object.

Specified by:

mapToEntityFromMap in interface PropertyMapper

Parameters:

enversService - The EnversService.

obj - Object to map to.

data - Data to map from.

primaryKey - Primary key of the object to which we map (for relations)

versionsReader - VersionsReader for reading relations

revision - Revision at which the object is read, for reading relations

mapCollectionChanges

public List<PersistentCollectionChangeData> mapCollectionChanges(SessionImplementor session,
                                                                 String referencingPropertyName,
                                                                 PersistentCollection newColl,
                                                                 Serializable oldColl,
                                                                 Serializable id)

Description copied from interface: PropertyMapper

Maps collection changes.

Specified by:

mapCollectionChanges in interface PropertyMapper

Parameters:

session - The current session.

referencingPropertyName - Name of the field, which holds the collection in the entity.

newColl - New collection, after updates.

oldColl - Old collection, before updates.

id - Id of the object owning the collection.

Returns:

List of changes that need to be performed on the persistent store.

getProperties

public Map<PropertyData,PropertyMapper> getProperties()

Specified by:

getProperties in interface CompositeMapperBuilder

hasPropertiesWithModifiedFlag

public boolean hasPropertiesWithModifiedFlag()

Description copied from interface: ModifiedFlagMapperSupport

Returns whether the associated PropertyMapper has any properties that use the witModifiedFlag feature.

Specified by:

hasPropertiesWithModifiedFlag in interface ModifiedFlagMapperSupport

Returns:

true if a property uses withModifiedFlag, otherwise false.