org.chronos.chronosphere.api

Interface ChronoSphere

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

ChronoSphereInternal

All Known Implementing Classes:

StandardChronoSphere

public interface ChronoSphere
extends java.lang.AutoCloseable

This is the main repository interface, it represents the whole model repository.

To get an instance of this class, please use the fluent builder API:

 ChronoSphere repository = ChronoSphere.FACTORY.create() /... settings ... / .buildLRU();
 

After creating this class, you should set up your EPackages through the methods provided by getEPackageManager(). Then, you can use the various overloads of tx() to create transactions for working with the contents of the repository.

Field Summary

Fields

Modifier and Type	Field and Description
static ChronoSphereFactory	FACTORY This is the singleton factory instance for ChronoSpheres.

Method Summary

Modifier and Type	Method and Description
default void	batchInsertModelData(org.eclipse.emf.ecore.EObject model) Batch-inserts the given EObject model data into the master branch of this repository.
default void	batchInsertModelData(java.io.File xmiFile) Batch-inserts the EObject model data from the given XMI file into the master branch of this repository.
default void	batchInsertModelData(java.lang.Iterable<org.eclipse.emf.ecore.EObject> model) Batch-inserts the given EObject model data into the master branch of this repository.
default void	batchInsertModelData(java.util.Iterator<org.eclipse.emf.ecore.EObject> model) Batch-inserts the given EObject model data into the master branch of this repository.
default void	batchInsertModelData(java.lang.String xmiContent) Batch-inserts the EObject model data from the given XMI content into the master branch of this repository.
default void	batchInsertModelData(java.lang.String branch, org.eclipse.emf.ecore.EObject model) Batch-inserts the given EObject model data into the given branch of this repository.
default void	batchInsertModelData(java.lang.String branch, java.io.File xmiFile) Batch-inserts the EObject model data from the given XMI file into the given branch of this repository.
default void	batchInsertModelData(java.lang.String branch, java.lang.Iterable<org.eclipse.emf.ecore.EObject> model) Batch-inserts the given EObject model data into the given branch of this repository.
void	batchInsertModelData(java.lang.String branch, java.util.Iterator<org.eclipse.emf.ecore.EObject> model) Batch-inserts the given EObject model data into the given branch of this repository.
default void	batchInsertModelData(java.lang.String branch, java.lang.String xmiContent) Batch-inserts the EObject model data from the given XMI content into the given branch of this repository.
void	close() Closes this ChronoSphere instance.
default int	countCommitTimestamps() Counts the total number of commit timestamps on the master branch.
int	countCommitTimestamps(java.lang.String branch) Counts the total number of commit timestamps in the graph.
default int	countCommitTimestampsBetween(long from, long to) Counts the number of commit timestamps on the master branch between from (inclusive) and to (inclusive).
int	countCommitTimestampsBetween(java.lang.String branch, long from, long to) Counts the number of commit timestamps between from (inclusive) and to (inclusive).
ChronoSphereBranchManager	getBranchManager() Returns the branch manager associated with this ChronoSphere instance.
default java.lang.Object	getCommitMetadata(long timestamp) Returns the metadata for the commit on the master branch at the given timestamp.
java.lang.Object	getCommitMetadata(java.lang.String branch, long timestamp) Returns the metadata for the commit on the given branch at the given timestamp.
default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>>	getCommitMetadataBetween(long from, long to) Returns an iterator over the entries of commit timestamp and associated metadata on the master branch, bounded between from and to, in descending order.
default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>>	getCommitMetadataBetween(long from, long to, org.chronos.chronodb.api.Order order) Returns an iterator over the entries of commit timestamp and associated metadata on the master branch, bounded between from and to.
default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>>	getCommitMetadataBetween(java.lang.String branch, long from, long to) Returns an iterator over the entries of commit timestamp and associated metadata, bounded between from and to, in descending order.
java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>>	getCommitMetadataBetween(java.lang.String branch, long from, long to, org.chronos.chronodb.api.Order order) Returns an iterator over the entries of commit timestamp and associated metadata, bounded between from and to.
default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>>	getCommitMetadataPaged(long minTimestamp, long maxTimestamp, int pageSize, int pageIndex, org.chronos.chronodb.api.Order order) Returns an iterator over commit timestamps and associated metadata on the master branch in a paged fashion.
java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>>	getCommitMetadataPaged(java.lang.String branch, long minTimestamp, long maxTimestamp, int pageSize, int pageIndex, org.chronos.chronodb.api.Order order) Returns an iterator over commit timestamps and associated metadata in a paged fashion.
default java.util.Iterator<java.lang.Long>	getCommitTimestampsBetween(long from, long to) Returns an iterator over all timestamps where commits have occurred on the master branch, bounded between from and to, in descending order.
default java.util.Iterator<java.lang.Long>	getCommitTimestampsBetween(long from, long to, org.chronos.chronodb.api.Order order) Returns an iterator over all timestamps where commits have occurred on the master branch, bounded between from and to.
default java.util.Iterator<java.lang.Long>	getCommitTimestampsBetween(java.lang.String branch, long from, long to) Returns an iterator over all timestamps where commits have occurred on the given branch, bounded between from and to, in descending order.
java.util.Iterator<java.lang.Long>	getCommitTimestampsBetween(java.lang.String branch, long from, long to, org.chronos.chronodb.api.Order order) Returns an iterator over all timestamps where commits have occurred, bounded between from and to.
default java.util.Iterator<java.lang.Long>	getCommitTimestampsBewteen(long from, long to, org.chronos.chronodb.api.Order order) Returns an iterator over all timestamps where commits have occurred on the master branch, bounded between from and to.
default java.util.Iterator<java.lang.Long>	getCommitTimestampsPaged(long minTimestamp, long maxTimestamp, int pageSize, int pageIndex, org.chronos.chronodb.api.Order order) Returns an iterator over commit timestamps on the master branch in a paged fashion.
java.util.Iterator<java.lang.Long>	getCommitTimestampsPaged(java.lang.String branch, long minTimestamp, long maxTimestamp, int pageSize, int pageIndex, org.chronos.chronodb.api.Order order) Returns an iterator over commit timestamps in a paged fashion.
ChronoSphereConfiguration	getConfiguration() Returns the configuration of this ChronoSphere instance.
ChronoSphereEPackageManager	getEPackageManager() Returns the EPackage manager associated with this ChronoSphere instance.
default ChronoSphereIndexManager	getIndexManager() Returns the index manager associated with the master branch of this ChronoSphere instance.
ChronoSphereIndexManager	getIndexManager(java.lang.String branchName) Returns the index manager associated with the given branch.
default long	getNow() Returns the "now" timestamp, i.e. the timestamp of the latest commit on the repository, on the master branch.
long	getNow(java.lang.String branchName) Returns the "now" timestamp, i.e. the timestamp of the latest commit on the repository, on the given branch.
boolean	isClosed() Checks if this ChronoSphere instance is closed or not.
default boolean	isOpen() Checks if this ChronoSphere instance is still open.
ChronoSphereTransaction	tx() Produces and returns a new instance of ChronoSphereTransaction on the master branch head version.
ChronoSphereTransaction	tx(java.util.Date date) Produces and returns a new instance of ChronoSphereTransaction on the master branch at the given date.
ChronoSphereTransaction	tx(long timestamp) Produces and returns a new instance of ChronoSphereTransaction on the master branch at the given timestamp.
ChronoSphereTransaction	tx(java.lang.String branchName) Produces and returns a new instance of ChronoSphereTransaction on the head version of the given branch.
ChronoSphereTransaction	tx(java.lang.String branchName, java.util.Date date) Produces and returns a new instance of ChronoSphereTransaction at the given date on the given branch.
ChronoSphereTransaction	tx(java.lang.String branchName, long timestamp) Produces and returns a new instance of ChronoSphereTransaction at the given timestamp on the given branch.

