com.orientechnologies.spatial.engine

Class OLuceneSpatialIndexEngineDelegator

java.lang.Object

com.orientechnologies.spatial.engine.OLuceneSpatialIndexEngineDelegator

All Implemented Interfaces:

OLuceneIndexEngine, OBaseIndexEngine, OIndexEngine, OFreezableStorageComponent, OLuceneSpatialIndexContainer

public class OLuceneSpatialIndexEngineDelegator
extends Object
implements OLuceneIndexEngine, OLuceneSpatialIndexContainer

Created by Enrico Risa on 04/09/15.

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 inherited from interface com.orientechnologies.orient.core.index.engine.OIndexEngine

VERSION

Constructor Summary

Constructors

Constructor and Description
OLuceneSpatialIndexEngineDelegator(String name, Boolean durableInNonTxMode, OStorage storage, 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.
org.apache.lucene.document.Document	buildDocument(Object key, OIdentifiable value)
org.apache.lucene.search.Query	buildQuery(Object query)
OLuceneTxChanges	buildTxChanges()
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)
org.apache.lucene.search.Query	deleteQuery(Object key, OIdentifiable value)
void	deleteWithoutLoad(OAtomicOperation atomicOperation, String indexName)
OIndexCursor	descCursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)
void	flush()
void	freeze(boolean throwException) After this method finished it's execution, all threads that are going to perform data modifications in storage should wait till OFreezableStorageComponent.release() method will be called.
Object	get(Object key)
OLuceneIndexEngine	getDelegate()
Object	getFirstKey()
String	getIndexNameByKey(Object key)
Set<OIdentifiable>	getInTx(Object key, OLuceneTxChanges changes)
Object	getLastKey()
String	getName()
int	getVersion()
boolean	hasRangeQuerySupport()
org.apache.lucene.analysis.Analyzer	indexAnalyzer()
String	indexName()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
boolean	isCollectionIndex()
boolean	isLegacy()
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	onRecordAddedToResultSet(OLuceneQueryContext queryContext, OContextualRecordId recordId, org.apache.lucene.document.Document ret, org.apache.lucene.search.ScoreDoc score)
void	put(OAtomicOperation atomicOperation, Object key, Object value)
org.apache.lucene.analysis.Analyzer	queryAnalyzer()
void	release() After this method finished execution all threads that are waiting to perform data modifications in storage will be awaken and will be allowed to continue their execution.
void	release(org.apache.lucene.search.IndexSearcher searcher)
boolean	remove(OAtomicOperation atomicOperation, Object key)
boolean	remove(Object key, OIdentifiable value)
org.apache.lucene.search.IndexSearcher	searcher()
long	size(OBaseIndexEngine.ValuesTransformer transformer)
long	sizeInTx(OLuceneTxChanges changes)
org.apache.lucene.spatial.SpatialStrategy	strategy()
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

Constructor Detail

OLuceneSpatialIndexEngineDelegator

public OLuceneSpatialIndexEngineDelegator(String name,
                                          Boolean durableInNonTxMode,
                                          OStorage storage,
                                          int version)

Method Detail

init

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

Specified by:

init in interface OBaseIndexEngine

flush

public void flush()

Specified by:

flush in interface OBaseIndexEngine

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

delete

public void delete(OAtomicOperation atomicOperation)

Specified by:

delete in interface OBaseIndexEngine

deleteWithoutLoad

public void deleteWithoutLoad(OAtomicOperation atomicOperation,
                              String indexName)

Specified by:

deleteWithoutLoad 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

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)

getFirstKey

public Object getFirstKey()

Specified by:

getFirstKey in interface OBaseIndexEngine

getLastKey

public Object getLastKey()

Specified by:

getLastKey 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

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

size

public long size(OBaseIndexEngine.ValuesTransformer transformer)

Specified by:

size in interface OBaseIndexEngine

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport in interface OBaseIndexEngine

getVersion

public int getVersion()

Specified by:

getVersion in interface OBaseIndexEngine

getName

public String getName()

Specified by:

getName in interface OBaseIndexEngine

indexName

public String indexName()

Specified by:

indexName in interface OLuceneIndexEngine

onRecordAddedToResultSet

public void onRecordAddedToResultSet(OLuceneQueryContext queryContext,
                                     OContextualRecordId recordId,
                                     org.apache.lucene.document.Document ret,
                                     org.apache.lucene.search.ScoreDoc score)

Specified by:

onRecordAddedToResultSet in interface OLuceneIndexEngine

buildDocument

public org.apache.lucene.document.Document buildDocument(Object key,
                                                         OIdentifiable value)

Specified by:

buildDocument in interface OLuceneIndexEngine

buildQuery

public org.apache.lucene.search.Query buildQuery(Object query)

Specified by:

buildQuery in interface OLuceneIndexEngine

indexAnalyzer

public org.apache.lucene.analysis.Analyzer indexAnalyzer()

Specified by:

indexAnalyzer in interface OLuceneIndexEngine

queryAnalyzer

public org.apache.lucene.analysis.Analyzer queryAnalyzer()

Specified by:

queryAnalyzer in interface OLuceneIndexEngine

remove

public boolean remove(Object key,
                      OIdentifiable value)

Specified by:

remove in interface OLuceneIndexEngine

searcher

public org.apache.lucene.search.IndexSearcher searcher()

Specified by:

searcher in interface OLuceneIndexEngine

Specified by:

searcher in interface OLuceneSpatialIndexContainer

release

public void release(org.apache.lucene.search.IndexSearcher searcher)

Specified by:

release in interface OLuceneIndexEngine

strategy

public org.apache.lucene.spatial.SpatialStrategy strategy()

Specified by:

strategy in interface OLuceneSpatialIndexContainer

isLegacy

public boolean isLegacy()

Specified by:

isLegacy in interface OLuceneSpatialIndexContainer

getInTx

public Set<OIdentifiable> getInTx(Object key,
                                  OLuceneTxChanges changes)

Specified by:

getInTx in interface OLuceneIndexEngine

sizeInTx

public long sizeInTx(OLuceneTxChanges changes)

Specified by:

sizeInTx in interface OLuceneIndexEngine

buildTxChanges

public OLuceneTxChanges buildTxChanges()
                                throws IOException

Specified by:

buildTxChanges in interface OLuceneIndexEngine

Throws:

IOException

deleteQuery

public org.apache.lucene.search.Query deleteQuery(Object key,
                                                  OIdentifiable value)

Specified by:

deleteQuery in interface OLuceneIndexEngine

isCollectionIndex

public boolean isCollectionIndex()

Specified by:

isCollectionIndex in interface OLuceneIndexEngine

freeze

public void freeze(boolean throwException)

Description copied from interface: OFreezableStorageComponent

After this method finished it's execution, all threads that are going to perform data modifications in storage should wait till OFreezableStorageComponent.release() method will be called. This method will wait till all ongoing modifications will be finished.

Specified by:

freeze in interface OFreezableStorageComponent

Parameters:

throwException - If true OModificationOperationProhibitedException exception will be thrown on call of methods that requires storage modification. Otherwise other threads will wait for OFreezableStorageComponent.release() method call.

release

public void release()

Description copied from interface: OFreezableStorageComponent

After this method finished execution all threads that are waiting to perform data modifications in storage will be awaken and will be allowed to continue their execution.

Specified by:

release in interface OFreezableStorageComponent

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

getDelegate

public OLuceneIndexEngine getDelegate()