com.orientechnologies.lucene.engine

Class OLuceneIndexEngineAbstract

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

com.orientechnologies.common.concur.resource.OSharedResourceAdaptiveExternal

com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

All Implemented Interfaces:

OSharedResource, OLuceneIndexEngine, OBaseIndexEngine, OIndexEngine, OFreezableStorageComponent

Direct Known Subclasses:

OLuceneFullTextIndexEngine, OLuceneSpatialIndexEngineAbstract

public abstract class OLuceneIndexEngineAbstract
extends OSharedResourceAdaptiveExternal
implements OLuceneIndexEngine

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 String	KEY
protected ODocument	metadata
protected String	name
static String	RID
protected org.apache.lucene.util.Version	version

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

VERSION

Constructor Summary

Constructors

Constructor and Description
OLuceneIndexEngineAbstract(OStorage storage, 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.
protected void	addDocument(org.apache.lucene.document.Document doc)
OLuceneTxChanges	buildTxChanges()
void	clear(OAtomicOperation atomicOperation)
void	close()
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)
protected abstract org.apache.lucene.index.IndexWriter	createIndexWriter(org.apache.lucene.store.Directory directory)
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.
protected ODatabaseDocumentInternal	getDatabase()
String	getIndexNameByKey(Object key)
String	getName()
int	getVersion()
org.apache.lucene.analysis.Analyzer	indexAnalyzer()
String	indexName()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
boolean	isCollectionIndex()
OIndexKeyCursor	keyCursor()
void	load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize, Map<String,String> engineProperties, OEncryption encryption)
abstract void	onRecordAddedToResultSet(OLuceneQueryContext queryContext, OContextualRecordId recordId, org.apache.lucene.document.Document ret, org.apache.lucene.search.ScoreDoc score)
protected void	openIfClosed()
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(Object key, OIdentifiable value)
org.apache.lucene.search.IndexSearcher	searcher()
long	size(OBaseIndexEngine.ValuesTransformer transformer)
long	sizeInTx(OLuceneTxChanges changes)
protected void	updateLastAccess()

Methods inherited from class com.orientechnologies.common.concur.resource.OSharedResourceAdaptiveExternal

acquireExclusiveLock, acquireSharedLock, releaseExclusiveLock, releaseSharedLock, tryAcquireExclusiveLock, tryAcquireSharedLock

Methods inherited from class com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

addUser, assertExclusiveLockHold, assertSharedLockHold, getUsers, isConcurrent, removeUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.lucene.engine.OLuceneIndexEngine

buildDocument, buildQuery, getInTx

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

getEngineAPIVersion, put, update, validatedPut

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

contains, get, getFirstKey, getLastKey, hasRangeQuerySupport, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, remove

Field Detail

RID

public static final String RID

See Also:

Constant Field Values

KEY

public static final String KEY

See Also:

Constant Field Values

name

protected String name

metadata

protected ODocument metadata

version

protected org.apache.lucene.util.Version version

Constructor Detail

OLuceneIndexEngineAbstract

public OLuceneIndexEngineAbstract(OStorage storage,
                                  String name)

Method Detail

updateLastAccess

protected void updateLastAccess()

addDocument

protected void addDocument(org.apache.lucene.document.Document doc)

init

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

Specified by:

init in interface OBaseIndexEngine

getDatabase

protected ODatabaseDocumentInternal getDatabase()

createIndexWriter

protected abstract org.apache.lucene.index.IndexWriter createIndexWriter(org.apache.lucene.store.Directory directory)
                                                                  throws IOException

Throws:

IOException

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

indexName

public String indexName()

Specified by:

indexName in interface OLuceneIndexEngine

onRecordAddedToResultSet

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

Specified by:

onRecordAddedToResultSet 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

openIfClosed

protected void openIfClosed()

isCollectionIndex

public boolean isCollectionIndex()

Specified by:

isCollectionIndex in interface OLuceneIndexEngine

searcher

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

Specified by:

searcher 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

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

clear

public void clear(OAtomicOperation atomicOperation)

Specified by:

clear in interface OBaseIndexEngine

close

public void close()

Specified by:

close in interface OBaseIndexEngine

descCursor

public OIndexCursor descCursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

descCursor in interface OBaseIndexEngine

cursor

public OIndexCursor cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

cursor 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

release

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

Specified by:

release in interface OLuceneIndexEngine

getVersion

public int getVersion()

Specified by:

getVersion in interface OBaseIndexEngine

getName

public String getName()

Specified by:

getName 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

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