org.javers.repository.api

Interface JaversRepository

All Known Implementing Classes:

JaversExtendedRepository

public interface JaversRepository

JaversRepository is responsible for persisting Commits calculated by Javers core.

It should persist CommitMetadata and Snapshots, Changes should not be persisted as they are recalculated by Javers core as diff between relevant snapshots.

Hints for JaversRepository implementation

• After persisting in database, Commit is considered immutable so it can not be updated.
• Persisting Commit in any kind of database is easy. JaVers provides flexible JSON serialization/deserialization engine, designed as abstraction layer between Java types and specific database types.
• Essentially, object-oriented data are persisted as JSON.
• Repository impl should leverage JsonConverter.

Method Summary

Modifier and Type	Method and Description
void	ensureSchema() Called at the end of JaVers bootstrap, good place to put database schema update
CommitId	getHeadId()
Optional<CdoSnapshot>	getLatest(GlobalId globalId) Latest snapshot of given object, Optional#EMPTY if object is not versioned
java.util.List<CdoSnapshot>	getPropertyStateHistory(GlobalId globalId, java.lang.String propertyName, int limit) Filtered version of getStateHistory(GlobalId, int), selects snapshots with a change recorded on a given property
java.util.List<CdoSnapshot>	getPropertyStateHistory(ManagedClass givenClass, java.lang.String propertyName, int limit) Filtered version of getStateHistory(ManagedClass, int), selects all snapshots with a change recorded on a given property
java.util.List<CdoSnapshot>	getStateHistory(GlobalId globalId, int limit) Snapshots (historical states) of given object in reverse chronological order
java.util.List<CdoSnapshot>	getStateHistory(ManagedClass givenClass, int limit) All snapshots of objects within a given class, in reverse chronological order
java.util.List<CdoSnapshot>	getValueObjectStateHistory(Entity ownerEntity, java.lang.String path, int limit) Snapshots of all ValueObjects owned by given ownerEntity at given path
void	persist(Commit commit)
void	setJsonConverter(JsonConverter jsonConverter)

Method Detail

getStateHistory

java.util.List<CdoSnapshot> getStateHistory(GlobalId globalId,
                                            int limit)

Snapshots (historical states) of given object in reverse chronological order

Parameters:

limit - choose reasonable limits

Returns:

empty List if object is not versioned

getValueObjectStateHistory

java.util.List<CdoSnapshot> getValueObjectStateHistory(Entity ownerEntity,
                                                       java.lang.String path,
                                                       int limit)

Snapshots of all ValueObjects owned by given ownerEntity at given path

getPropertyStateHistory

java.util.List<CdoSnapshot> getPropertyStateHistory(GlobalId globalId,
                                                    java.lang.String propertyName,
                                                    int limit)

Filtered version of getStateHistory(GlobalId, int), selects snapshots with a change recorded on a given property

getStateHistory

java.util.List<CdoSnapshot> getStateHistory(ManagedClass givenClass,
                                            int limit)

All snapshots of objects within a given class, in reverse chronological order

Parameters:

limit - choose reasonable limits

Returns:

empty List if no snapshots found

getPropertyStateHistory

java.util.List<CdoSnapshot> getPropertyStateHistory(ManagedClass givenClass,
                                                    java.lang.String propertyName,
                                                    int limit)

Filtered version of getStateHistory(ManagedClass, int), selects all snapshots with a change recorded on a given property

getLatest

Optional<CdoSnapshot> getLatest(GlobalId globalId)

Latest snapshot of given object, Optional#EMPTY if object is not versioned

persist

void persist(Commit commit)

getHeadId

CommitId getHeadId()

setJsonConverter

void setJsonConverter(JsonConverter jsonConverter)

ensureSchema

void ensureSchema()

Called at the end of JaVers bootstrap, good place to put database schema update