Package org.projectbarbel.histo

Class BarbelHistoBuilder

java.lang.Object

org.projectbarbel.histo.BarbelHistoBuilder

All Implemented Interfaces:

BarbelHistoContext

public final class BarbelHistoBuilder
extends Object
implements BarbelHistoContext

Builder class for BarbelHisto. Use BarbelHistoBuilder.barbel().build() to receive the default implementation. Allows to set a variety of context objects to adopt the behaviour of BarbelHisto if required. Defaults are defined in BarbelHistoContext.

Author:

Niklas Schlimm

Field Summary

Fields

Modifier and Type	Field	Description
static Systemclock	CLOCK
static DateTimeFormatter	DATE_FORMATTER
static String	SYSTEM
static String	SYSTEMACTIVITY
static com.google.gson.JsonDeserializer<ZonedDateTime>	ZDT_DESERIALIZER
static com.google.gson.JsonSerializer<ZonedDateTime>	ZDT_SERIALIZER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BarbelHistoBuilder()

Method Summary

Modifier and Type	Method	Description
static BarbelHistoBuilder	barbel()
<T> BarbelHisto<T>	build()
String	getActivity()
com.google.common.eventbus.AsyncEventBus	getAsynchronousEventBus()
<T> com.googlecode.cqengine.IndexedCollection<T>	getBackbone()
<T> Supplier<com.googlecode.cqengine.IndexedCollection<T>>	getBackboneSupplier()
Map<String,Object>	getContextOptions()
com.google.gson.Gson	getGson()
Map<Object,DocumentJournal>	getJournalStore()
Function<BarbelHistoContext,BiConsumer<DocumentJournal,Bitemporal>>	getJournalUpdateStrategyProducer()
BarbelMode	getMode()
Function<BarbelHistoContext,com.googlecode.cqengine.persistence.support.serialization.PojoSerializer<Bitemporal>>	getPersistenceSerializerProducer()
Supplier<UnaryOperator<Object>>	getPojoCopyFunctionSupplier()
Supplier<BiFunction<Object,BitemporalStamp,Object>>	getPojoProxyingFunctionSupplier()
Function<List<Bitemporal>,String>	getPrettyPrinter()
com.google.common.eventbus.EventBus	getSynchronousEventBus()
String	getUser()
Supplier<String>	getVersionIdGenerator()
void	postAsynchronousEvent(HistoEvent event)	Post an async event into the asynchronousEventBus.
void	postSynchronousEvent(HistoEvent event)	Post an event into the synchronousEventBus.
protected void	setBackbone(com.googlecode.cqengine.IndexedCollection<?> backbone)
BarbelHistoBuilder	withActivity(String activity)	The activity stored when creating records.
BarbelHistoBuilder	withAsynchronousEventBus(com.google.common.eventbus.AsyncEventBus asynchronousEventBus)	Register custom Google Guava AsyncEventBus with BarbelHisto.
BarbelHistoBuilder	withAsynchronousEventListener(Object listener)	Add a synchronous event listener to the AsyncEventBus.
<T> BarbelHistoBuilder	withBackboneSupplier(Supplier<com.googlecode.cqengine.IndexedCollection<T>> backbone)	The backbone collection of BarbelHisto.
BarbelHistoBuilder	withContextOptions(Map<String,Object> contextOptions)	Allows to pass custom options to custom implementations of functions.
BarbelHistoBuilder	withGson(com.google.gson.Gson gson)	Define a custom Gson for use with BarbelHisto.
BarbelHistoBuilder	withJournalStore(Map<Object,DocumentJournal> journalStore)	Define the collection that stores DocumentJournal instances.
BarbelHistoBuilder	withJournalUpdateStrategyProducer(Function<BarbelHistoContext,BiConsumer<DocumentJournal,Bitemporal>> journalUpdateStrategy)	Set the strategy how to update a journal.
BarbelHistoBuilder	withMode(BarbelMode mode)	Set the BarbelMode of this BarbelHisto instance.
BarbelHistoBuilder	withPersistenceSerializerProducer(Function<BarbelHistoContext,com.googlecode.cqengine.persistence.support.serialization.PojoSerializer<Bitemporal>> persistenceSerializerProducer)	Clients may want to decide how data is serialized into persistent storage.
BarbelHistoBuilder	withPojoCopyFunctionSupplier(Supplier<UnaryOperator<Object>> pojoCopyFunction)	Set a custom POJO copy function.
BarbelHistoBuilder	withPojoProxyingFunctionSupplier(Supplier<BiFunction<Object,BitemporalStamp,Object>> proxyingFunction)	Customize the proxying in BarbelMode.POJO.
BarbelHistoBuilder	withPrettyPrinter(Function<List<Bitemporal>,String> prettyPrinter)	Register custom pretty printer for DocumentJournals.
BarbelHistoBuilder	withSynchronousEventBus(com.google.common.eventbus.EventBus synchronousEventBus)	Register custom Google Guava synchronous EventBus with BarbelHisto.
BarbelHistoBuilder	withSynchronousEventListener(Object listener)	Add a synchronous event listener to the EventBus.
BarbelHistoBuilder	withUser(String user)	The user stored when creating records.
BarbelHistoBuilder	withVersionIdGenerator(Supplier<String> versionIdGenerator)	Clients may want to implememt their own version id generator.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM

