com.orientechnologies.orient.core.index

Class OIndexManagerShared

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

com.orientechnologies.orient.core.index.OIndexManagerAbstract

com.orientechnologies.orient.core.index.OIndexManagerShared

All Implemented Interfaces:

OCloseable, OIndexManager, Serializable

Direct Known Subclasses:

OIndexManagerDistributed

public class OIndexManagerShared
extends OIndexManagerAbstract

Manages indexes at database level. A single instance is shared among multiple databases. Contentions are managed by r/w locks.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com), Artem Orobets added composite index managemement

See Also:

Serialized Form

Field Summary

Fields inherited from class com.orientechnologies.orient.core.index.OIndexManagerAbstract

indexes

Fields inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

document

Constructor Summary

Constructors

Constructor and Description
OIndexManagerShared(OStorage storage)

Method Summary

Modifier and Type	Method and Description
boolean	autoRecreateIndexesAfterCrash() Checks if indexes should be automatically recreated.
boolean	autoRecreateIndexesAfterCrash(ODatabaseDocumentInternal database)
OIndex<?>	createIndex(String iName, String iType, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata) Create a new index with default algorithm.
OIndex<?>	createIndex(String iName, String type, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata, String algorithm) Create a new index.
OIndexManager	dropIndex(String iIndexName) Drop index with specified name.
protected void	fromStream()
protected OStorage	getStorage()
OIndex<?>	preProcessBeforeReturn(ODatabaseDocumentInternal database, OIndex<?> index)
void	recreateIndexes() Drops all indexes and creates them from scratch.
void	recreateIndexes(ODatabaseDocumentInternal database)
void	removeClassPropertyIndex(OIndex<?> idx) Removes index from class-property map.
ODocument	toNetworkStream()
ODocument	toStream() Binds POJO to ODocument.
void	waitTillIndexRestore() Blocks current thread till indexes will be restored.

Methods inherited from class com.orientechnologies.orient.core.index.OIndexManagerAbstract

acquireExclusiveLock, addClusterToIndex, areIndexed, areIndexed, close, create, create, existsIndex, flush, getClassAutoShardingIndex, getClassIndex, getClassIndexes, getClassIndexes, getClassInvolvedIndexes, getClassInvolvedIndexes, getClassRawIndexes, getClassUniqueIndex, getConfiguration, getDatabase, getDefaultClusterName, getDictionary, getIndex, getIndexes, getIndexes, getRawIndex, load, load, releaseExclusiveLock, reload, removeClusterFromIndex, save, setDefaultClusterName

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

fromStream, reload, save

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

equals, getDocument, hashCode, load, load, reload, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OIndexManagerShared

public OIndexManagerShared(OStorage storage)

Method Detail

createIndex

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

Create 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

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

Create a new index.

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

Parameters:

iName - name of index

type - 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

public OIndexManager dropIndex(String iIndexName)

Description copied from interface: OIndexManager

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

Parameters:

iIndexName - the name of index to drop

Returns:

this

toStream

public ODocument toStream()

Binds POJO to ODocument.

Overrides:

toStream in class ODocumentWrapper

recreateIndexes

public void recreateIndexes(ODatabaseDocumentInternal database)

Specified by:

recreateIndexes in class OIndexManagerAbstract

recreateIndexes

public void recreateIndexes()

Description copied from interface: OIndexManager

Drops all indexes and creates them from scratch.

waitTillIndexRestore

public void waitTillIndexRestore()

Description copied from interface: OIndexManager

Blocks current thread till indexes will be restored.

autoRecreateIndexesAfterCrash

public boolean autoRecreateIndexesAfterCrash(ODatabaseDocumentInternal database)

Specified by:

autoRecreateIndexesAfterCrash in class OIndexManagerAbstract

autoRecreateIndexesAfterCrash

public boolean autoRecreateIndexesAfterCrash()

Description copied from interface: OIndexManager

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.

fromStream

protected void fromStream()

Specified by:

fromStream in class ODocumentWrapperNoClass

removeClassPropertyIndex

public void removeClassPropertyIndex(OIndex<?> idx)

Description copied from interface: OIndexManager

Removes index from class-property map.

IMPORTANT! Only for internal usage.

Parameters:

idx - index to remove.

toNetworkStream

public ODocument toNetworkStream()

preProcessBeforeReturn

public OIndex<?> preProcessBeforeReturn(ODatabaseDocumentInternal database,
                                        OIndex<?> index)

Specified by:

preProcessBeforeReturn in class OIndexManagerAbstract

getStorage

protected OStorage getStorage()

Specified by:

getStorage in class OIndexManagerAbstract