Field Detail

FACTORY

static final ChronoSphereFactory FACTORY

This is the singleton factory instance for ChronoSpheres.

Method Detail

getConfiguration

ChronoSphereConfiguration getConfiguration()

Returns the configuration of this ChronoSphere instance.

Returns:

The configuration. Never null.

tx

ChronoSphereTransaction tx()

Produces and returns a new instance of ChronoSphereTransaction on the master branch head version.

Note that transactions are in general not thread-safe and must not be shared among threads.

Returns:

The transaction. Never null.

tx

ChronoSphereTransaction tx(long timestamp)
                    throws org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException

Produces and returns a new instance of ChronoSphereTransaction on the master branch at the given timestamp.

Please note that implementations may choose to refuse opening a transaction on certain timestamps, e.g. when the desired timestamp is in the future. In such cases, an InvalidTransactionTimestampException is thrown.

Note that transactions are in general not thread-safe and must not be shared among threads.

Parameters:

timestamp - The timestamp to use. Must not be negative.

Returns:

The transaction. Never null.

Throws:

org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException - Thrown if the transaction could not be opened due to an invalid timestamp.

tx

ChronoSphereTransaction tx(java.util.Date date)
                    throws org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException

Produces and returns a new instance of ChronoSphereTransaction on the master branch at the given date.

