com.orientechnologies.lucene.engine

Class OLuceneIndexEngineAbstract<V>

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

com.orientechnologies.common.concur.resource.OSharedResourceAdaptiveExternal

com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract<V>

All Implemented Interfaces:

OSharedResource, OLuceneIndexEngine, OIndexEngine, OFreezableStorageComponent

Direct Known Subclasses:

OLuceneFullTextIndexEngine

public abstract class OLuceneIndexEngineAbstract<V>
extends OSharedResourceAdaptiveExternal
implements OLuceneIndexEngine

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	automatic
protected AtomicBoolean	closed
protected String	clusterIndexName
protected Map<String,Boolean>	collectionFields
protected TimerTask	commitTask
protected OIndexDefinition	index
static String	KEY
protected AtomicLong	lastAccess
protected ODocument	metadata
protected String	name
protected org.apache.lucene.search.ControlledRealTimeReopenThread	nrt
static String	OLUCENE_BASE_DIR
static String	RID
protected org.apache.lucene.search.SearcherManager	searcherManager
protected OStorage	storage
static String	STORED
protected org.apache.lucene.util.Version	version

Constructor Summary

Constructors

Constructor and Description
OLuceneIndexEngineAbstract(OStorage storage, String indexName)

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()
void	close()
void	create(OBinarySerializer valueSerializer, boolean isAutomatic, OType[] keyTypes, boolean nullPointerSupport, OBinarySerializer keySerializer, int keySize, Set<String> clustersToIndex, Map<String,String> engineProperties, ODocument metadata)
protected abstract org.apache.lucene.index.IndexWriter	createIndexWriter(org.apache.lucene.store.Directory directory)
OIndexCursor	cursor(OIndexEngine.ValuesTransformer valuesTransformer)
void	delete()
protected void	deleteDocument(org.apache.lucene.search.Query query)
org.apache.lucene.search.Query	deleteQuery(Object key, OIdentifiable value)
void	deleteWithoutLoad(String indexName)
OIndexCursor	descCursor(OIndexEngine.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()
protected String	getIndexBasePath(OLocalPaginatedStorage storageLocalAbstract)
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)
protected void	internalDelete(String indexName)
protected boolean	isCollectionDelete()
boolean	isCollectionIndex()
boolean	isFrozen() Returns true if the storage is frozen, otherwise false.
protected org.apache.lucene.document.Field.Store	isToStore(String f)
OIndexKeyCursor	keyCursor()
void	load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize, Map<String,String> engineProperties)
abstract void	onRecordAddedToResultSet(OLuceneQueryContext queryContext, OContextualRecordId recordId, org.apache.lucene.document.Document ret, org.apache.lucene.search.ScoreDoc score)
protected void	openIfClosed()
protected abstract org.apache.lucene.index.IndexWriter	openIndexWriter(org.apache.lucene.store.Directory directory)
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.
protected void	release(org.apache.lucene.search.IndexSearcher searcher)
boolean	remove(Object key, OIdentifiable value)
protected void	reOpen()
org.apache.lucene.search.IndexSearcher	searcher()
static void	sendLookupTime(String indexName, OCommandContext context, org.apache.lucene.search.TopDocs docs, Integer limit, long startFetching)
static void	sendTotalHits(String indexName, OCommandContext context, int totalHits)
long	size(OIndexEngine.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.OIndexEngine

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

Field Detail

RID

public static final String RID

See Also:

Constant Field Values

KEY

public static final String KEY

See Also:

Constant Field Values

STORED

public static final String STORED

See Also:

Constant Field Values

OLUCENE_BASE_DIR

public static final String OLUCENE_BASE_DIR

See Also:

Constant Field Values

lastAccess

protected final AtomicLong lastAccess

searcherManager

protected org.apache.lucene.search.SearcherManager searcherManager

index

protected OIndexDefinition index

name

protected String name

clusterIndexName

protected String clusterIndexName

automatic

protected boolean automatic

nrt

protected org.apache.lucene.search.ControlledRealTimeReopenThread nrt

metadata

protected ODocument metadata

version

protected org.apache.lucene.util.Version version

collectionFields

protected Map<String,Boolean> collectionFields

commitTask

protected TimerTask commitTask

closed

protected AtomicBoolean closed

storage

protected OStorage storage

Constructor Detail

OLuceneIndexEngineAbstract

public OLuceneIndexEngineAbstract(OStorage storage,
                                  String indexName)

Method Detail

sendTotalHits

public static void sendTotalHits(String indexName,
                                 OCommandContext context,
                                 int totalHits)

sendLookupTime

public static void sendLookupTime(String indexName,
                                  OCommandContext context,
                                  org.apache.lucene.search.TopDocs docs,
                                  Integer limit,
                                  long startFetching)

updateLastAccess

protected void updateLastAccess()

openIndexWriter

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

Throws:

IOException

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 OIndexEngine

reOpen

protected void reOpen()
               throws IOException

Throws:

IOException

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 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

delete

public void delete()

Specified by:

delete in interface OIndexEngine

indexName

public String indexName()

Specified by:

indexName in interface OLuceneIndexEngine

getIndexBasePath

protected String getIndexBasePath(OLocalPaginatedStorage storageLocalAbstract)

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

deleteDocument

protected void deleteDocument(org.apache.lucene.search.Query query)

isCollectionDelete

protected boolean isCollectionDelete()

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(String indexName)

Specified by:

deleteWithoutLoad in interface OIndexEngine

internalDelete

protected void internalDelete(String indexName)

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

clear

public void clear()

Specified by:

clear in interface OIndexEngine

close

public void close()

Specified by:

close in interface OIndexEngine

descCursor

public OIndexCursor descCursor(OIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

descCursor in interface OIndexEngine

cursor

public OIndexCursor cursor(OIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

cursor in interface OIndexEngine

keyCursor

public OIndexKeyCursor keyCursor()

Specified by:

keyCursor in interface OIndexEngine

size

public long size(OIndexEngine.ValuesTransformer transformer)

Specified by:

size in interface OIndexEngine

release

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

getVersion

public int getVersion()

Specified by:

getVersion in interface OIndexEngine

getName

public String getName()

Specified by:

getName 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.

getIndexNameByKey

public String getIndexNameByKey(Object key)

Specified by:

getIndexNameByKey in interface OIndexEngine

isToStore

protected org.apache.lucene.document.Field.Store isToStore(String f)

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

isFrozen

public boolean isFrozen()

Description copied from interface: OFreezableStorageComponent

Returns true if the storage is frozen, otherwise false.

Specified by:

isFrozen in interface OFreezableStorageComponent