public static final String SYSTEM

See Also:

Constant Field Values

SYSTEMACTIVITY

public static final String SYSTEMACTIVITY

See Also:

Constant Field Values

CLOCK

public static final Systemclock CLOCK

DATE_FORMATTER

public static final DateTimeFormatter DATE_FORMATTER

ZDT_DESERIALIZER

public static final com.google.gson.JsonDeserializer<ZonedDateTime> ZDT_DESERIALIZER

ZDT_SERIALIZER

public static final com.google.gson.JsonSerializer<ZonedDateTime> ZDT_SERIALIZER

Constructor Detail

BarbelHistoBuilder

protected BarbelHistoBuilder()

Method Detail

barbel

public static BarbelHistoBuilder barbel()

build

public <T> BarbelHisto<T> build()

getBackbone

public <T> com.googlecode.cqengine.IndexedCollection<T> getBackbone()

Specified by:

getBackbone in interface BarbelHistoContext

setBackbone

protected void setBackbone(com.googlecode.cqengine.IndexedCollection<?> backbone)

postSynchronousEvent

public void postSynchronousEvent(HistoEvent event)

Post an event into the synchronousEventBus.

Specified by:

postSynchronousEvent in interface BarbelHistoContext

Parameters:

event - the event posted

postAsynchronousEvent

public void postAsynchronousEvent(HistoEvent event)

Post an async event into the asynchronousEventBus.

Specified by:

postAsynchronousEvent in interface BarbelHistoContext

Parameters:

event - the event posted

getAsynchronousEventBus

public com.google.common.eventbus.AsyncEventBus getAsynchronousEventBus()

Specified by:

getAsynchronousEventBus in interface BarbelHistoContext

withAsynchronousEventBus

public BarbelHistoBuilder withAsynchronousEventBus(com.google.common.eventbus.AsyncEventBus asynchronousEventBus)

Register custom Google Guava AsyncEventBus with BarbelHisto. See EventType for various events that clients can subscribe to.

Parameters:

asynchronousEventBus - the AsyncEventBus

Returns:

the builder again

getSynchronousEventBus

public com.google.common.eventbus.EventBus getSynchronousEventBus()

Specified by:

getSynchronousEventBus in interface BarbelHistoContext

withSynchronousEventBus

public BarbelHistoBuilder withSynchronousEventBus(com.google.common.eventbus.EventBus synchronousEventBus)

Register custom Google Guava synchronous EventBus with BarbelHisto. See EventType for various events that clients can subscribe to.

Parameters:

synchronousEventBus - the AsyncEventBus

Returns:

the builder again

withSynchronousEventListener

public BarbelHistoBuilder withSynchronousEventListener(Object listener)

Add a synchronous event listener to the EventBus. Listeners are implemented like so:

 public class MyListener {
    @Subscribe
    public void handleEvent(AquireLockEvent event) {
       // handle the event
    }
 }
 

Then add an instance of this class to the withSynchronousEventListener(Object) method. BarbelHisto will publish events to the handler. For events available in BarbelHisto see EventType.