Please note that implementations may choose to refuse opening a transaction on certain dates, e.g. when the desired date is in the future. In such cases, an InvalidTransactionTimestampException is thrown.

Note that transactions are in general not thread-safe and must not be shared among threads.

Parameters:

date - The date to use. Must not be negative.

Returns:

The transaction. Never null.

Throws:

org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException - Thrown if the transaction could not be opened due to an invalid timestamp.

tx

ChronoSphereTransaction tx(java.lang.String branchName)
                    throws org.chronos.chronodb.api.exceptions.InvalidTransactionBranchException

Produces and returns a new instance of ChronoSphereTransaction on the head version of the given branch.

Note that transactions are in general not thread-safe and must not be shared among threads.

Parameters:

branchName - The name of the branch to start a transaction on. Must not be null. Must be the name of an existing branch.

Returns:

The transaction. Never null.

Throws:

org.chronos.chronodb.api.exceptions.InvalidTransactionBranchException - Thrown if the transaction could not be opened due to an invalid branch name.

tx

ChronoSphereTransaction tx(java.lang.String branchName,
                           long timestamp)
                    throws org.chronos.chronodb.api.exceptions.InvalidTransactionBranchException,
                           org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException

Produces and returns a new instance of ChronoSphereTransaction at the given timestamp on the given branch.

Please note that implementations may choose to refuse opening a transaction on certain timestamps, e.g. when the desired timestamp is in the future. In such cases, an InvalidTransactionTimestampException is thrown.

Note that transactions are in general not thread-safe and must not be shared among threads.

Parameters:

branchName - The name of the branch to start a transaction on. Must not be null. Must be the name of an existing branch.

timestamp - The timestamp to use. Must not be negative.

Returns:

The transaction. Never null.

Throws:

org.chronos.chronodb.api.exceptions.InvalidTransactionBranchException - Thrown if the transaction could not be opened due to an invalid branch.

org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException - Thrown if the transaction could not be opened due to an invalid timestamp.

tx

ChronoSphereTransaction tx(java.lang.String branchName,
                           java.util.Date date)
                    throws org.chronos.chronodb.api.exceptions.InvalidTransactionBranchException,
                           org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException

Produces and returns a new instance of ChronoSphereTransaction at the given date on the given branch.

Please note that implementations may choose to refuse opening a transaction on certain dates, e.g. when the desired date is in the future. In such cases, an InvalidTransactionTimestampException is thrown.

