org.chronos.chronosphere.api

Interface ChronoSphereIndexManager

All Known Implementing Classes:

ChronoSphereIndexManagerImpl

public interface ChronoSphereIndexManager

This class manages the individual secondary indices on a model.

You can get an instance of this class via ChronoSphere.getIndexManager().

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.
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) Deprecated. As of Chronos 0.6.8 or later, please use reindexAll() instead.
void	reindexAll() Re-indexes all dirty indices.

Method Detail

createIndexOn

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

Creates an index on the given EAttribute.

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.

Throws:

java.lang.IllegalArgumentException - Thrown if the given EAttribute is not part of any registered EPackage.

java.lang.NullPointerException - Thrown if the given EAttribute is null.

See Also:

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

existsIndexOn

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

Checks if the given EAttribute is indexed or not.

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.

Throws:

java.lang.IllegalArgumentException - Thrown if the given EAttribute is not part of any registered EPackage.

java.lang.NullPointerException - Thrown if the given EAttribute is null.

See Also:

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

dropIndexOn

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

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

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.

Throws:

java.lang.IllegalArgumentException - Thrown if the given EAttribute is not part of any registered EPackage.

java.lang.NullPointerException - Thrown if the given EAttribute is null.

See Also:

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

reindexAll

void reindexAll()

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.

reindex

@Deprecated
void reindex(org.eclipse.emf.ecore.EAttribute eAttribute)

Deprecated. As of Chronos 0.6.8 or later, please use reindexAll() instead.

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.

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.

Throws:

java.lang.IllegalArgumentException - Thrown if the given EAttribute is not part of any registered EPackage.

java.lang.NullPointerException - Thrown if the given EAttribute is null.

See Also:

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

isIndexDirty

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

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.

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.

Throws:

java.lang.IllegalArgumentException - Thrown if the given EAttribute is not part of any registered EPackage.

java.lang.NullPointerException - Thrown if the given EAttribute is null.

See Also:

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