Package com.orientechnologies.orient.core.index

Class OIndexManagerShared

java.lang.Object

com.orientechnologies.orient.core.index.OIndexManagerShared

All Implemented Interfaces:

OCloseable, OIndexManagerAbstract

Direct Known Subclasses:

OIndexManagerDistributed

public class OIndexManagerShared
extends Object
implements 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

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Map<OMultiKey,Set<OIndex>>>	classPropertyIndex
protected String	defaultClusterName
protected ORID	identity
protected Map<String,OIndex>	indexes
protected final ReadWriteLock	lock
protected String	manualClusterName
protected final AtomicInteger	writeLockNesting

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

CONFIG_INDEXES, DICTIONARY_NAME

Constructor Summary

Constructors

Constructor	Description
OIndexManagerShared(OStorage storage)

Method Summary

Modifier and Type	Method	Description
protected void	acquireExclusiveLock()
void	addClusterToIndex(ODatabaseDocumentInternal database, String clusterName, String indexName)
boolean	areIndexed(String className, String... fields)
boolean	areIndexed(String className, Collection<String> fields)
boolean	autoRecreateIndexesAfterCrash(ODatabaseDocumentInternal database)
void	close()	Closes resources inside of call of OStorage#close().
void	create(ODatabaseDocumentInternal database)
OIndex	createIndex(ODatabaseDocumentInternal database, String iName, String iType, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata)	Create a new index with default algorithm.
OIndex	createIndex(ODatabaseDocumentInternal database, String iName, String type, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata, String algorithm)	Create a new index.
void	dropIndex(ODatabaseDocumentInternal database, String iIndexName)
boolean	existsIndex(String iName)
protected boolean	fromStream(ODocument document)
OIndex	getClassAutoShardingIndex(ODatabaseDocumentInternal database, String className)
OIndex	getClassIndex(ODatabaseDocumentInternal database, String className, String indexName)
Set<OIndex>	getClassIndexes(ODatabaseDocumentInternal database, String className)
void	getClassIndexes(ODatabaseDocumentInternal database, String className, Collection<OIndex> indexes)
Set<OIndex>	getClassInvolvedIndexes(ODatabaseDocumentInternal database, String className, String... fields)
Set<OIndex>	getClassInvolvedIndexes(ODatabaseDocumentInternal database, String className, Collection<String> fields)
void	getClassRawIndexes(String className, Collection<OIndex> indexes)
OIndexUnique	getClassUniqueIndex(String className)
ODocument	getConfiguration()
String	getDefaultClusterName()
ODictionary<ORecord>	getDictionary(ODatabaseDocumentInternal database)
ODocument	getDocument()
OIndex	getIndex(ODatabaseDocumentInternal database, String iName)
Collection<? extends OIndex>	getIndexes(ODatabaseDocumentInternal database)
OIndex	getRawIndex(String iName)
protected OStorage	getStorage()
void	load(ODatabaseDocumentInternal database)
OIndex	preProcessBeforeReturn(ODatabaseDocumentInternal database, OIndex index)
void	recreateIndexes(ODatabaseDocumentInternal database)
protected void	releaseExclusiveLock()
protected void	releaseExclusiveLock(ODatabaseDocumentInternal database, boolean save)
void	reload(ODatabaseDocumentInternal database)
void	removeClassPropertyIndex(OIndex idx)
void	removeClusterFromIndex(ODatabaseDocumentInternal database, String clusterName, String indexName)
void	save(ODatabaseDocumentInternal database)
void	setDefaultClusterName(ODatabaseDocumentInternal database, String defaultClusterName)
ODocument	toNetworkStream()
ODocument	toStream()	Binds POJO to ODocument.
void	waitTillIndexRestore()

Methods inherited from class java.lang.Object

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

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

create

Field Details

classPropertyIndex

protected final Map<String,Map<OMultiKey,Set<OIndex>>> classPropertyIndex

indexes

protected Map<String,OIndex> indexes

defaultClusterName

protected String defaultClusterName

manualClusterName

protected String manualClusterName

writeLockNesting

protected final AtomicInteger writeLockNesting

lock

protected final ReadWriteLock lock

identity

protected ORID identity

Constructor Details

OIndexManagerShared

public OIndexManagerShared(OStorage storage)

Method Details

load

public void load(ODatabaseDocumentInternal database)

Specified by:

load in interface OIndexManagerAbstract

reload

public void reload(ODatabaseDocumentInternal database)

Specified by:

reload in interface OIndexManagerAbstract

save

public void save(ODatabaseDocumentInternal database)

Specified by:

save in interface OIndexManagerAbstract

addClusterToIndex

public void addClusterToIndex(ODatabaseDocumentInternal database,
 String clusterName,
 String indexName)

Specified by:

addClusterToIndex in interface OIndexManagerAbstract

removeClusterFromIndex

public void removeClusterFromIndex(ODatabaseDocumentInternal database,
 String clusterName,
 String indexName)

Specified by:

removeClusterFromIndex in interface OIndexManagerAbstract

create

public void create(ODatabaseDocumentInternal database)

Specified by:

create in interface OIndexManagerAbstract

getIndexes

public Collection<? extends OIndex> getIndexes(ODatabaseDocumentInternal database)

Specified by:

getIndexes in interface OIndexManagerAbstract

