com.haulmont.cuba.core.app

Interface EntitySnapshotAPI

All Known Implementing Classes:

EntitySnapshotManager

public interface EntitySnapshotAPI

Creates and analyzes entity snapshots.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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
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
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
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

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getSnapshots

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

Load snapshots for entity

Parameters:

metaClass - Entity metaclass

id - Entity Id

Returns:

Snapshot list sorted by snapshotDate desc

migrateSnapshots

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

Parameters:

metaClass - Metaclass

id - Entity Id

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

createSnapshot

EntitySnapshot createSnapshot(Entity entity,
                              View view)

Create snapshot for Entity and store it to database

Parameters:

entity - Entity

view - View

Returns:

Snapshot

createSnapshot

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

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

Parameters:

entity - Entity

view - View

snapshotDate - Date

Returns:

Snapshot

createSnapshot

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

Parameters:

entity - Entity

view - View

snapshotDate - Date

author - Author

Returns:

Snapshot

extractEntity

Entity extractEntity(EntitySnapshot snapshot)

Restore entity by snapshot

Parameters:

snapshot - Snapshot

Returns:

Entity instance

extractView

View extractView(EntitySnapshot snapshot)

Restore view from snapshot

Parameters:

snapshot - Snapshot

Returns:

View instance

getDifference

EntityDiff getDifference(@Nullable
                         EntitySnapshot first,
                         EntitySnapshot second)

Diff two versions of entity

Parameters:

first - First version

second - Second version

Returns:

Diffs

getLastEntitySnapshot

@Nullable
EntitySnapshot getLastEntitySnapshot(Entity entity)

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.

Parameters:

entity - entity

Returns:

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

getLastEntitySnapshot

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

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

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

EntitySnapshot createTempSnapshot(Entity entity,
                                  View view)

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

Parameters:

entity - entity

view - view

Returns:

not persistence snapshot

createTempSnapshot

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

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

Parameters:

entity - entity

view - entity view

snapshotDate - date

Returns:

not persistence snapshot

createTempSnapshot

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

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.

Parameters:

entity - entity

view - entity view

snapshotDate - date

author - author

Returns:

not persistence snapshot