com.haulmont.cuba.core.app

Class EntitySnapshotManager

java.lang.Object

com.haulmont.cuba.core.app.EntitySnapshotManager

All Implemented Interfaces:

EntitySnapshotAPI

@Component(value="cuba_EntitySnapshotManager")
public class EntitySnapshotManager
extends java.lang.Object
implements EntitySnapshotAPI

Field Summary

Fields

Modifier and Type	Field and Description
protected DataManager	dataManager
protected EntityDiffManager	diffManager
protected EntitySerializationAPI	entitySerializationAPI
protected ExtendedEntities	extendedEntities
protected Metadata	metadata
protected Persistence	persistence
protected ReferenceToEntitySupport	referenceToEntitySupport
protected TimeSource	timeSource
protected UserSessionSource	userSessionSource
protected ViewSerializationAPI	viewSerializationAPI

Fields inherited from interface com.haulmont.cuba.core.app.EntitySnapshotAPI

NAME

Constructor Summary

Constructors

Constructor and Description
EntitySnapshotManager()

Method Summary

Modifier and Type	Method and Description
protected void	checkCompositePrimaryKey(Entity entity)
protected EntitySnapshot	createEntitySnapshot(Entity entity, View view, java.util.Date snapshotDate, User author)
EntitySnapshot	createSnapshot(Entity entity, View view) Create snapshot for Entity and store it to database
EntitySnapshot	createSnapshot(Entity entity, View view, java.util.Date snapshotDate) Create snapshot for Entity with specific date and store it to database
EntitySnapshot	createSnapshot(Entity entity, View view, java.util.Date snapshotDate, User author) Create snapshot for Entity with specific date and author and store it to database
EntitySnapshot	createTempSnapshot(Entity entity, View view) Creates non-persistent snapshot for entity.
EntitySnapshot	createTempSnapshot(Entity entity, View view, java.util.Date snapshotDate) Creates non-persistent snapshot for entity with a specific date.
EntitySnapshot	createTempSnapshot(Entity entity, View view, java.util.Date snapshotDate, User author) Creates non-persistent snapshot for entity with a specific date and author.
Entity	extractEntity(EntitySnapshot snapshot) Restore entity by snapshot
View	extractView(EntitySnapshot snapshot) Restore view from snapshot
protected java.lang.Object	fromXML(java.lang.String xml)
EntityDiff	getDifference(EntitySnapshot first, EntitySnapshot second) Diff two versions of entity
EntitySnapshot	getLastEntitySnapshot(Entity entity) Get the last snapshot for the given entity.
EntitySnapshot	getLastEntitySnapshot(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.Object referenceId) Get the last snapshot for the given entity by id.
java.util.List<EntitySnapshot>	getSnapshots(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.Object id) Load snapshots for entity
protected boolean	isXml(java.lang.String value)
void	migrateSnapshots(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.Object id, java.util.Map<java.lang.Class,java.lang.Class> classMapping) Translate snapshots for archival classes
protected java.lang.String	processSnapshotXml(java.lang.String snapshotXml, java.util.Map<java.lang.Class,java.lang.Class> classMapping)
protected java.lang.String	processViewXml(java.lang.String viewXml, java.util.Map<java.lang.Class,java.lang.Class> classMapping)
protected void	replaceClasses(org.dom4j.Element element, java.util.Map<java.lang.Class,java.lang.Class> classMapping)
protected void	replaceInXmlTree(org.dom4j.Element element, java.util.Map<java.lang.Class,java.lang.Class> classMapping)

Methods inherited from class java.lang.Object

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

Field Detail

persistence

@Inject
protected Persistence persistence

metadata

@Inject
protected Metadata metadata

diffManager

@Inject
protected EntityDiffManager diffManager

extendedEntities

@Inject
protected ExtendedEntities extendedEntities

userSessionSource

@Inject
protected UserSessionSource userSessionSource

timeSource

@Inject
protected TimeSource timeSource

entitySerializationAPI

@Inject
protected EntitySerializationAPI entitySerializationAPI

viewSerializationAPI

@Inject
protected ViewSerializationAPI viewSerializationAPI

referenceToEntitySupport

@Inject
protected ReferenceToEntitySupport referenceToEntitySupport

dataManager

@Inject
protected DataManager dataManager

Constructor Detail

EntitySnapshotManager

public EntitySnapshotManager()

Method Detail

getSnapshots

public java.util.List<EntitySnapshot> getSnapshots(com.haulmont.chile.core.model.MetaClass metaClass,
                                                   java.lang.Object id)

Description copied from interface: EntitySnapshotAPI

Load snapshots for entity

Specified by:

getSnapshots in interface EntitySnapshotAPI

Parameters:

metaClass - Entity metaclass

id - Entity Id

Returns:

Snapshot list sorted by snapshotDate desc

migrateSnapshots

public void migrateSnapshots(com.haulmont.chile.core.model.MetaClass metaClass,
                             java.lang.Object id,
                             java.util.Map<java.lang.Class,java.lang.Class> classMapping)

Description copied from interface: EntitySnapshotAPI

Translate snapshots for archival classes

Specified by:

migrateSnapshots in interface EntitySnapshotAPI

Parameters:

metaClass - Metaclass

id - Entity Id

classMapping - Map of [OldClass -> NewClass] for migration

createSnapshot

public EntitySnapshot createSnapshot(Entity entity,
                                     View view)