Note that transactions are in general not thread-safe and must not be shared among threads.

Parameters:

branchName - The name of the branch to start a transaction on. Must not be null. Must be the name of an existing branch.

date - The date to use. Must not be negative.

Returns:

The transaction. Never null.

Throws:

org.chronos.chronodb.api.exceptions.InvalidTransactionBranchException - Thrown if the transaction could not be opened due to an invalid branch.

org.chronos.chronodb.api.exceptions.InvalidTransactionTimestampException - Thrown if the transaction could not be opened due to an invalid timestamp.

batchInsertModelData

default void batchInsertModelData(java.lang.String xmiContent)

Batch-inserts the EObject model data from the given XMI content into the master branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

xmiContent - The XMI content to load. This string must contain the actual XMI contents. Must not be null, must be syntactically valid XMI.

See Also:

batchInsertModelData(File)

batchInsertModelData

default void batchInsertModelData(java.lang.String branch,
                                  java.lang.String xmiContent)

Batch-inserts the EObject model data from the given XMI content into the given branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

branch - The branch to load the model elements into. Must not be null, must refer to an existing branch.

xmiContent - The XMI content to load. This string must contain the actual XMI contents. Must not be null, must be syntactically valid XMI.

See Also:

batchInsertModelData(String, File)

batchInsertModelData

default void batchInsertModelData(java.io.File xmiFile)

Batch-inserts the EObject model data from the given XMI file into the master branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

xmiFile - The XMI file to load. Must not be null, must exist, must be a file, must have a file name ending with *.xmi, and must contain syntactically valid XMI data.

batchInsertModelData

default void batchInsertModelData(java.lang.String branch,
                                  java.io.File xmiFile)

Batch-inserts the EObject model data from the given XMI file into the given branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

branch - The branch to load the model elements into. Must not be null, must refer to an existing branch.

xmiFile - The XMI file to load. Must not be null, must exist, must be a file, must have a file name ending with *.xmi, and must contain syntactically valid XMI data.

batchInsertModelData

default void batchInsertModelData(org.eclipse.emf.ecore.EObject model)

Batch-inserts the given EObject model data into the master branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

model - The EObject model to insert into the repository. Must not be null. All elements must be an instance of ChronoEObjectImpl. All contained EObjects will be batch-loaded, recursively.

batchInsertModelData

default void batchInsertModelData(java.lang.String branch,
                                  org.eclipse.emf.ecore.EObject model)

Batch-inserts the given EObject model data into the given branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

branch - The branch to load the model elements into. Must not be null, must refer to an existing branch.

model - The EObject model to insert into the repository. Must not be null. All elements must be an instance of ChronoEObjectImpl. All contained EObjects will be batch-loaded, recursively.

batchInsertModelData

default void batchInsertModelData(java.lang.Iterable<org.eclipse.emf.ecore.EObject> model)

Batch-inserts the given EObject model data into the master branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

model - The EObject model to insert into the repository. Must not be null. All elements must be an instance of ChronoEObjectImpl. All contained EObjects will be batch-loaded, recursively.

batchInsertModelData

default void batchInsertModelData(java.lang.String branch,
                                  java.lang.Iterable<org.eclipse.emf.ecore.EObject> model)

Batch-inserts the given EObject model data into the given branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

branch - The branch to load the model elements into. Must not be null, must refer to an existing branch.

model - The EObject model to insert into the repository. Must not be null. All elements must be an instance of ChronoEObjectImpl. All contained EObjects will be batch-loaded, recursively.

batchInsertModelData

default void batchInsertModelData(java.util.Iterator<org.eclipse.emf.ecore.EObject> model)

Batch-inserts the given EObject model data into the master branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

model - The EObject model to insert into the repository. Must not be null. All elements must be an instance of ChronoEObjectImpl. All contained EObjects will be batch-loaded, recursively.

batchInsertModelData