Notice that synchronous event listeners should be fairly quick, cause they are all executed in a row by the executing main thread. Use asynchronous event listeners if you have to perform time consuming event based procedures.

Parameters:

listener - the listener to register

Returns:

the builder again

withAsynchronousEventListener

public BarbelHistoBuilder withAsynchronousEventListener(Object listener)

Add a synchronous event listener to the AsyncEventBus. Listeners are implemented like so:

 public class MyListener {
    @Subscribe
    public void handleEvent(AquireLockEvent event) {
       // handle the event
    }
 }
 

Then add an instance of this class to the withAsynchronousEventBus(AsyncEventBus) method. BarbelHisto will the publich the event to the handler. For events available in BarbelHisto see EventType.

Parameters:

listener - the listener to register

Returns:

the builder again

getContextOptions

public Map<String,Object> getContextOptions()

Specified by:

getContextOptions in interface BarbelHistoContext

withContextOptions

public BarbelHistoBuilder withContextOptions(Map<String,Object> contextOptions)

Allows to pass custom options to custom implementations of functions.

Parameters:

contextOptions - the options map

Returns:

the builder

getPrettyPrinter

public Function<List<Bitemporal>,String> getPrettyPrinter()

Specified by:

getPrettyPrinter in interface BarbelHistoContext

withPrettyPrinter

public BarbelHistoBuilder withPrettyPrinter(Function<List<Bitemporal>,String> prettyPrinter)

Register custom pretty printer for DocumentJournals.

Parameters:

prettyPrinter - the custom printer

Returns:

the builder again

getMode

public BarbelMode getMode()

Specified by:

getMode in interface BarbelHistoContext

withMode

public BarbelHistoBuilder withMode(BarbelMode mode)

Set the BarbelMode of this BarbelHisto instance. Default is BarbelMode.POJO. See BarbelHisto for more details on modes.

Parameters:

mode - the mode

Returns:

the builder again

getJournalUpdateStrategyProducer

public Function<BarbelHistoContext,BiConsumer<DocumentJournal,Bitemporal>> getJournalUpdateStrategyProducer()

Specified by:

getJournalUpdateStrategyProducer in interface BarbelHistoContext

withJournalUpdateStrategyProducer

public BarbelHistoBuilder withJournalUpdateStrategyProducer(Function<BarbelHistoContext,BiConsumer<DocumentJournal,Bitemporal>> journalUpdateStrategy)

Set the strategy how to update a journal. Core functionality usually not customized by clients. Default is EmbeddingJournalUpdateStrategy.

Parameters:

journalUpdateStrategy - the custom strategy

Returns:

the builder again

getPojoCopyFunctionSupplier

public Supplier<UnaryOperator<Object>> getPojoCopyFunctionSupplier()

Specified by:

getPojoCopyFunctionSupplier in interface BarbelHistoContext

withPojoCopyFunctionSupplier

public BarbelHistoBuilder withPojoCopyFunctionSupplier(Supplier<UnaryOperator<Object>> pojoCopyFunction)

Set a custom POJO copy function. Required if clients use specific POJOs that cannot be copied by the default RitsClonerCopyFunction.

Parameters:

pojoCopyFunction - the custom copy function

Returns:

the builder again

getGson

public com.google.gson.Gson getGson()

Specified by:

getGson in interface BarbelHistoContext

withGson

public BarbelHistoBuilder withGson(com.google.gson.Gson gson)

Define a custom Gson for use with BarbelHisto. Clients may have specific requirements here.

Parameters:

gson - the custom Gson

Returns:

the builder again

getPojoProxyingFunctionSupplier

public Supplier<BiFunction<Object,BitemporalStamp,Object>> getPojoProxyingFunctionSupplier()

Specified by:

getPojoProxyingFunctionSupplier in interface BarbelHistoContext

withPojoProxyingFunctionSupplier

public BarbelHistoBuilder withPojoProxyingFunctionSupplier(Supplier<BiFunction<Object,BitemporalStamp,Object>> proxyingFunction)

Customize the proxying in BarbelMode.POJO. Default is CachingByteBuddyProxyingFunction. Clients may want to use more specific proxying functions with their POJOs.