Description copied from interface: EntitySnapshotAPI

Create snapshot for Entity and store it to database

Specified by:

createSnapshot in interface EntitySnapshotAPI

Parameters:

entity - Entity

view - View

Returns:

Snapshot

createSnapshot

public EntitySnapshot createSnapshot(Entity entity,
                                     View view,
                                     java.util.Date snapshotDate)

Description copied from interface: EntitySnapshotAPI

Create snapshot for Entity with specific date and store it to database

Specified by:

createSnapshot in interface EntitySnapshotAPI

Parameters:

entity - Entity

view - View

snapshotDate - Date

Returns:

Snapshot

createSnapshot

public EntitySnapshot createSnapshot(Entity entity,
                                     View view,
                                     java.util.Date snapshotDate,
                                     User author)

Description copied from interface: EntitySnapshotAPI

Create snapshot for Entity with specific date and author and store it to database

Specified by:

createSnapshot in interface EntitySnapshotAPI

Parameters:

entity - Entity

view - View

snapshotDate - Date

author - Author

Returns:

Snapshot

extractEntity

public Entity extractEntity(EntitySnapshot snapshot)

Description copied from interface: EntitySnapshotAPI

Restore entity by snapshot

Specified by:

extractEntity in interface EntitySnapshotAPI

Parameters:

snapshot - Snapshot

Returns:

Entity instance

extractView

public View extractView(EntitySnapshot snapshot)

Description copied from interface: EntitySnapshotAPI

Restore view from snapshot

Specified by:

extractView in interface EntitySnapshotAPI

Parameters:

snapshot - Snapshot

Returns:

View instance

getDifference

public EntityDiff getDifference(@Nullable
                                EntitySnapshot first,
                                EntitySnapshot second)

Description copied from interface: EntitySnapshotAPI

Diff two versions of entity

Specified by:

getDifference in interface EntitySnapshotAPI

Parameters:

first - First version

second - Second version

Returns:

Diffs

fromXML

protected java.lang.Object fromXML(java.lang.String xml)

isXml

protected boolean isXml(java.lang.String value)

checkCompositePrimaryKey

protected void checkCompositePrimaryKey(Entity entity)

replaceInXmlTree

protected void replaceInXmlTree(org.dom4j.Element element,
                                java.util.Map<java.lang.Class,java.lang.Class> classMapping)

replaceClasses

protected void replaceClasses(org.dom4j.Element element,
                              java.util.Map<java.lang.Class,java.lang.Class> classMapping)

processViewXml

protected java.lang.String processViewXml(java.lang.String viewXml,
                                          java.util.Map<java.lang.Class,java.lang.Class> classMapping)

processSnapshotXml

protected java.lang.String processSnapshotXml(java.lang.String snapshotXml,
                                              java.util.Map<java.lang.Class,java.lang.Class> classMapping)

getLastEntitySnapshot

public EntitySnapshot getLastEntitySnapshot(Entity entity)

Description copied from interface: EntitySnapshotAPI

Get the last snapshot for the given entity. This method always starts a new transaction. It can be used for entities with composite key if they implement HasUuid interface.

Specified by:

getLastEntitySnapshot in interface EntitySnapshotAPI

Parameters:

entity - entity

Returns:

snapshot or null if there is no snapshots in database for the given entity

getLastEntitySnapshot

public EntitySnapshot getLastEntitySnapshot(com.haulmont.chile.core.model.MetaClass metaClass,
                                            java.lang.Object referenceId)

Description copied from interface: EntitySnapshotAPI

Get the last snapshot for the given entity by id. This method always starts a new transaction.

Specified by:

getLastEntitySnapshot in interface EntitySnapshotAPI

Parameters:

metaClass - entity meta class

referenceId - reference id for which snapshot refers

Returns:

snapshot or null if there is no snapshots in database for the given entity

createTempSnapshot

public EntitySnapshot createTempSnapshot(Entity entity,
                                         View view)

Description copied from interface: EntitySnapshotAPI

Creates non-persistent snapshot for entity. It can be used for entities with composite key if they implement HasUuid interface.

Specified by:

createTempSnapshot in interface EntitySnapshotAPI

Parameters:

entity - entity

view - view

Returns:

not persistence snapshot

createTempSnapshot

public EntitySnapshot createTempSnapshot(Entity entity,
                                         View view,
                                         java.util.Date snapshotDate)

Description copied from interface: EntitySnapshotAPI

Creates non-persistent snapshot for entity with a specific date. It can be used for entities with composite key if they implement HasUuid interface.

Specified by:

createTempSnapshot in interface EntitySnapshotAPI

Parameters:

entity - entity

view - entity view

snapshotDate - date

Returns:

not persistence snapshot

createTempSnapshot

public EntitySnapshot createTempSnapshot(Entity entity,
                                         View view,
                                         java.util.Date snapshotDate,
                                         User author)

Description copied from interface: EntitySnapshotAPI

Creates non-persistent snapshot for entity with a specific date and author. It can be used for entities with composite key if they implement HasUuid interface.

Specified by:

createTempSnapshot in interface EntitySnapshotAPI

Parameters:

entity - entity

view - entity view

snapshotDate - date

author - author

Returns:

not persistence snapshot

createEntitySnapshot

protected EntitySnapshot createEntitySnapshot(Entity entity,
                                              View view,
                                              java.util.Date snapshotDate,
                                              User author)