void batchInsertModelData(java.lang.String branch,
                          java.util.Iterator<org.eclipse.emf.ecore.EObject> model)

Batch-inserts the given EObject model data into the given branch of this repository.

Please remember to register your EPackages before calling this method.

Only one batch insert process can be active at any point in time. Any other write transactions will be denied while this process is running.

Parameters:

branch - The branch to load the model elements into. Must not be null, must refer to an existing branch.

model - The EObject model to insert into the repository. Must not be null. All elements must be an instance of ChronoEObjectImpl. All contained EObjects will be batch-loaded, recursively.

getBranchManager

ChronoSphereBranchManager getBranchManager()

Returns the branch manager associated with this ChronoSphere instance.

Returns:

The branch manager. Never null.

getIndexManager

default ChronoSphereIndexManager getIndexManager()

Returns the index manager associated with the master branch of this ChronoSphere instance.

Returns:

The index manager for the master branch. Never null.

getIndexManager

ChronoSphereIndexManager getIndexManager(java.lang.String branchName)

Returns the index manager associated with the given branch.

Parameters:

branchName - The name of the branch to get the index manager for. Must not be null, must refer to an existing branch.

Returns:

The index manager for the given branch. Never null.

getEPackageManager

ChronoSphereEPackageManager getEPackageManager()

Returns the EPackage manager associated with this ChronoSphere instance.

Returns:

The EPackage manager. Never null.

close

void close()

Closes this ChronoSphere instance.

Any further attempt to work with this instance will give rise to an appropriate exception, unless noted explicitly in the method documentation.

This method is safe to use on closed instances. When called on an already closed instance, this method is a no-op and returns immediately.

Specified by:

close in interface java.lang.AutoCloseable

isClosed

boolean isClosed()

Checks if this ChronoSphere instance is closed or not.

This method is safe to use on closed instances.

Returns:

true if this instance is closed, or false if it is still open.

See Also:

close(), isOpen()

isOpen

default boolean isOpen()

Checks if this ChronoSphere instance is still open.

This method is safe to use on closed instances.

Returns:

true if this instance is open, or false if it is already closed.

See Also:

close(), isClosed()

getNow

default long getNow()

Returns the "now" timestamp, i.e. the timestamp of the latest commit on the repository, on the master branch.

Requesting a transaction on this timestamp will always deliver a transaction on the "head" revision.

Returns:

The "now" timestamp. Will be zero if no commit has been taken place yet, otherwise a positive value.

getNow

long getNow(java.lang.String branchName)

Returns the "now" timestamp, i.e. the timestamp of the latest commit on the repository, on the given branch.

Requesting a transaction on this timestamp will always deliver a transaction on the "head" revision.

Parameters:

branchName - The name of the branch to retrieve the "now" timestamp for. Must refer to an existing branch. Must not be null.

Returns:

The "now" timestamp on the given branch. If no commits have occurred on the branch yet, this method returns zero (master branch) or the branching timestamp (non-master branch), otherwise a positive value.

getCommitMetadata

default java.lang.Object getCommitMetadata(long timestamp)

Returns the metadata for the commit on the master branch at the given timestamp.

This search will include origin branches (recursively), if the timestamp is after the branching timestamp.

Parameters:

timestamp - The timestamp to get the commit metadata for. Must match the commit timestamp exactly. Must not be negative.

Returns:

The commit metadata. May be null if there was no metadata for the commit, or there has not been a commit at the specified branch and timestamp.

getCommitMetadata

java.lang.Object getCommitMetadata(java.lang.String branch,
                                   long timestamp)

Returns the metadata for the commit on the given branch at the given timestamp.

This search will include origin branches (recursively), if the timestamp is after the branching timestamp.

Parameters:

branch - The branch to search for the commit metadata in. Must not be null.

timestamp - The timestamp to get the commit metadata for. Must match the commit timestamp exactly. Must not be negative.

Returns:

The commit metadata. May be null if there was no metadata for the commit, or there has not been a commit at the specified branch and timestamp.

