com.orientechnologies.orient.core.index

Interface OIndexEngine

All Known Subinterfaces:

OLuceneIndexEngine

All Known Implementing Classes:

OAutoShardingIndexEngine, OHashTableIndexEngine, OLuceneFullTextIndexEngine, OLuceneIndexEngineAbstract, ORemoteIndexEngine, OSBTreeIndexEngine

public interface OIndexEngine

Since:

6/29/13

Author:

Andrey Lomakin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OIndexEngine.Validator<K,V> Put operation validator.
static interface	OIndexEngine.ValuesTransformer

Method Summary

Modifier and Type	Method and Description
boolean	acquireAtomicExclusiveLock(Object key) Acquires exclusive lock in the active atomic operation running on the current thread for this index engine.
void	clear()
void	close()
boolean	contains(Object key)
void	create(OBinarySerializer valueSerializer, boolean isAutomatic, OType[] keyTypes, boolean nullPointerSupport, OBinarySerializer keySerializer, int keySize, Set<String> clustersToIndex, Map<String,String> engineProperties, ODocument metadata)
OIndexCursor	cursor(OIndexEngine.ValuesTransformer valuesTransformer)
void	delete()
void	deleteWithoutLoad(String indexName)
OIndexCursor	descCursor(OIndexEngine.ValuesTransformer valuesTransformer)
void	flush()
Object	get(Object key)
Object	getFirstKey()
String	getIndexNameByKey(Object key)
Object	getLastKey()
String	getName()
int	getVersion()
boolean	hasRangeQuerySupport()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
OIndexCursor	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)
OIndexKeyCursor	keyCursor()
void	load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize, Map<String,String> engineProperties)
void	put(Object key, Object value)
boolean	remove(Object key)
long	size(OIndexEngine.ValuesTransformer transformer)
boolean	validatedPut(Object key, OIdentifiable value, OIndexEngine.Validator<Object,OIdentifiable> validator) Puts the given value under the given key into this index engine.

Method Detail

init

void init(String indexName,
          String indexType,
          OIndexDefinition indexDefinition,
          boolean isAutomatic,
          ODocument metadata)

flush

void flush()

create

void create(OBinarySerializer valueSerializer,
            boolean isAutomatic,
            OType[] keyTypes,
            boolean nullPointerSupport,
            OBinarySerializer keySerializer,
            int keySize,
            Set<String> clustersToIndex,
            Map<String,String> engineProperties,
            ODocument metadata)

delete

void delete()

deleteWithoutLoad

void deleteWithoutLoad(String indexName)

load

void load(String indexName,
          OBinarySerializer valueSerializer,
          boolean isAutomatic,
          OBinarySerializer keySerializer,
          OType[] keyTypes,
          boolean nullPointerSupport,
          int keySize,
          Map<String,String> engineProperties)

contains

boolean contains(Object key)

remove

boolean remove(Object key)

clear

void clear()

close

void close()

get

Object get(Object key)

put

void put(Object key,
         Object value)

validatedPut

boolean validatedPut(Object key,
                     OIdentifiable value,
                     OIndexEngine.Validator<Object,OIdentifiable> validator)

Puts the given value under the given key into this index engine. Validates the operation using the provided validator.

Parameters:

key - the key to put the value under.

value - the value to put.

validator - the operation validator.

Returns:

true if the validator allowed the put, false otherwise.

See Also:

OIndexEngine.Validator.validate(Object, Object, Object)

getFirstKey

Object getFirstKey()

getLastKey

Object getLastKey()

iterateEntriesBetween

OIndexCursor iterateEntriesBetween(Object rangeFrom,
                                   boolean fromInclusive,
                                   Object rangeTo,
                                   boolean toInclusive,
                                   boolean ascSortOrder,
                                   OIndexEngine.ValuesTransformer transformer)

iterateEntriesMajor

OIndexCursor iterateEntriesMajor(Object fromKey,
                                 boolean isInclusive,
                                 boolean ascSortOrder,
                                 OIndexEngine.ValuesTransformer transformer)

iterateEntriesMinor

OIndexCursor iterateEntriesMinor(Object toKey,
                                 boolean isInclusive,
                                 boolean ascSortOrder,
                                 OIndexEngine.ValuesTransformer transformer)

cursor

OIndexCursor cursor(OIndexEngine.ValuesTransformer valuesTransformer)

descCursor

OIndexCursor descCursor(OIndexEngine.ValuesTransformer valuesTransformer)

keyCursor

OIndexKeyCursor keyCursor()

size

long size(OIndexEngine.ValuesTransformer transformer)

hasRangeQuerySupport

boolean hasRangeQuerySupport()

getVersion

int getVersion()

getName

String getName()

acquireAtomicExclusiveLock

boolean acquireAtomicExclusiveLock(Object key)

Acquires exclusive lock in the active atomic operation running on the current thread for this index engine.

If this index engine supports a more narrow locking, for example key-based sharding, it may use the provided key to infer a more narrow lock scope, but that is not a requirement.

Parameters:

key - the index key to lock.

Returns:

true if this index was locked entirely, false if this index locking is sensitive to the provided key and only some subset of this index was locked.

getIndexNameByKey

String getIndexNameByKey(Object key)