org.chronos.chronosphere.impl

Class StandardChronoSphere

java.lang.Object

org.chronos.chronosphere.impl.StandardChronoSphere

All Implemented Interfaces:

java.lang.AutoCloseable, ChronoSphere, ChronoSphereInternal

public class StandardChronoSphere
extends java.lang.Object
implements ChronoSphere, ChronoSphereInternal

Field Summary

Fields inherited from interface org.chronos.chronosphere.api.ChronoSphere

FACTORY

Constructor Summary

Constructors

Constructor and Description
StandardChronoSphere(org.chronos.chronograph.api.structure.ChronoGraph graph, org.apache.commons.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
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.
void	close() Closes this ChronoSphere instance.
int	countCommitTimestamps(java.lang.String branch) Counts the total number of commit timestamps in the graph.
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.
java.lang.Object	getCommitMetadata(java.lang.String branch, long timestamp) Returns the metadata for the commit on the given branch at the given timestamp.
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.
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.
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.
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.
EObjectToGraphMapper	getEObjectToGraphMapper()
ChronoSphereEPackageManager	getEPackageManager() Returns the EPackage manager associated with this ChronoSphere instance.
EPackageToGraphMapper	getEPackageToGraphMapper()
ChronoSphereIndexManager	getIndexManager(java.lang.String branchName) Returns the index manager associated with the given 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.
org.chronos.chronograph.api.structure.ChronoGraph	getRootGraph()
boolean	isClosed() Checks if this ChronoSphere instance is closed or not.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.chronos.chronosphere.api.ChronoSphere

batchInsertModelData, batchInsertModelData, batchInsertModelData, batchInsertModelData, batchInsertModelData, batchInsertModelData, batchInsertModelData, batchInsertModelData, batchInsertModelData, countCommitTimestamps, countCommitTimestampsBetween, getCommitMetadata, getCommitMetadataBetween, getCommitMetadataBetween, getCommitMetadataBetween, getCommitMetadataPaged, getCommitTimestampsBetween, getCommitTimestampsBetween, getCommitTimestampsBetween, getCommitTimestampsBewteen, getCommitTimestampsPaged, getIndexManager, getNow, isOpen

Constructor Detail

StandardChronoSphere

public StandardChronoSphere(org.chronos.chronograph.api.structure.ChronoGraph graph,
                            org.apache.commons.configuration.Configuration configuration)

Method Detail

getConfiguration

public ChronoSphereConfiguration getConfiguration()

Description copied from interface: ChronoSphere

Returns the configuration of this ChronoSphere instance.

Specified by:

getConfiguration in interface ChronoSphere

Returns:

The configuration. Never null.

close

public void close()

Description copied from interface: ChronoSphere

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

Specified by:

close in interface ChronoSphere

isClosed

public boolean isClosed()

Description copied from interface: ChronoSphere

Checks if this ChronoSphere instance is closed or not.

This method is safe to use on closed instances.

Specified by:

isClosed in interface ChronoSphere

Returns:

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

See Also:

ChronoSphere.close(), ChronoSphere.isOpen()

getBranchManager

public ChronoSphereBranchManager getBranchManager()

Description copied from interface: ChronoSphere

Returns the branch manager associated with this ChronoSphere instance.

Specified by:

getBranchManager in interface ChronoSphere

Returns:

The branch manager. Never null.

getEPackageManager

public ChronoSphereEPackageManager getEPackageManager()

Description copied from interface: ChronoSphere

Returns the EPackage manager associated with this ChronoSphere instance.

Specified by:

getEPackageManager in interface ChronoSphere

Returns:

The EPackage manager. Never null.

getIndexManager

public ChronoSphereIndexManager getIndexManager(java.lang.String branchName)

Description copied from interface: ChronoSphere

Returns the index manager associated with the given branch.

Specified by:

getIndexManager in interface ChronoSphere

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.

tx

public ChronoSphereTransaction tx()

Description copied from interface: ChronoSphere

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.

Specified by:

tx in interface ChronoSphere

Returns:

The transaction. Never null.

tx

public ChronoSphereTransaction tx(long timestamp)

Description copied from interface: ChronoSphere

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.

Specified by:

tx in interface ChronoSphere

Parameters:

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

Returns:

The transaction. Never null.

tx

public ChronoSphereTransaction tx(java.util.Date date)

Description copied from interface: ChronoSphere

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.

Specified by:

tx in interface ChronoSphere

Parameters:

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

Returns:

The transaction. Never null.

tx

public ChronoSphereTransaction tx(java.lang.String branchName)

Description copied from interface: ChronoSphere

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.

Specified by:

tx in interface ChronoSphere

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.

tx

public ChronoSphereTransaction tx(java.lang.String branchName,
                                  long timestamp)

Description copied from interface: ChronoSphere

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.

Specified by:

tx in interface ChronoSphere

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.

tx

public ChronoSphereTransaction tx(java.lang.String branchName,
                                  java.util.Date date)

Description copied from interface: ChronoSphere

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.

Specified by:

tx in interface ChronoSphere

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.

batchInsertModelData

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

Description copied from interface: ChronoSphere

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.

Specified by:

batchInsertModelData in interface ChronoSphere

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.

getNow

public long getNow(java.lang.String branchName)

Description copied from interface: ChronoSphere

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.

Specified by:

getNow in interface ChronoSphere

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

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

Description copied from interface: ChronoSphere

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.

Specified by:

getCommitMetadata in interface ChronoSphere

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

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

Description copied from interface: ChronoSphere

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.

Specified by:

getCommitTimestampsBetween in interface ChronoSphere

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

public 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)

Description copied from interface: ChronoSphere

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.

Specified by:

getCommitMetadataBetween in interface ChronoSphere

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

public 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)

Description copied from interface: ChronoSphere

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.

Specified by:

getCommitTimestampsPaged in interface ChronoSphere

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

public 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)

Description copied from interface: ChronoSphere

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.

Specified by:

getCommitMetadataPaged in interface ChronoSphere

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

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

Description copied from interface: ChronoSphere

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

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

Specified by:

countCommitTimestampsBetween in interface ChronoSphere

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

public int countCommitTimestamps(java.lang.String branch)

Description copied from interface: ChronoSphere

Counts the total number of commit timestamps in the graph.

Specified by:

countCommitTimestamps in interface ChronoSphere

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.

getRootGraph

public org.chronos.chronograph.api.structure.ChronoGraph getRootGraph()

Specified by:

getRootGraph in interface ChronoSphereInternal

getEObjectToGraphMapper

public EObjectToGraphMapper getEObjectToGraphMapper()

Specified by:

getEObjectToGraphMapper in interface ChronoSphereInternal

getEPackageToGraphMapper

public EPackageToGraphMapper getEPackageToGraphMapper()

Specified by:

getEPackageToGraphMapper in interface ChronoSphereInternal