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, OIndexManager, Serializable

Direct Known Subclasses:

OIndexManagerRemote, OIndexManagerShared

public abstract class OIndexManagerAbstract
extends ODocumentWrapperNoClass
implements OIndexManager, OCloseable

Abstract class to manage indexes.

Author:

Luca Garulli (l.garulli--at--orientechnologies.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 ReadWriteLock	lock
protected String	manualClusterName

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

document

Constructor Summary

Constructors

Constructor and Description
OIndexManagerAbstract(ODatabaseDocument iDatabase)

Method Summary

Modifier and Type	Method and Description
protected void	acquireExclusiveLock()
protected void	acquireSharedLock()
void	addClusterToIndex(String clusterName, String indexName) Adds a cluster to tracked cluster list of specified index.
protected void	addIndexInternal(OIndex<?> 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)
protected void	clearMetadata()
void	close() Closes resources inside of call of OStorage#close().
protected static Map<OMultiKey,Set<OIndex<?>>>	copyPropertyMap(Map<OMultiKey,Set<OIndex<?>>> original)
void	create() Creates a document where index manager configuration is saved and creates a "dictionary" index.
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.
protected static ODatabaseDocumentInternal	getDatabase()
protected ODatabaseDocumentInternal	getDatabaseIfDefined()
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.
protected Locale	getServerLocale()
OIndexManagerAbstract	load() Load index manager data from database.
protected List<String>	normalizeFieldNames(Collection<String> fieldNames)
protected abstract OIndex<?>	preProcessBeforeReturn(OIndex<?> index)
protected void	releaseExclusiveLock()
protected void	releaseSharedLock()
<RET extends ODocumentWrapper> RET	reload()
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.
OIndexManager	setDirty()

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

fromStream, fromStream, load, reload, save

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

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

Methods inherited from class java.lang.Object

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

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

autoRecreateIndexesAfterCrash, createIndex, createIndex, dropIndex, recreateIndexes, removeClassPropertyIndex, waitTillIndexRestore

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

lock

protected ReadWriteLock lock

Constructor Detail

OIndexManagerAbstract

public OIndexManagerAbstract(ODatabaseDocument iDatabase)

Method Detail

load

public OIndexManagerAbstract load()

Description copied from interface: OIndexManager

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

Specified by:

load in interface OIndexManager

Overrides:

load in class ODocumentWrapperNoClass

Returns:

this

reload

public <RET extends ODocumentWrapper> RET reload()

Overrides:

reload in class ODocumentWrapperNoClass

save

public <RET extends ODocumentWrapper> RET save()

Description copied from interface: OIndexManager

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

Specified by:

save in interface OIndexManager

Overrides:

save in class ODocumentWrapperNoClass

create

public void create()

Description copied from interface: OIndexManager

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

Specified by:

create in interface OIndexManager

flush

public void flush()

Description copied from interface: OIndexManager

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.

Specified by:

flush in interface OIndexManager

getIndexes

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

Description copied from interface: OIndexManager

Returns all indexes registered in database.

Specified by:

getIndexes in interface OIndexManager

Returns:

list of registered indexes.

getIndex

public OIndex<?> getIndex(String iName)

Description copied from interface: OIndexManager

Index by specified name.

Specified by:

getIndex in interface OIndexManager

Parameters:

iName - name of index

Returns:

index if one registered in database or null otherwise.

addClusterToIndex

public void addClusterToIndex(String clusterName,
                              String indexName)

Description copied from interface: OIndexManager

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

Specified by:

addClusterToIndex in interface OIndexManager

Parameters:

clusterName - cluster to add.

indexName - name of index.

removeClusterFromIndex

public void removeClusterFromIndex(String clusterName,
                                   String indexName)

Description copied from interface: OIndexManager

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

Specified by:

removeClusterFromIndex in interface OIndexManager

Parameters:

clusterName - cluster to remove.

indexName - name of index.

existsIndex

public boolean existsIndex(String iName)

Description copied from interface: OIndexManager

Checks if index with specified name exists in database.

Specified by:

existsIndex in interface OIndexManager

Parameters:

iName - name of index.

Returns:

true if index with specified name exists, false otherwise.

getDefaultClusterName

public String getDefaultClusterName()

Description copied from interface: OIndexManager

IMPORTANT! Only for internal usage.

Specified by:

getDefaultClusterName in interface OIndexManager

Returns:

name of default cluster.

setDefaultClusterName

public void setDefaultClusterName(String defaultClusterName)

Description copied from interface: OIndexManager

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

Specified by:

setDefaultClusterName in interface OIndexManager

Parameters:

defaultClusterName - name of new default cluster

getDictionary

public ODictionary<ORecord> getDictionary()

Description copied from interface: OIndexManager

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

Specified by:

getDictionary in interface OIndexManager

Returns:

a dictionary

getConfiguration

public ODocument getConfiguration()

Description copied from interface: OIndexManager

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

Specified by:

getConfiguration in interface OIndexManager

Returns:

a document that used to store index configurations.

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

setDirty

public OIndexManager setDirty()

getClassInvolvedIndexes

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

Description copied from interface: OIndexManager

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.

Specified by:

getClassInvolvedIndexes in interface OIndexManager

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

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

Description copied from interface: OIndexManager

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.

Specified by:

getClassInvolvedIndexes in interface OIndexManager

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

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

Description copied from interface: OIndexManager

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.

Specified by:

areIndexed in interface OIndexManager

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

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

Specified by:

areIndexed in interface OIndexManager

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:

OIndexManager.areIndexed(String, java.util.Collection)

getClassIndexes

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

Description copied from interface: OIndexManager

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

Specified by:

getClassIndexes in interface OIndexManager

Parameters:

className - name of class which is indexed.

Returns:

a set of indexes related to specified class

getClassIndexes

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

Description copied from interface: OIndexManager

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

Specified by:

getClassIndexes in interface OIndexManager

Parameters:

className - name of class which is indexed.

indexes - Collection of indexes where to add all the indexes

getClassUniqueIndex

public OIndexUnique getClassUniqueIndex(String className)

Description copied from interface: OIndexManager

Returns the unique index for a class, if any.

Specified by:

getClassUniqueIndex in interface OIndexManager

getClassIndex

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

Description copied from interface: OIndexManager

Searches for index for a specified class with specified name.

Specified by:

getClassIndex in interface OIndexManager

Parameters:

className - name of class which is indexed.

indexName - name of index.

Returns:

an index instance or null if such does not exist.

getClassAutoShardingIndex

public OIndex<?> getClassAutoShardingIndex(String className)

Description copied from interface: OIndexManager

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

Specified by:

getClassAutoShardingIndex in interface OIndexManager

Parameters:

className - Class name

acquireSharedLock

protected void acquireSharedLock()

releaseSharedLock

protected void releaseSharedLock()

acquireExclusiveLock

protected void acquireExclusiveLock()

releaseExclusiveLock

protected void releaseExclusiveLock()

clearMetadata

protected void clearMetadata()

getDatabase

protected static ODatabaseDocumentInternal getDatabase()

getDatabaseIfDefined

protected ODatabaseDocumentInternal getDatabaseIfDefined()

addIndexInternal

protected void addIndexInternal(OIndex<?> index)

copyPropertyMap

protected static Map<OMultiKey,Set<OIndex<?>>> copyPropertyMap(Map<OMultiKey,Set<OIndex<?>>> original)

normalizeFieldNames

protected List<String> normalizeFieldNames(Collection<String> fieldNames)

preProcessBeforeReturn

protected abstract OIndex<?> preProcessBeforeReturn(OIndex<?> index)

getServerLocale

protected Locale getServerLocale()