Parameters:

proxyingFunction - the custom proxying function

Returns:

the builder again

getJournalStore

public Map<Object,DocumentJournal> getJournalStore()

Specified by:

getJournalStore in interface BarbelHistoContext

withJournalStore

public BarbelHistoBuilder withJournalStore(Map<Object,DocumentJournal> journalStore)

Define the collection that stores DocumentJournal instances. Note that DocumentJournal always works on the backbone collection set in withBackboneSupplier(Supplier) and will never "own" data.

Parameters:

journalStore - the journal store collection

Returns:

the builder again

getBackboneSupplier

public <T> Supplier<com.googlecode.cqengine.IndexedCollection<T>> getBackboneSupplier()

Specified by:

getBackboneSupplier in interface BarbelHistoContext

withBackboneSupplier

public <T> BarbelHistoBuilder withBackboneSupplier(Supplier<com.googlecode.cqengine.IndexedCollection<T>> backbone)

The backbone collection of BarbelHisto. This collection actually contains the complete version data. Objects stored here are never exposed directly to clients, only copies are exposed. Adopt that collection to any IndexedCollection of cqengine. See Persistence, i.e. DiskPersistence and OffHeapPersistence for flavors of different persistence options here. Default ist ConcurrentIndexedCollection using OnHeapPersistence.

If clients decide to use DiskPersistence or OffHeapPersistence in BarbelMode.POJO they need to add the PersistenceConfig annotation additionally to their POJO classes.

 @PersistenceConfig(serializer=BarbelPojoSerializer.class, polymorphic=true)
 

This is always required if you not use the OnHeapPersistence and regardless of the de-facto serializer you choose in withPersistenceSerializerProducer(Function). The BarbelPojoSerializer will forward processing to the AdaptingKryoSerializer by default. If you define a different target serializer, BarbelPojoSerializer will be forward requests to that custom serializer.

The backbone collection should not be shared across multiple instances of BarbelHisto. If you use persistent collections, store the BarbelHisto instance as singleton bean to your application. Multiple threads are allowed to access that BarbelHisto instance.

Type Parameters:

T - the type to manage

Parameters:

backbone - the collection for the backbone

Returns:

the builder again

See Also:

https://github.com/npgall/cqengine

getVersionIdGenerator

public Supplier<String> getVersionIdGenerator()

Specified by:

getVersionIdGenerator in interface BarbelHistoContext

withVersionIdGenerator

public BarbelHistoBuilder withVersionIdGenerator(Supplier<String> versionIdGenerator)

Clients may want to implememt their own version id generator. Make sure it will be unique. Default is UUIDGenerator.

Parameters:

versionIdGenerator - the custom version id generator

Returns:

the builder

getActivity

public String getActivity()

Specified by:

getActivity in interface BarbelHistoContext

withActivity

public BarbelHistoBuilder withActivity(String activity)

The activity stored when creating records. Adopt this to process names or the like.

Parameters:

activity - the activity to store in record entries

Returns:

the builder again

withUser

public BarbelHistoBuilder withUser(String user)

The user stored when creating records. Adopt this to user names or the like.

Parameters:

user - the user to store in record entries

Returns:

the builder again

getUser

public String getUser()

Specified by:

getUser in interface BarbelHistoContext

getPersistenceSerializerProducer

public Function<BarbelHistoContext,com.googlecode.cqengine.persistence.support.serialization.PojoSerializer<Bitemporal>> getPersistenceSerializerProducer()

Specified by:

getPersistenceSerializerProducer in interface BarbelHistoContext

withPersistenceSerializerProducer

public BarbelHistoBuilder withPersistenceSerializerProducer(Function<BarbelHistoContext,com.googlecode.cqengine.persistence.support.serialization.PojoSerializer<Bitemporal>> persistenceSerializerProducer)

Clients may want to decide how data is serialized into persistent storage. Default is AdaptingKryoSerializer. To validate if your POJO is serializable call AdaptingKryoSerializer.validateObjectIsRoundTripSerializable(BarbelHistoContext, Object).

Parameters:

persistenceSerializerProducer - the producer of the serializer

Returns:

the builder again