com.orientechnologies.lucene.engine

Class OLuceneFullTextIndexEngine

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

com.orientechnologies.common.concur.resource.OSharedResourceAdaptiveExternal

com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

com.orientechnologies.lucene.engine.OLuceneFullTextIndexEngine

All Implemented Interfaces:

OSharedResource, OLuceneIndexEngine, OBaseIndexEngine, OIndexEngine, OFreezableStorageComponent

public class OLuceneFullTextIndexEngine
extends OLuceneIndexEngineAbstract

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 class com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

collectionFields, indexDefinition, KEY, metadata, name, RID, version

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

VERSION

Constructor Summary

Constructors

Constructor and Description
OLuceneFullTextIndexEngine(OStorage storage, String idxName, int id)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.document.Document	buildDocument(Object key, OIdentifiable value)
org.apache.lucene.search.Query	buildQuery(Object maybeQuery)
org.apache.lucene.index.IndexWriter	createIndexWriter(org.apache.lucene.store.Directory directory)
Object	get(Object key)
Set<OIdentifiable>	getInTx(Object key, OLuceneTxChanges changes)
boolean	hasRangeQuerySupport()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
Stream<ORawPair<Object,ORID>>	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
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)
boolean	remove(OAtomicOperation atomicOperation, Object key)
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 com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

acquireAtomicExclusiveLock, addDocument, buildTxChanges, clear, close, create, delete, deleteQuery, descStream, flush, freeze, getDatabase, getId, getIndexNameByKey, getName, indexAnalyzer, indexName, isCollectionIndex, keyStream, load, openIfClosed, queryAnalyzer, release, release, remove, searcher, size, sizeInTx, stream, 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.orient.core.index.engine.OIndexEngine

getEngineAPIVersion

Constructor Detail

OLuceneFullTextIndexEngine

public OLuceneFullTextIndexEngine(OStorage storage,
                                  String idxName,
                                  int id)

Method Detail

init

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

Specified by:

init in interface OBaseIndexEngine

Overrides:

init in class OLuceneIndexEngineAbstract

createIndexWriter

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

Specified by:

createIndexWriter in class OLuceneIndexEngineAbstract

Throws:

IOException

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

Specified by:

onRecordAddedToResultSet in class OLuceneIndexEngineAbstract

remove

public boolean remove(OAtomicOperation atomicOperation,
                      Object key)

get

public Object get(Object key)

update

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

put

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

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.

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)

iterateEntriesBetween

public Stream<ORawPair<Object,ORID>> iterateEntriesBetween(Object rangeFrom,
                                                           boolean fromInclusive,
                                                           Object rangeTo,
                                                           boolean toInclusive,
                                                           boolean ascSortOrder,
                                                           OBaseIndexEngine.ValuesTransformer transformer)

iterateEntriesMajor

public Stream<ORawPair<Object,ORID>> iterateEntriesMajor(Object fromKey,
                                                         boolean isInclusive,
                                                         boolean ascSortOrder,
                                                         OBaseIndexEngine.ValuesTransformer transformer)

iterateEntriesMinor

public Stream<ORawPair<Object,ORID>> iterateEntriesMinor(Object toKey,
                                                         boolean isInclusive,
                                                         boolean ascSortOrder,
                                                         OBaseIndexEngine.ValuesTransformer transformer)

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

buildDocument

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

buildQuery

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

getInTx

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