com.orientechnologies.orient.core.index

Interface OIndexManager

All Known Implementing Classes:

OIndexManagerAbstract, OIndexManagerProxy, OIndexManagerRemote, OIndexManagerShared

public interface OIndexManager

Manager of indexes.

Author:

Luca Garulli (l.garulli--at--orientechnologies.com)

Method Summary

Modifier and Type	Method and Description
void	addClusterToIndex(String clusterName, String indexName) Adds a cluster to tracked cluster list of specified index.
boolean	areIndexed(String className, Collection<String> fields) Indicates whether given fields are contained as first key fields in class indexes.
boolean	areIndexed(String className, String... fields)
boolean	autoRecreateIndexesAfterCrash() Checks if indexes should be automatically recreated.
void	create() Creates a document where index manager configuration is saved and creates a "dictionary" index.
OIndex<?>	createIndex(String iName, String iType, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata) Creates a new index with default algorithm.
OIndex<?>	createIndex(String iName, String iType, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata, String algorithm) Creates a new index.
OIndexManager	dropIndex(String iIndexName) Drop index with specified name.
boolean	existsIndex(String iName) Checks if index with specified name exists in database.
void	flush() Flushes all indexes that is registered in this manager.
OIndex<?>	getClassAutoShardingIndex(String className) Returns the auto-sharding index defined for the class, if any.
OIndex<?>	getClassIndex(String className, String indexName) Searches for index for a specified class with specified name.
Set<OIndex<?>>	getClassIndexes(String className) Gets indexes for a specified class (excluding indexes for sub-classes).
void	getClassIndexes(String className, Collection<OIndex<?>> indexes) Gets indexes for a specified class (excluding indexes for sub-classes).
Set<OIndex<?>>	getClassInvolvedIndexes(String className, Collection<String> fields) Returns list of indexes that contain passed in fields names as their first keys.
Set<OIndex<?>>	getClassInvolvedIndexes(String className, String... fields) Returns list of indexes that contain passed in fields names as their first keys.
OIndexUnique	getClassUniqueIndex(String className) Returns the unique index for a class, if any.
ODocument	getConfiguration() Returns a record where configurations are saved.
String	getDefaultClusterName() IMPORTANT! Only for internal usage.
ODictionary<ORecord>	getDictionary() Return a dictionary index.
OIndex<?>	getIndex(String iName) Index by specified name.
Collection<? extends OIndex<?>>	getIndexes() Returns all indexes registered in database.
OIndexManager	load() Load index manager data from database.
void	recreateIndexes() Drops all indexes and creates them from scratch.
void	removeClassPropertyIndex(OIndex<?> idx) Removes index from class-property map.
void	removeClusterFromIndex(String clusterName, String indexName) Removes a cluster from tracked cluster list of specified index.
<RET extends ODocumentWrapper> RET	save() Saves index manager data.
void	setDefaultClusterName(String defaultClusterName) Sets the new default cluster.
void	waitTillIndexRestore() Blocks current thread till indexes will be restored.

Method Detail

load

OIndexManager load()

Load index manager data from database. IMPORTANT! Only for internal usage.

Returns:

this

create

void create()

Creates a document where index manager configuration is saved and creates a "dictionary" index. IMPORTANT! Only for internal usage.

recreateIndexes

void recreateIndexes()

Drops all indexes and creates them from scratch.

getIndexes

Collection<? extends OIndex<?>> getIndexes()

Returns all indexes registered in database.

Returns:

list of registered indexes.

getIndex

OIndex<?> getIndex(String iName)

Index by specified name.

Parameters:

iName - name of index

Returns:

index if one registered in database or null otherwise.

getClassAutoShardingIndex

OIndex<?> getClassAutoShardingIndex(String className)

Returns the auto-sharding index defined for the class, if any.

Parameters:

className - Class name

existsIndex

boolean existsIndex(String iName)

Checks if index with specified name exists in database.

Parameters:

iName - name of index.

Returns:

true if index with specified name exists, false otherwise.

createIndex

OIndex<?> createIndex(String iName,
                      String iType,
                      OIndexDefinition indexDefinition,
                      int[] clusterIdsToIndex,
                      OProgressListener progressListener,
                      ODocument metadata)

Creates a new index with default algorithm.

Parameters:

iName - - name of index

iType - - index type. Specified by plugged index factories.

indexDefinition - metadata that describes index structure

clusterIdsToIndex - ids of clusters that index should track for changes.

progressListener - listener to track task progress.

metadata - document with additional properties that can be used by index engine.

Returns:

a newly created index instance

createIndex

OIndex<?> createIndex(String iName,
                      String iType,
                      OIndexDefinition indexDefinition,
                      int[] clusterIdsToIndex,
                      OProgressListener progressListener,
                      ODocument metadata,
                      String algorithm)

Creates a new index. May require quite a long time if big amount of data should be indexed.

Parameters:

