com.orientechnologies.orient.core.sharding.auto

Class OAutoShardingIndexEngine

java.lang.Object

com.orientechnologies.orient.core.sharding.auto.OAutoShardingIndexEngine

All Implemented Interfaces:

OBaseIndexEngine, OIndexEngine

public final class OAutoShardingIndexEngine
extends Object
implements OIndexEngine

Index engine implementation that relies on multiple hash indexes partitioned by key.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION

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(OAtomicOperation atomicOperation)
void	close()
boolean	contains(Object key)
void	create(OAtomicOperation atomicOperation, OBinarySerializer valueSerializer, boolean isAutomatic, OType[] keyTypes, boolean nullPointerSupport, OBinarySerializer keySerializer, int keySize, Set<String> clustersToIndex, Map<String,String> engineProperties, ODocument metadata, OEncryption encryption)
OIndexCursor	cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)
void	delete(OAtomicOperation atomicOperation)
void	deleteWithoutLoad(OAtomicOperation atomicOperation, String indexName)
OIndexCursor	descCursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)
void	flush()
Object	get(Object key)
Object	getFirstKey()
String	getIndexNameByKey(Object key)
Object	getLastKey()
String	getName()
OAutoShardingStrategy	getStrategy()
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, OBaseIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexKeyCursor	keyCursor()
void	load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize, Map<String,String> engineProperties, OEncryption encryption)
void	put(OAtomicOperation atomicOperation, Object key, Object value)
boolean	remove(OAtomicOperation atomicOperation, Object key)
long	size(OBaseIndexEngine.ValuesTransformer transformer)
void	update(OAtomicOperation atomicOperation, Object key, OIndexKeyUpdater<Object> updater)
boolean	validatedPut(OAtomicOperation atomicOperation, Object key, ORID value, OBaseIndexEngine.Validator<Object,ORID> 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

Methods inherited from interface com.orientechnologies.orient.core.index.engine.OIndexEngine

getEngineAPIVersion

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Specified by:

getName in interface OBaseIndexEngine

getStrategy

public OAutoShardingStrategy getStrategy()

create

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

Specified by:

create in interface OBaseIndexEngine

load

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

Specified by:

load in interface OIndexEngine

flush

public void flush()

Specified by:

flush in interface OBaseIndexEngine

deleteWithoutLoad

public void deleteWithoutLoad(OAtomicOperation atomicOperation,
                              String indexName)

Specified by:

deleteWithoutLoad in interface OBaseIndexEngine

delete

public void delete(OAtomicOperation atomicOperation)

Specified by:

delete in interface OBaseIndexEngine

init

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

Specified by:

init in interface OBaseIndexEngine

contains

public boolean contains(Object key)

Specified by:

contains in interface OBaseIndexEngine

remove

public boolean remove(OAtomicOperation atomicOperation,
                      Object key)

Specified by:

remove in interface OBaseIndexEngine

clear

public void clear(OAtomicOperation atomicOperation)

Specified by:

clear in interface OBaseIndexEngine

close

public void close()

Specified by:

close in interface OBaseIndexEngine

get

public Object get(Object key)

Specified by:

get in interface OBaseIndexEngine

put

public void put(OAtomicOperation atomicOperation,
                Object key,
                Object value)

Specified by:

put in interface OIndexEngine

update

public void update(OAtomicOperation atomicOperation,
                   Object key,
                   OIndexKeyUpdater<Object> updater)

Specified by:

update in interface OIndexEngine

validatedPut

public boolean validatedPut(OAtomicOperation atomicOperation,
                            Object key,
                            ORID value,
                            OBaseIndexEngine.Validator<Object,ORID> 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

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:

Validator#validate(Object, Object, Object)

size

public long size(OBaseIndexEngine.ValuesTransformer transformer)

Specified by:

size in interface OBaseIndexEngine

getVersion

public int getVersion()

Specified by:

getVersion in interface OBaseIndexEngine

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport in interface OBaseIndexEngine

cursor

public OIndexCursor cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

cursor in interface OBaseIndexEngine

descCursor

public OIndexCursor descCursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

descCursor in interface OBaseIndexEngine

keyCursor

public OIndexKeyCursor keyCursor()

Specified by:

keyCursor in interface OBaseIndexEngine

iterateEntriesBetween

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

Specified by:

iterateEntriesBetween in interface OBaseIndexEngine

iterateEntriesMajor

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

Specified by:

iterateEntriesMajor in interface OBaseIndexEngine

iterateEntriesMinor

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

Specified by:

iterateEntriesMinor in interface OBaseIndexEngine

getFirstKey

public Object getFirstKey()

Specified by:

getFirstKey in interface OBaseIndexEngine

getLastKey

public Object getLastKey()

Specified by:

getLastKey in interface OBaseIndexEngine

acquireAtomicExclusiveLock

public boolean acquireAtomicExclusiveLock(Object key)

Description copied from interface: OBaseIndexEngine

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 OBaseIndexEngine

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

public String getIndexNameByKey(Object key)

Specified by:

getIndexNameByKey in interface OBaseIndexEngine