com.orientechnologies.orient.core.index

Class OIndexManagerRemote

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.OIndexManagerRemote

All Implemented Interfaces:

OCloseable, OIndexManager, Serializable

public class OIndexManagerRemote
extends OIndexManagerAbstract

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
OIndexManagerRemote(OStorage storage)

Method Summary

Modifier and Type	Method and Description
protected void	acquireExclusiveLock()
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) Creates a new index with default algorithm.
OIndex<?>	createIndex(String iName, String iType, OIndexDefinition iIndexDefinition, int[] iClusterIdsToIndex, OProgressListener progressListener, ODocument metadata, String engine) Creates a new index.
OIndexManager	dropIndex(String iIndexName) Drop index with specified name.
protected void	fromStream()
void	fromStream(ODocument iDocument)
protected OIndex<?>	getRemoteIndexInstance(boolean isMultiValueIndex, String type, String name, String algorithm, Set<String> clustersToIndex, OIndexDefinition indexDefinition, ORID identity, ODocument configuration)
protected OStorage	getStorage()
OIndex<?>	preProcessBeforeReturn(ODatabaseDocumentInternal database, OIndex<?> index)
void	recreateIndexes() Drops all indexes and creates them from scratch.
void	recreateIndexes(ODatabaseDocumentInternal database)
protected void	releaseExclusiveLock()
void	removeClassPropertyIndex(OIndex<?> idx) Removes index from class-property map.
ODocument	toStream()
void	update(ODocument indexManager)
void	waitTillIndexRestore() Blocks current thread till indexes will be restored.

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

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, reload, removeClusterFromIndex, save, setDefaultClusterName

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

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

OIndexManagerRemote

public OIndexManagerRemote(OStorage storage)

Method Detail

createIndex

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

Description copied from interface: OIndexManager

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.

iIndexDefinition - metadata that describes index structure

iClusterIdsToIndex - 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.

engine - tip to an index factory what algorithm to use

Returns:

a newly created index instance

createIndex

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

Description copied from interface: OIndexManager

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

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

Overrides:

toStream in class ODocumentWrapper

recreateIndexes

public void recreateIndexes()

Description copied from interface: OIndexManager

Drops all indexes and creates them from scratch.

recreateIndexes

public void recreateIndexes(ODatabaseDocumentInternal database)

Specified by:

recreateIndexes in class OIndexManagerAbstract

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.

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.

getRemoteIndexInstance

protected OIndex<?> getRemoteIndexInstance(boolean isMultiValueIndex,
                                           String type,
                                           String name,
                                           String algorithm,
                                           Set<String> clustersToIndex,
                                           OIndexDefinition indexDefinition,
                                           ORID identity,
                                           ODocument configuration)

fromStream

protected void fromStream()

Specified by:

fromStream in class ODocumentWrapperNoClass

preProcessBeforeReturn

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

Specified by:

preProcessBeforeReturn in class OIndexManagerAbstract

acquireExclusiveLock

protected void acquireExclusiveLock()

Overrides:

acquireExclusiveLock in class OIndexManagerAbstract

releaseExclusiveLock

protected void releaseExclusiveLock()

Overrides:

releaseExclusiveLock in class OIndexManagerAbstract

fromStream

public void fromStream(ODocument iDocument)

Overrides:

fromStream in class ODocumentWrapperNoClass

update

public void update(ODocument indexManager)

getStorage

protected OStorage getStorage()

Specified by:

getStorage in class OIndexManagerAbstract