org.javers.repository.api

Interface JaversRepository

All Known Implementing Classes:

InMemoryRepository, 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
CommitId	getHeadId()
Optional<CdoSnapshot>	getLatest(GlobalId globalId) Latest snapshot of given object, Optional#EMPTY if object is not versioned
Optional<CdoSnapshot>	getLatest(GlobalIdDTO globalIdDTO) Convenient method to query by DTO, see getLatest(org.javers.core.metamodel.object.GlobalId)
java.util.List<CdoSnapshot>	getStateHistory(GlobalIdDTO globalIdDTO, int limit) Convenient method to query by DTO, see getStateHistory(org.javers.core.metamodel.object.GlobalId, int)
java.util.List<CdoSnapshot>	getStateHistory(GlobalId globalId, int limit) Snapshots (historical states) of given object in reverse chronological order
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, production database could contain more records than you expect

Returns:

empty List if object is not versioned

getStateHistory

java.util.List<CdoSnapshot> getStateHistory(GlobalIdDTO globalIdDTO,
                                            int limit)

Convenient method to query by DTO, see getStateHistory(org.javers.core.metamodel.object.GlobalId, int)

getLatest

Optional<CdoSnapshot> getLatest(GlobalId globalId)

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

getLatest

Optional<CdoSnapshot> getLatest(GlobalIdDTO globalIdDTO)

Convenient method to query by DTO, see getLatest(org.javers.core.metamodel.object.GlobalId)

persist

void persist(Commit commit)

getHeadId

CommitId getHeadId()

setJsonConverter

void setJsonConverter(JsonConverter jsonConverter)