com.orientechnologies.orient.core.index

Class OIndexes

java.lang.Object

com.orientechnologies.orient.core.index.OIndexes

public final class OIndexes
extends Object

Utility class to create indexes. New OIndexFactory can be registered

In order to be detected, factories must implement the OIndexFactory interface.

In addition to implementing this interface datasouces should have a services file:
META-INF/services/com.orientechnologies.orient.core.index.OIndexFactory

The file should contain a single line which gives the full name of the implementing class.

Example:
org.mycompany.index.MyIndexFactory

Author:

Johann Sorel (Geomatys)

Method Summary

Modifier and Type	Method and Description
static String	chooseDefaultIndexAlgorithm(String type)
static OIndexInternal<?>	createIndex(ODatabaseDocumentInternal database, String name, String indexType, String algorithm, String valueContainerAlgorithm, ODocument metadata, int version)
static OIndexEngine	createIndexEngine(String name, String algorithm, String type, Boolean durableInNonTxMode, OStorage storage, int version, Map<String,String> indexProperties, ODocument metadata)
static OIndexFactory	findFactoryByAlgorithmAndType(String algorithm, String indexType)
static Iterator<OIndexFactory>	getAllFactories()
static OIndexFactory	getFactory(String indexType, String algorithm)
static Set<String>	getIndexEngines() Iterates on all factories and append all index engines.
static Set<String>	getIndexTypes() Iterates on all factories and append all index types.
static void	registerFactory(OIndexFactory factory) Register at runtime custom factories
static void	scanForPlugins() Scans for factory plug-ins on the application class path.
static void	unregisterFactory(OIndexFactory factory) Unregister custom factories

Methods inherited from class java.lang.Object

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

Method Detail

getAllFactories

public static Iterator<OIndexFactory> getAllFactories()

Returns:

Iterator of all index factories

getIndexTypes

public static Set<String> getIndexTypes()

Iterates on all factories and append all index types.

Returns:

Set of all index types.

getIndexEngines

public static Set<String> getIndexEngines()

Iterates on all factories and append all index engines.

Returns:

Set of all index engines.

getFactory

public static OIndexFactory getFactory(String indexType,
                                       String algorithm)

createIndex

public static OIndexInternal<?> createIndex(ODatabaseDocumentInternal database,
                                            String name,
                                            String indexType,
                                            String algorithm,
                                            String valueContainerAlgorithm,
                                            ODocument metadata,
                                            int version)
                                     throws OConfigurationException,
                                            OIndexException

Parameters:

database -

name -

indexType - index type

algorithm -

valueContainerAlgorithm -

Returns:

OIndexInternal

Throws:

OConfigurationException - if index creation failed

OIndexException - if index type does not exist

findFactoryByAlgorithmAndType

public static OIndexFactory findFactoryByAlgorithmAndType(String algorithm,
                                                          String indexType)

createIndexEngine

public static OIndexEngine createIndexEngine(String name,
                                             String algorithm,
                                             String type,
                                             Boolean durableInNonTxMode,
                                             OStorage storage,
                                             int version,
                                             Map<String,String> indexProperties,
                                             ODocument metadata)

chooseDefaultIndexAlgorithm

public static String chooseDefaultIndexAlgorithm(String type)

scanForPlugins

public static void scanForPlugins()

Scans for factory plug-ins on the application class path. This method is needed because the application class path can theoretically change, or additional plug-ins may become available. Rather than re-scanning the classpath on every invocation of the API, the class path is scanned automatically only on the first invocation. Clients can call this method to prompt a re-scan. Thus this method need only be invoked by sophisticated applications which dynamically make new plug-ins available at runtime.

registerFactory

public static void registerFactory(OIndexFactory factory)

Register at runtime custom factories

Parameters:

factory -

unregisterFactory

public static void unregisterFactory(OIndexFactory factory)

Unregister custom factories

Parameters:

factory -