iName - name of index

iType - index type. Specified by plugged index factories.

indexDefinition - metadata that describes index structure

clusterIdsToIndex - ids of clusters that index should track for changes.

progressListener - listener to track task progress.

metadata - document with additional properties that can be used by index engine.

algorithm - tip to an index factory what algorithm to use

Returns:

a newly created index instance

dropIndex

OIndexManager dropIndex(String iIndexName)

Drop index with specified name. Do nothing if such index does not exists.

Parameters:

iIndexName - the name of index to drop

Returns:

this

getDefaultClusterName

String getDefaultClusterName()

IMPORTANT! Only for internal usage.

Returns:

name of default cluster.

setDefaultClusterName

void setDefaultClusterName(String defaultClusterName)

Sets the new default cluster. IMPORTANT! Only for internal usage.

Parameters:

defaultClusterName - name of new default cluster

getDictionary

ODictionary<ORecord> getDictionary()

Return a dictionary index. Could be helpful to store different kinds of configurations.

Returns:

a dictionary

flush

void flush()

Flushes all indexes that is registered in this manager. There might be some changes stored in memory, this method ensures that all this changed are stored to the disk.

getConfiguration

ODocument getConfiguration()

Returns a record where configurations are saved. IMPORTANT! Only for internal usage.

Returns:

a document that used to store index configurations.

getClassInvolvedIndexes

Set<OIndex<?>> getClassInvolvedIndexes(String className,
                                       Collection<String> fields)

Returns list of indexes that contain passed in fields names as their first keys. Order of fields does not matter.

All indexes sorted by their count of parameters in ascending order. If there are indexes for the given set of fields in super class they will be taken into account.

Parameters:

className - name of class which is indexed.

fields - Field names.

Returns:

list of indexes that contain passed in fields names as their first keys.

getClassInvolvedIndexes

Set<OIndex<?>> getClassInvolvedIndexes(String className,
                                       String... fields)

Returns list of indexes that contain passed in fields names as their first keys. Order of fields does not matter.

All indexes sorted by their count of parameters in ascending order. If there are indexes for the given set of fields in super class they will be taken into account.

Parameters:

className - name of class which is indexed.

fields - Field names.

Returns:

list of indexes that contain passed in fields names as their first keys.

areIndexed

boolean areIndexed(String className,
                   Collection<String> fields)

Indicates whether given fields are contained as first key fields in class indexes. Order of fields does not matter. If there are indexes for the given set of fields in super class they will be taken into account.

Parameters:

className - name of class which contain fields.

fields - Field names.

Returns:

true if given fields are contained as first key fields in class indexes.

areIndexed

boolean areIndexed(String className,
                   String... fields)

Parameters:

className - name of class which contain fields.

fields - Field names.

Returns:

true if given fields are contained as first key fields in class indexes.

See Also:

areIndexed(String, java.util.Collection)

getClassIndexes

Set<OIndex<?>> getClassIndexes(String className)

Gets indexes for a specified class (excluding indexes for sub-classes).

Parameters:

className - name of class which is indexed.

Returns:

a set of indexes related to specified class

getClassIndexes

void getClassIndexes(String className,
                     Collection<OIndex<?>> indexes)

Gets indexes for a specified class (excluding indexes for sub-classes).

Parameters:

className - name of class which is indexed.

indexes - Collection of indexes where to add all the indexes

getClassUniqueIndex

OIndexUnique getClassUniqueIndex(String className)

Returns the unique index for a class, if any.

getClassIndex

OIndex<?> getClassIndex(String className,
                        String indexName)

Searches for index for a specified class with specified name.

Parameters:

className - name of class which is indexed.

indexName - name of index.

Returns:

an index instance or null if such does not exist.

waitTillIndexRestore

void waitTillIndexRestore()

Blocks current thread till indexes will be restored.

autoRecreateIndexesAfterCrash

boolean autoRecreateIndexesAfterCrash()

Checks if indexes should be automatically recreated. IMPORTANT! Only for internal usage.

Returns:

true if crash is happened and database configured to automatically recreate indexes after crash.

addClusterToIndex

void addClusterToIndex(String clusterName,
                       String indexName)

Adds a cluster to tracked cluster list of specified index. IMPORTANT! Only for internal usage.

Parameters:

clusterName - cluster to add.

indexName - name of index.

removeClusterFromIndex

void removeClusterFromIndex(String clusterName,
                            String indexName)

Removes a cluster from tracked cluster list of specified index. IMPORTANT! Only for internal usage.

Parameters:

clusterName - cluster to remove.

indexName - name of index.

save

<RET extends ODocumentWrapper> RET save()

Saves index manager data. IMPORTANT! Only for internal usage.

removeClassPropertyIndex

void removeClassPropertyIndex(OIndex<?> idx)

Removes index from class-property map. IMPORTANT! Only for internal usage.

Parameters:

idx - index to remove.