rapture.mongodb

Class EpochManager

java.lang.Object

rapture.mongodb.EpochManager

public class EpochManager
extends java.lang.Object

Useful tools for handling all things epoch related in Mongo

Constructor Summary

Constructors

Constructor and Description
EpochManager()

Method Summary

Modifier and Type	Method and Description
static java.lang.Long	getLatestEpoch(com.mongodb.client.MongoCollection<org.bson.Document> collection) Read-only operation that will return the latest epoch that is in use for the given collection.
static org.bson.Document	getNotEqualEpochQueryObject() Return the starting point for a query object in a collection that contains epochs.
static java.lang.Long	nextEpoch(com.mongodb.client.MongoCollection<org.bson.Document> collection) Returns the next epoch available and advances the counter.

Methods inherited from class java.lang.Object

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

Constructor Detail

EpochManager

public EpochManager()

Method Detail

nextEpoch

public static java.lang.Long nextEpoch(com.mongodb.client.MongoCollection<org.bson.Document> collection)

Returns the next epoch available and advances the counter. Guaranteed to be unique for the given collection. If the epoch document does not already exist a new one is created and the first epoch returned will be 1L.

Parameters:

collection - - the MongoCollection to the get next epoch for

Returns:

Long - a unique epoch value for this collection

getLatestEpoch

public static java.lang.Long getLatestEpoch(com.mongodb.client.MongoCollection<org.bson.Document> collection)

Read-only operation that will return the latest epoch that is in use for the given collection.

Parameters:

collection - - the MongoCollection to interrogate

Returns:

Long - the latest epoch currently in use

getNotEqualEpochQueryObject

public static org.bson.Document getNotEqualEpochQueryObject()

Return the starting point for a query object in a collection that contains epochs. We never want to return the epoch document in a query.

Returns:

Document - starting query object for a collection with epochs