com.orientechnologies.orient.core.index

Class OIndexManagerAbstract

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

com.orientechnologies.orient.core.type.ODocumentWrapperNoClass

com.orientechnologies.orient.core.index.OIndexManagerAbstract

All Implemented Interfaces:

OCloseable, Serializable

Direct Known Subclasses:

OIndexManagerRemote, OIndexManagerShared

public abstract class OIndexManagerAbstract
extends ODocumentWrapperNoClass
implements OCloseable

Abstract class to manage indexes.

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<OMultiKey,Set<OIndex>>>	classPropertyIndex
static String	CONFIG_INDEXES
protected String	defaultClusterName
static String	DICTIONARY_NAME
protected Map<String,OIndex>	indexes
protected String	manualClusterName

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

document

Constructor Summary

Constructors

Constructor and Description
OIndexManagerAbstract()

Method Summary

Modifier and Type	Method and Description
protected void	acquireExclusiveLock()
void	addClusterToIndex(String clusterName, String indexName)
boolean	areIndexed(String className, Collection<String> fields)
boolean	areIndexed(String className, String... fields)
abstract boolean	autoRecreateIndexesAfterCrash(ODatabaseDocumentInternal database)
void	close() Closes resources inside of call of OStorage#close().
void	create()
void	create(ODatabaseDocumentInternal database)
abstract OIndex	createIndex(ODatabaseDocumentInternal database, String iName, String iType, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata)
abstract OIndex	createIndex(ODatabaseDocumentInternal database, String iName, String iType, OIndexDefinition indexDefinition, int[] clusterIdsToIndex, OProgressListener progressListener, ODocument metadata, String algorithm)
abstract void	dropIndex(ODatabaseDocumentInternal database, String iIndexName)
boolean	existsIndex(String iName)
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, Collection<String> fields)
Set<OIndex>	getClassInvolvedIndexes(ODatabaseDocumentInternal database, String className, String... fields)
void	getClassRawIndexes(String className, Collection<OIndex> indexes)
OIndexUnique	getClassUniqueIndex(String className)
ODocument	getConfiguration()
protected static ODatabaseDocumentInternal	getDatabase()
String	getDefaultClusterName()
ODictionary<ORecord>	getDictionary(ODatabaseDocumentInternal database)
OIndex	getIndex(ODatabaseDocumentInternal database, String iName)
Collection<? extends OIndex>	getIndexes(ODatabaseDocumentInternal database)
OIndex	getRawIndex(String iName)
protected abstract OStorage	getStorage()
void	load()
OIndexManagerAbstract	load(ODatabaseDocumentInternal database)
abstract OIndex	preProcessBeforeReturn(ODatabaseDocumentInternal database, OIndex index)
abstract void	recreateIndexes(ODatabaseDocumentInternal database)
protected void	releaseExclusiveLock()
OIndexManagerAbstract	reload()
abstract void	removeClassPropertyIndex(OIndex idx)
void	removeClusterFromIndex(String clusterName, String indexName)
<RET extends ODocumentWrapper> RET	save()
void	setDefaultClusterName(ODatabaseDocumentInternal database, String defaultClusterName)
abstract void	waitTillIndexRestore()

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

fromStream, fromStream, reload, save

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_INDEXES

public static final String CONFIG_INDEXES

See Also:

Constant Field Values

DICTIONARY_NAME

public static final String DICTIONARY_NAME

See Also:

Constant Field Values

classPropertyIndex

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

indexes

protected Map<String,OIndex> indexes

defaultClusterName

protected String defaultClusterName

manualClusterName

protected String manualClusterName

Constructor Detail

OIndexManagerAbstract

public OIndexManagerAbstract()

Method Detail

recreateIndexes

public abstract void recreateIndexes(ODatabaseDocumentInternal database)

load

public void load()

Overrides:

load in class ODocumentWrapperNoClass

load

public OIndexManagerAbstract load(ODatabaseDocumentInternal database)

reload

public OIndexManagerAbstract reload()

Overrides:

reload in class ODocumentWrapperNoClass

save

public <RET extends ODocumentWrapper> RET save()

Overrides:

save in class ODocumentWrapperNoClass

create

public void create()

autoRecreateIndexesAfterCrash

public abstract boolean autoRecreateIndexesAfterCrash(ODatabaseDocumentInternal database)

create

public void create(ODatabaseDocumentInternal database)

getIndexes

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

getRawIndex

public OIndex getRawIndex(String iName)

getIndex

public OIndex getIndex(ODatabaseDocumentInternal database,
                       String iName)

addClusterToIndex

public void addClusterToIndex(String clusterName,
                              String indexName)

removeClusterFromIndex

public void removeClusterFromIndex(String clusterName,
                                   String indexName)

existsIndex

public boolean existsIndex(String iName)

getDefaultClusterName

public String getDefaultClusterName()

setDefaultClusterName

public void setDefaultClusterName(ODatabaseDocumentInternal database,
                                  String defaultClusterName)

getDictionary

public ODictionary<ORecord> getDictionary(ODatabaseDocumentInternal database)

getConfiguration

public ODocument getConfiguration()

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)

getClassInvolvedIndexes

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

areIndexed

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

areIndexed

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

getClassIndexes

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

getClassIndexes

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

getClassRawIndexes

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

getClassUniqueIndex

public OIndexUnique getClassUniqueIndex(String className)

getClassIndex

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

getClassAutoShardingIndex

public OIndex getClassAutoShardingIndex(ODatabaseDocumentInternal database,
                                        String className)

acquireExclusiveLock

protected void acquireExclusiveLock()

releaseExclusiveLock

protected void releaseExclusiveLock()

getDatabase

protected static ODatabaseDocumentInternal getDatabase()

getStorage

protected abstract OStorage getStorage()

preProcessBeforeReturn

public abstract OIndex preProcessBeforeReturn(ODatabaseDocumentInternal database,
                                              OIndex index)

createIndex

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

createIndex

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

waitTillIndexRestore

public abstract void waitTillIndexRestore()

removeClassPropertyIndex

public abstract void removeClassPropertyIndex(OIndex idx)

dropIndex

public abstract void dropIndex(ODatabaseDocumentInternal database,
                               String iIndexName)