com.orientechnologies.orient.core.index.engine

Class ORemoteIndexEngine

java.lang.Object

com.orientechnologies.orient.core.index.engine.ORemoteIndexEngine

All Implemented Interfaces:

OIndexEngine

public class ORemoteIndexEngine
extends Object
implements OIndexEngine

Since:

18.07.13

Author:

Andrey Lomakin

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.index.OIndexEngine

OIndexEngine.Validator<K,V>, OIndexEngine.ValuesTransformer

Constructor Summary

Constructors

Constructor and Description
ORemoteIndexEngine(String name)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ORemoteIndexEngine

public ORemoteIndexEngine(String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface OIndexEngine

getIndexNameByKey

public String getIndexNameByKey(Object key)

Specified by:

getIndexNameByKey in interface OIndexEngine

init

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

Specified by:

init in interface OIndexEngine

flush

public void flush()

Specified by:

flush in interface OIndexEngine

create

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

Specified by:

create in interface OIndexEngine

deleteWithoutLoad

public void deleteWithoutLoad(String indexName)

Specified by:

deleteWithoutLoad in interface OIndexEngine

delete

public void delete()

Specified by:

delete in interface OIndexEngine

load

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

Specified by:

load in interface OIndexEngine

contains

public boolean contains(Object key)

Specified by:

contains in interface OIndexEngine

remove

public boolean remove(Object key)

Specified by:

remove in interface OIndexEngine

clear

public void clear()

Specified by:

clear in interface OIndexEngine

close

public void close()

Specified by:

close in interface OIndexEngine

get

public Object get(Object key)

Specified by:

get in interface OIndexEngine

put

public void put(Object key,
                Object value)

Specified by:

put in interface OIndexEngine

validatedPut

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

Description copied from interface: OIndexEngine

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

Specified by:

validatedPut in interface OIndexEngine

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

public Object getFirstKey()

Specified by:

getFirstKey in interface OIndexEngine

getLastKey

public Object getLastKey()

Specified by:

getLastKey in interface OIndexEngine

iterateEntriesBetween

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

Specified by:

iterateEntriesBetween in interface OIndexEngine

iterateEntriesMajor

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

Specified by:

iterateEntriesMajor in interface OIndexEngine

iterateEntriesMinor

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

Specified by:

iterateEntriesMinor in interface OIndexEngine

size

public long size(OIndexEngine.ValuesTransformer transformer)

Specified by:

size in interface OIndexEngine

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport in interface OIndexEngine

cursor

public OIndexCursor cursor(OIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

cursor in interface OIndexEngine

descCursor

public OIndexCursor descCursor(OIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

descCursor in interface OIndexEngine

keyCursor

public OIndexKeyCursor keyCursor()

Specified by:

keyCursor in interface OIndexEngine

getVersion

public int getVersion()

Specified by:

getVersion in interface OIndexEngine

acquireAtomicExclusiveLock

public boolean acquireAtomicExclusiveLock(Object key)

Description copied from interface: OIndexEngine

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.

Specified by:

acquireAtomicExclusiveLock in interface OIndexEngine

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.