org.chronos.chronosphere.impl

Class ChronoSphereIndexManagerImpl

java.lang.Object

org.chronos.chronosphere.impl.ChronoSphereIndexManagerImpl

All Implemented Interfaces:

ChronoSphereIndexManager

public class ChronoSphereIndexManagerImpl
extends java.lang.Object
implements ChronoSphereIndexManager

Constructor Summary

Constructors

Constructor and Description
ChronoSphereIndexManagerImpl(ChronoSphereInternal owningSphere, SphereBranch owningBranch)

Method Summary

Modifier and Type	Method and Description
boolean	createIndexOn(org.eclipse.emf.ecore.EAttribute eAttribute) Creates an index on the given EAttribute.
boolean	dropIndexOn(org.eclipse.emf.ecore.EAttribute eAttribute) Drops an existing index on the given EAttribute (if such an index exists).
boolean	existsIndexOn(org.eclipse.emf.ecore.EAttribute eAttribute) Checks if the given EAttribute is indexed or not.
protected org.chronos.chronograph.api.index.ChronoGraphIndexManager	getGraphIndexManager()
boolean	isIndexDirty(org.eclipse.emf.ecore.EAttribute eAttribute) Checks if the index on the given EAttribute is dirty.
void	reindex(org.eclipse.emf.ecore.EAttribute eAttribute) Rebuilds the index on the given EAttribute from scratch.
void	reindexAll() Re-indexes all dirty indices.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChronoSphereIndexManagerImpl

public ChronoSphereIndexManagerImpl(ChronoSphereInternal owningSphere,
                                    SphereBranch owningBranch)

Method Detail

createIndexOn

public boolean createIndexOn(org.eclipse.emf.ecore.EAttribute eAttribute)

Description copied from interface: ChronoSphereIndexManager

Creates an index on the given EAttribute.

Specified by:

createIndexOn in interface ChronoSphereIndexManager

Parameters:

eAttribute - The attribute to index. Must not be null. Must be part of a registered EPackage.

Returns:

true if a new index for the given EAttribute was created, or false if the index already existed.

See Also:

ChronoSphere.getEPackageManager(), ChronoSphereEPackageManager.registerOrUpdateEPackage(EPackage)

existsIndexOn

public boolean existsIndexOn(org.eclipse.emf.ecore.EAttribute eAttribute)

Description copied from interface: ChronoSphereIndexManager

Checks if the given EAttribute is indexed or not.

Specified by:

existsIndexOn in interface ChronoSphereIndexManager

Parameters:

eAttribute - The EAttribute to check. Must not be null. Must be part of a registered EPackage.

Returns:

true if the attribute is indexed, otherwise false.

See Also:

ChronoSphere.getEPackageManager(), ChronoSphereEPackageManager.registerOrUpdateEPackage(EPackage)

dropIndexOn

public boolean dropIndexOn(org.eclipse.emf.ecore.EAttribute eAttribute)

Description copied from interface: ChronoSphereIndexManager

Drops an existing index on the given EAttribute (if such an index exists).

Specified by:

dropIndexOn in interface ChronoSphereIndexManager

Parameters:

eAttribute - The EAttribute to drop the index for. Must not be null. Must be part of a registered EPackage.

Returns:

true if an index on the given EAttribute existed and was dropped successfully, or false if there was no such index.

See Also:

ChronoSphere.getEPackageManager(), ChronoSphereEPackageManager.registerOrUpdateEPackage(EPackage)

reindexAll

public void reindexAll()

Description copied from interface: ChronoSphereIndexManager

Re-indexes all dirty indices.

This is a potentially expensive operation that can take a long time, depending on the size of the model stored in the repository. Use it with care.

Specified by:

reindexAll in interface ChronoSphereIndexManager

reindex

public void reindex(org.eclipse.emf.ecore.EAttribute eAttribute)

Description copied from interface: ChronoSphereIndexManager

Rebuilds the index on the given EAttribute from scratch.

This is a potentially expensive operation that can take a long time, depending on the size of the model stored in the repository. Use it with care.

Specified by:

reindex in interface ChronoSphereIndexManager

Parameters:

eAttribute - The EAttribute to rebuild the index for. Must not be null. Must be part of a registered EPackage. If there is no index on the given EAttribute, this method is a no-op and returns immediately.

See Also:

ChronoSphereIndexManager.isIndexDirty(EAttribute), ChronoSphere.getEPackageManager(), ChronoSphereEPackageManager.registerOrUpdateEPackage(EPackage)

isIndexDirty

public boolean isIndexDirty(org.eclipse.emf.ecore.EAttribute eAttribute)

Description copied from interface: ChronoSphereIndexManager

Checks if the index on the given EAttribute is dirty.

An index can become dirty e.g. when a new index is created on an already existing model, or when the EPackage contents change. A dirty index is an index that is out-of-synch with the model data and needs to be re-synchronized. This method checks if such re-synchronization is required.

Specified by:

isIndexDirty in interface ChronoSphereIndexManager

Parameters:

eAttribute - The EAttribute to check the dirty state of its index for. Must not be null. Must be part of a registered EPackage. If there is no index on the given EAttribute, this method returns false.

Returns:

true if there is an index on the given EAttribute AND that index is dirty, false either if there is no index on the given EAttribute or that index is not dirty.

See Also:

ChronoSphereIndexManager.isIndexDirty(EAttribute), ChronoSphere.getEPackageManager(), ChronoSphereEPackageManager.registerOrUpdateEPackage(EPackage)

getGraphIndexManager

protected org.chronos.chronograph.api.index.ChronoGraphIndexManager getGraphIndexManager()