Package org.projectbarbel.histo

Class BarbelHistoCore<T>

java.lang.Object

org.projectbarbel.histo.BarbelHistoCore<T>

Type Parameters:

T - the business object type to manage

All Implemented Interfaces:

BarbelHisto<T>

public final class BarbelHistoCore<T>
extends Object
implements BarbelHisto<T>

The core component of BarbelHisto. See BarbelHisto for details.

Author:

Niklas Schlimm

Field Summary

Fields

Modifier and Type	Field	Description
static ThreadLocal<BarbelHistoContext>	CONSTRUCTION_CONTEXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BarbelHistoCore(BarbelHistoContext context)

Method Summary

Modifier and Type	Method	Description
boolean	contains(Object documentId)	Check if BarbelHisto contains data for the given document ID.
BarbelHistoContext	getContext()
DocumentJournal	getDocumentJournal(Object id)
void	load(Collection<Bitemporal> bitemporals)	Method for clients that use a custom data store.
void	loadQuiet(Collection<Bitemporal> bitemporals)
String	prettyPrintJournal(Object id)	Pretty print the journal for the given document ID.
List<T>	retrieve(com.googlecode.cqengine.query.Query<T> query)	Retrieve data from BarbelHisto using cqengine like queries.
List<T>	retrieve(com.googlecode.cqengine.query.Query<T> query, com.googlecode.cqengine.query.option.QueryOptions options)	Retrieve data from BarbelHisto using cqengine like queries.
T	retrieveOne(com.googlecode.cqengine.query.Query<T> query)	Retrieve data from BarbelHisto using cqengine like queries.
T	retrieveOne(com.googlecode.cqengine.query.Query<T> query, com.googlecode.cqengine.query.option.QueryOptions options)	Retrieve data from BarbelHisto using cqengine like queries.
BitemporalUpdate<T>	save(T newVersion, ZonedDateTime from, ZonedDateTime until)	Save objects to BarbelHisto.
int	size()
DocumentJournal	timeshift(Object id, ZonedDateTime time)	Turn back time to see how document journals looked like in the past.
Collection<Bitemporal>	unload(Object... documentIDs)	Unloads the journal data of the given document IDs into a collection and return that to the client.
Collection<Bitemporal>	unloadAll()	Unloads the complete backbone.
Collection<Bitemporal>	unloadQuiet(Object... documentIDs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.projectbarbel.histo.BarbelHisto

save, save, save

Field Detail

CONSTRUCTION_CONTEXT

public static final ThreadLocal<BarbelHistoContext> CONSTRUCTION_CONTEXT

Constructor Detail

BarbelHistoCore

protected BarbelHistoCore(BarbelHistoContext context)

Method Detail

save

public BitemporalUpdate<T> save(T newVersion,
                                ZonedDateTime from,
                                ZonedDateTime until)

Description copied from interface: BarbelHisto

Save objects to BarbelHisto. Creates snapshots of state. Clients can safely continue to work on passed instances. Thread safe, applies lock to journals of document IDs (not the complete backbone). This allows concurrent work on different document IDs. If clients try to update the same document Id, this method throws ConcurrentModificationException. The method returns a copy of the object saved including the version data. In in BarbelMode.POJO cast the returned object to Bitemporal to read the version data.

Specified by:

save in interface BarbelHisto<T>

Parameters:

newVersion - the object state to save

from - effective time of object state

until - effective until of the state

Returns:

the BitemporalUpdate performed by this save operation

retrieve

public List<T> retrieve(com.googlecode.cqengine.query.Query<T> query)

Description copied from interface: BarbelHisto

Retrieve data from BarbelHisto using cqengine like queries. Clients want to use BarbelQueries for there convenience here. BarbelQueries can be combined with additional queries from QueryFactory.

Specified by:

retrieve in interface BarbelHisto<T>

Parameters:

query - the client query from BarbelQueries and/or QueryFactory

Returns:

the copies returned, maybe empty, never null

retrieve

public List<T> retrieve(com.googlecode.cqengine.query.Query<T> query,
                        com.googlecode.cqengine.query.option.QueryOptions options)

Description copied from interface: BarbelHisto

Retrieve data from BarbelHisto using cqengine like queries. Clients want to use BarbelQueries and BarbelQueryOptions for there convenience here. BarbelQueries can be combined with additional queries from QueryFactory.

Specified by:

retrieve in interface BarbelHisto<T>

Parameters:

query - the client query from BarbelQueries and/or QueryFactory

options - the options from BarbelQueryOptions or QueryFactory

Returns:

the copies returned, maybe empty, never null

prettyPrintJournal

public String prettyPrintJournal(Object id)

Description copied from interface: BarbelHisto

Pretty print the journal for the given document ID.

Specified by:

prettyPrintJournal in interface BarbelHisto<T>

Parameters:

id - the document ID

Returns:

the journal as pretty print out

getContext

public BarbelHistoContext getContext()

getDocumentJournal

public DocumentJournal getDocumentJournal(Object id)

load

public void load(Collection<Bitemporal> bitemporals)

Description copied from interface: BarbelHisto

Method for clients that use a custom data store. Only add complete set of versions for one or more document IDs. Usually used in conjunction with BarbelHisto.unload(Object...).

In BarbelMode.POJO (default) clients have to pass a collection of BitemporalVersion. In BarbelMode.BITEMPORAL mode clients can add objects that implement Bitemporal.

Specified by:

load in interface BarbelHisto<T>

Parameters:

bitemporals - consistent list of Bitemporal versions

See Also:

https://github.com/npgall/cqengine

loadQuiet

public void loadQuiet(Collection<Bitemporal> bitemporals)

unload

public Collection<Bitemporal> unload(Object... documentIDs)

Description copied from interface: BarbelHisto

Unloads the journal data of the given document IDs into a collection and return that to the client. The journal data of the given document IDs will be deleted from the backbone. This method is used when client uses custom data store. Clients may store the returned collection to the data store of their choice. Used in conjunction with BarbelHisto.load(Collection) to re-load that stored journals back into BarbelHisto to continue bitemporal processing.

In BarbelMode.POJO (default) clients receive a collection of BitemporalVersion objects. In BarbelMode.BITEMPORAL clients receive objects that implement Bitemporal.

Specified by:

unload in interface BarbelHisto<T>

Parameters:

documentIDs - the document IDs to unload

Returns:

the collection of Bitemporal objects to store into an arbitrary data store

See Also:

https://github.com/npgall/cqengine

unloadQuiet

public Collection<Bitemporal> unloadQuiet(Object... documentIDs)

unloadAll

public Collection<Bitemporal> unloadAll()

Unloads the complete backbone.

Returns:

the complete backbone versions.

timeshift

public DocumentJournal timeshift(Object id,
                                 ZonedDateTime time)

Description copied from interface: BarbelHisto

Turn back time to see how document journals looked like in the past. If clients pass LocalDateTime.now() the actual journal is returned. Time shift does not change the backbone collection of the BarbelHisto instance, instead it returns an instance of DocumentJournal with copies of managed Bitemporal objects.

Specified by:

timeshift in interface BarbelHisto<T>

Parameters:

id - the document Id

time - the time, must be in the past

Returns:

the document journal at that given time

size

public int size()

retrieveOne

public T retrieveOne(com.googlecode.cqengine.query.Query<T> query)

Description copied from interface: BarbelHisto

Retrieve data from BarbelHisto using cqengine like queries. Clients want to use BarbelQueries for there convenience here. BarbelQueries can be combined with additional queries from QueryFactory. Throws IllegalStateException when query returns more then one result, NoSuchElementException if nothing was found.

Specified by:

retrieveOne in interface BarbelHisto<T>

Parameters:

query - the client query from BarbelQueries and/or QueryFactory

Returns:

the returned copy

retrieveOne

public T retrieveOne(com.googlecode.cqengine.query.Query<T> query,
                     com.googlecode.cqengine.query.option.QueryOptions options)

Description copied from interface: BarbelHisto

Retrieve data from BarbelHisto using cqengine like queries. Clients want to use BarbelQueries and BarbelQueryOptions for there convenience here. BarbelQueries can be combined with additional queries from QueryFactory. Throws IllegalStateException when query returns more then one result, NoSuchElementException if nothing was found.

Specified by:

retrieveOne in interface BarbelHisto<T>

Parameters:

query - the client query from BarbelQueries and/or QueryFactory

options - the options from BarbelQueryOptions or QueryFactory

Returns:

the returned copy

contains

public boolean contains(Object documentId)

Description copied from interface: BarbelHisto

Check if BarbelHisto contains data for the given document ID.

Specified by:

contains in interface BarbelHisto<T>

Parameters:

documentId - the document id to check

Returns:

true if BarbelHisto contains data otherwise false