getCommitTimestampsBetween

default java.util.Iterator<java.lang.Long> getCommitTimestampsBetween(long from,
                                                                      long to)

Returns an iterator over all timestamps where commits have occurred on the master branch, bounded between from and to, in descending order.

If the from value is greater than the to value, this method always returns an empty iterator.

Parameters:

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

Returns:

The iterator over the commit timestamps in the given time range, in descending order. May be empty, but never null.

getCommitTimestampsBetween

default java.util.Iterator<java.lang.Long> getCommitTimestampsBetween(java.lang.String branch,
                                                                      long from,
                                                                      long to)

Returns an iterator over all timestamps where commits have occurred on the given branch, bounded between from and to, in descending order.

If the from value is greater than the to value, this method always returns an empty iterator.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

Returns:

The iterator over the commit timestamps in the given time range, in descending order. May be empty, but never null.

getCommitTimestampsBewteen

default java.util.Iterator<java.lang.Long> getCommitTimestampsBewteen(long from,
                                                                      long to,
                                                                      org.chronos.chronodb.api.Order order)

Returns an iterator over all timestamps where commits have occurred on the master branch, bounded between from and to.

If the from value is greater than the to value, this method always returns an empty iterator.

Parameters:

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

order - The order of the returned timestamps. Must not be null.

Returns:

The iterator over the commit timestamps in the given time range. May be empty, but never null.

getCommitTimestampsBetween

default java.util.Iterator<java.lang.Long> getCommitTimestampsBetween(long from,
                                                                      long to,
                                                                      org.chronos.chronodb.api.Order order)

Returns an iterator over all timestamps where commits have occurred on the master branch, bounded between from and to.

If the from value is greater than the to value, this method always returns an empty iterator.

Parameters:

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

order - The order of the returned timestamps. Must not be null.

Returns:

The iterator over the commit timestamps in the given time range. May be empty, but never null.

getCommitTimestampsBetween

java.util.Iterator<java.lang.Long> getCommitTimestampsBetween(java.lang.String branch,
                                                              long from,
                                                              long to,
                                                              org.chronos.chronodb.api.Order order)

Returns an iterator over all timestamps where commits have occurred, bounded between from and to.

If the from value is greater than the to value, this method always returns an empty iterator.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

order - The order of the returned timestamps. Must not be null.

Returns:

The iterator over the commit timestamps in the given time range. May be empty, but never null.

getCommitMetadataBetween

default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>> getCommitMetadataBetween(long from,
                                                                                                          long to)

Returns an iterator over the entries of commit timestamp and associated metadata on the master branch, bounded between from and to, in descending order.

If the from value is greater than the to value, this method always returns an empty iterator.

Please keep in mind that some commits may not have any metadata attached. In this case, the value component of the Map.Entry will be set to null.

Parameters:

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

Returns:

An iterator over the commits in the given time range in descending order. The contained entries have the timestamp as the key component and the associated metadata as their value component (which may be null). May be empty, but never null.

getCommitMetadataBetween

default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>> getCommitMetadataBetween(java.lang.String branch,
                                                                                                          long from,
                                                                                                          long to)

Returns an iterator over the entries of commit timestamp and associated metadata, bounded between from and to, in descending order.

If the from value is greater than the to value, this method always returns an empty iterator.

Please keep in mind that some commits may not have any metadata attached. In this case, the value component of the Map.Entry will be set to null.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

Returns:

An iterator over the commits in the given time range in descending order. The contained entries have the timestamp as the key component and the associated metadata as their value component (which may be null). May be empty, but never null.

getCommitMetadataBetween

default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>> getCommitMetadataBetween(long from,
                                                                                                          long to,
                                                                                                          org.chronos.chronodb.api.Order order)

Returns an iterator over the entries of commit timestamp and associated metadata on the master branch, bounded between from and to.

If the from value is greater than the to value, this method always returns an empty iterator.