getRawIndex

public OIndex getRawIndex(String iName)

Specified by:

getRawIndex in interface OIndexManagerAbstract

getIndex

public OIndex getIndex(ODatabaseDocumentInternal database,
 String iName)

Specified by:

getIndex in interface OIndexManagerAbstract

existsIndex

public boolean existsIndex(String iName)

Specified by:

existsIndex in interface OIndexManagerAbstract

getDefaultClusterName

public String getDefaultClusterName()

Specified by:

getDefaultClusterName in interface OIndexManagerAbstract

setDefaultClusterName

public void setDefaultClusterName(ODatabaseDocumentInternal database,
 String defaultClusterName)

Specified by:

setDefaultClusterName in interface OIndexManagerAbstract

getDictionary

public ODictionary<ORecord> getDictionary(ODatabaseDocumentInternal database)

Specified by:

getDictionary in interface OIndexManagerAbstract

getConfiguration

public ODocument getConfiguration()

Specified by:

getConfiguration in interface OIndexManagerAbstract

close

public void close()

Description copied from interface: OCloseable

Closes resources inside of call of OStorage#close(). So do not use locks when you call this method or you may have deadlock during storage close. This method is completely house keeping method and plays role of Object#finalize() in case of you need to clean up resources after storage is closed.

Specified by:

close in interface OCloseable

getClassInvolvedIndexes

public Set<OIndex> getClassInvolvedIndexes(ODatabaseDocumentInternal database,
 String className,
 Collection<String> fields)

Specified by:

getClassInvolvedIndexes in interface OIndexManagerAbstract

getClassInvolvedIndexes

public Set<OIndex> getClassInvolvedIndexes(ODatabaseDocumentInternal database,
 String className,
 String... fields)

Specified by:

getClassInvolvedIndexes in interface OIndexManagerAbstract

areIndexed

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

Specified by:

areIndexed in interface OIndexManagerAbstract

areIndexed

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

Specified by:

areIndexed in interface OIndexManagerAbstract

getClassIndexes

public Set<OIndex> getClassIndexes(ODatabaseDocumentInternal database,
 String className)

Specified by:

getClassIndexes in interface OIndexManagerAbstract

getClassIndexes

public void getClassIndexes(ODatabaseDocumentInternal database,
 String className,
 Collection<OIndex> indexes)

Specified by:

getClassIndexes in interface OIndexManagerAbstract

getClassRawIndexes

public void getClassRawIndexes(String className,
 Collection<OIndex> indexes)

Specified by:

getClassRawIndexes in interface OIndexManagerAbstract

getClassUniqueIndex

public OIndexUnique getClassUniqueIndex(String className)

Specified by:

getClassUniqueIndex in interface OIndexManagerAbstract

getClassIndex

public OIndex getClassIndex(ODatabaseDocumentInternal database,
 String className,
 String indexName)

Specified by:

getClassIndex in interface OIndexManagerAbstract

getClassAutoShardingIndex

public OIndex getClassAutoShardingIndex(ODatabaseDocumentInternal database,
 String className)

Specified by:

getClassAutoShardingIndex in interface OIndexManagerAbstract

acquireExclusiveLock

protected void acquireExclusiveLock()

releaseExclusiveLock

protected void releaseExclusiveLock()

releaseExclusiveLock

protected void releaseExclusiveLock(ODatabaseDocumentInternal database,
 boolean save)

createIndex

public OIndex createIndex(ODatabaseDocumentInternal database,
 String iName,
 String iType,
 OIndexDefinition indexDefinition,
 int[] clusterIdsToIndex,
 OProgressListener progressListener,
 ODocument metadata)

Create a new index with default algorithm.

Specified by:

createIndex in interface OIndexManagerAbstract

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(ODatabaseDocumentInternal database,
 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.

Specified by:

createIndex in interface OIndexManagerAbstract

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 void dropIndex(ODatabaseDocumentInternal database,
 String iIndexName)

Specified by:

dropIndex in interface OIndexManagerAbstract

toStream

public ODocument toStream()

Binds POJO to ODocument.

Specified by:

toStream in interface OIndexManagerAbstract

recreateIndexes

public void recreateIndexes(ODatabaseDocumentInternal database)

Specified by:

recreateIndexes in interface OIndexManagerAbstract

waitTillIndexRestore

public void waitTillIndexRestore()

Specified by:

waitTillIndexRestore in interface OIndexManagerAbstract

autoRecreateIndexesAfterCrash

public boolean autoRecreateIndexesAfterCrash(ODatabaseDocumentInternal database)

Specified by:

autoRecreateIndexesAfterCrash in interface OIndexManagerAbstract

fromStream

protected boolean fromStream(ODocument document)

removeClassPropertyIndex

public void removeClassPropertyIndex(OIndex idx)

Specified by:

removeClassPropertyIndex in interface OIndexManagerAbstract

toNetworkStream

public ODocument toNetworkStream()

preProcessBeforeReturn

public OIndex preProcessBeforeReturn(ODatabaseDocumentInternal database,
 OIndex index)

Specified by:

preProcessBeforeReturn in interface OIndexManagerAbstract

getStorage

protected OStorage getStorage()

getDocument

public ODocument getDocument()

Specified by:

getDocument in interface OIndexManagerAbstract