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 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
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
Entity	extractEntity(EntitySnapshot snapshot) Restore entity by snapshot
View	extractView(EntitySnapshot snapshot) Restore view from snapshot
EntityDiff	getDifference(EntitySnapshot first, EntitySnapshot second) Diff two versions of entity
java.util.List<EntitySnapshot>	getSnapshots(MetaClass metaClass, java.lang.Object id) Load snapshots for entity
void	migrateSnapshots(MetaClass metaClass, java.lang.Object id, java.util.Map<java.lang.Class,java.lang.Class> classMapping) Translate snapshots for archival classes

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitySnapshotManager

public EntitySnapshotManager()

Method Detail

getSnapshots

public java.util.List<EntitySnapshot> getSnapshots(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(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