Please keep in mind that some commits may not have any metadata attached. In this case, the value component of the Map.Entry will be set to null.

Parameters:

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

order - The order of the returned commits. Must not be null.

Returns:

An iterator over the commits in the given time range. The contained entries have the timestamp as the key component and the associated metadata as their value component (which may be null). May be empty, but never null.

getCommitMetadataBetween

java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>> getCommitMetadataBetween(java.lang.String branch,
                                                                                                  long from,
                                                                                                  long to,
                                                                                                  org.chronos.chronodb.api.Order order)

Returns an iterator over the entries of commit timestamp and associated metadata, bounded between from and to.

If the from value is greater than the to value, this method always returns an empty iterator.

Please keep in mind that some commits may not have any metadata attached. In this case, the value component of the Map.Entry will be set to null.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

from - The lower bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The upper bound of the time range to look for commits in (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

order - The order of the returned commits. Must not be null.

Returns:

An iterator over the commits in the given time range. The contained entries have the timestamp as the key component and the associated metadata as their value component (which may be null). May be empty, but never null.

getCommitTimestampsPaged

default java.util.Iterator<java.lang.Long> getCommitTimestampsPaged(long minTimestamp,
                                                                    long maxTimestamp,
                                                                    int pageSize,
                                                                    int pageIndex,
                                                                    org.chronos.chronodb.api.Order order)

Returns an iterator over commit timestamps on the master branch in a paged fashion.

For example, calling getCommitTimestampsPaged(10000, 100, 0, Order.DESCENDING) will give the latest 100 commit timestamps that have occurred before timestamp 10000. Calling getCommitTimestampsPaged(123456, 200, 2, Order.DESCENDING will return 200 commit timestamps, skipping the 400 latest commit timestamps, which are smaller than 123456.

Parameters:

minTimestamp - The minimum timestamp to consider (inclusive). All lower timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

maxTimestamp - The highest timestamp to consider (inclusive). All higher timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

pageSize - The size of the page, i.e. the maximum number of elements allowed to be contained in the resulting iterator. Must be greater than zero.

pageIndex - The index of the page to retrieve. Must not be negative.

order - The desired ordering for the commit timestamps

Returns:

An iterator that contains the commit timestamps for the requested page. Never null, may be empty. If the requested page does not exist, this iterator will always be empty.

getCommitTimestampsPaged

java.util.Iterator<java.lang.Long> getCommitTimestampsPaged(java.lang.String branch,
                                                            long minTimestamp,
                                                            long maxTimestamp,
                                                            int pageSize,
                                                            int pageIndex,
                                                            org.chronos.chronodb.api.Order order)

Returns an iterator over commit timestamps in a paged fashion.

For example, calling getCommitTimestampsPaged(10000, 100, 0, Order.DESCENDING) will give the latest 100 commit timestamps that have occurred before timestamp 10000. Calling getCommitTimestampsPaged(123456, 200, 2, Order.DESCENDING will return 200 commit timestamps, skipping the 400 latest commit timestamps, which are smaller than 123456.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

minTimestamp - The minimum timestamp to consider (inclusive). All lower timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

maxTimestamp - The highest timestamp to consider (inclusive). All higher timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

pageSize - The size of the page, i.e. the maximum number of elements allowed to be contained in the resulting iterator. Must be greater than zero.

pageIndex - The index of the page to retrieve. Must not be negative.

order - The desired ordering for the commit timestamps

Returns:

An iterator that contains the commit timestamps for the requested page. Never null, may be empty. If the requested page does not exist, this iterator will always be empty.

getCommitMetadataPaged

default java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>> getCommitMetadataPaged(long minTimestamp,
                                                                                                        long maxTimestamp,
                                                                                                        int pageSize,
                                                                                                        int pageIndex,
                                                                                                        org.chronos.chronodb.api.Order order)

Returns an iterator over commit timestamps and associated metadata on the master branch in a paged fashion.

For example, calling getCommitTimestampsPaged(10000, 100, 0, Order.DESCENDING) will give the latest 100 commit timestamps that have occurred before timestamp 10000. Calling getCommitTimestampsPaged(123456, 200, 2, Order.DESCENDING will return 200 commit timestamps, skipping the 400 latest commit timestamps, which are smaller than 123456.

The Entries returned by the iterator always have the commit timestamp as their first component and the metadata associated with this commit as their second component. The second component can be null if the commit was executed without providing metadata.

Parameters:

minTimestamp - The minimum timestamp to consider (inclusive). All lower timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

maxTimestamp - The highest timestamp to consider. All higher timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

pageSize - The size of the page, i.e. the maximum number of elements allowed to be contained in the resulting iterator. Must be greater than zero.

pageIndex - The index of the page to retrieve. Must not be negative.

order - The desired ordering for the commit timestamps

Returns:

An iterator that contains the commits for the requested page. Never null, may be empty. If the requested page does not exist, this iterator will always be empty.

getCommitMetadataPaged

java.util.Iterator<java.util.Map.Entry<java.lang.Long,java.lang.Object>> getCommitMetadataPaged(java.lang.String branch,
                                                                                                long minTimestamp,
                                                                                                long maxTimestamp,
                                                                                                int pageSize,
                                                                                                int pageIndex,
                                                                                                org.chronos.chronodb.api.Order order)

Returns an iterator over commit timestamps and associated metadata in a paged fashion.

For example, calling getCommitTimestampsPaged(10000, 100, 0, Order.DESCENDING) will give the latest 100 commit timestamps that have occurred before timestamp 10000. Calling getCommitTimestampsPaged(123456, 200, 2, Order.DESCENDING will return 200 commit timestamps, skipping the 400 latest commit timestamps, which are smaller than 123456.

The Entries returned by the iterator always have the commit timestamp as their first component and the metadata associated with this commit as their second component. The second component can be null if the commit was executed without providing metadata.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

minTimestamp - The minimum timestamp to consider (inclusive). All lower timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

maxTimestamp - The highest timestamp to consider. All higher timestamps will be excluded from the pagination. Must be less than or equal to the timestamp of this transaction.

pageSize - The size of the page, i.e. the maximum number of elements allowed to be contained in the resulting iterator. Must be greater than zero.

pageIndex - The index of the page to retrieve. Must not be negative.

order - The desired ordering for the commit timestamps

Returns:

An iterator that contains the commits for the requested page. Never null, may be empty. If the requested page does not exist, this iterator will always be empty.

countCommitTimestampsBetween

default int countCommitTimestampsBetween(long from,
                                         long to)

Counts the number of commit timestamps on the master branch between from (inclusive) and to (inclusive).

If from is greater than to, this method will always return zero.

Parameters:

from - The minimum timestamp to include in the search (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The maximum timestamp to include in the search (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

Returns:

The number of commits that have occurred in the specified time range. May be zero, but never negative.

countCommitTimestampsBetween

int countCommitTimestampsBetween(java.lang.String branch,
                                 long from,
                                 long to)

Counts the number of commit timestamps between from (inclusive) and to (inclusive).

If from is greater than to, this method will always return zero.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

from - The minimum timestamp to include in the search (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

to - The maximum timestamp to include in the search (inclusive). Must not be negative. Must be less than or equal to the timestamp of this transaction.

Returns:

The number of commits that have occurred in the specified time range. May be zero, but never negative.

countCommitTimestamps

default int countCommitTimestamps()

Counts the total number of commit timestamps on the master branch.

Returns:

The total number of commits in the graph.

countCommitTimestamps

int countCommitTimestamps(java.lang.String branch)

Counts the total number of commit timestamps in the graph.

Parameters:

branch - The name of the branch to consider. Must not be null, must refer to an existing branch.

Returns:

The total number of commits in the graph.