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 datasources 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(OStorage storage, String name, String indexType, String algorithm, String valueContainerAlgorithm, ODocument metadata, int version)
static OBaseIndexEngine	createIndexEngine(int indexId, String name, String algorithm, String type, Boolean durableInNonTxMode, OStorage storage, int version, int apiVersion, boolean multivalue, Map<String,String> indexProperties)
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 void	registerFactory(OIndexFactory factory) Register at runtime custom factories
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

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(OStorage storage,
                                         String name,
                                         String indexType,
                                         String algorithm,
                                         String valueContainerAlgorithm,
                                         ODocument metadata,
                                         int version)
                                  throws OConfigurationException,
                                         OIndexException

Parameters:

storage - TODO

indexType - index type

Returns:

OIndexInternal

Throws:

OConfigurationException - if index creation failed

OIndexException - if index type does not exist

createIndexEngine

public static OBaseIndexEngine createIndexEngine(int indexId,
                                                 String name,
                                                 String algorithm,
                                                 String type,
                                                 Boolean durableInNonTxMode,
                                                 OStorage storage,
                                                 int version,
                                                 int apiVersion,
                                                 boolean multivalue,
                                                 Map<String,String> indexProperties)

chooseDefaultIndexAlgorithm

public static String chooseDefaultIndexAlgorithm(String type)

registerFactory

public static void registerFactory(OIndexFactory factory)

Register at runtime custom factories

unregisterFactory

public static void unregisterFactory(OIndexFactory factory)

Unregister custom factories