OLuceneFullTextIndexEngine (OrientDB 2.2.1-SNAPSHOT API)

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, OIndexEngine, OOrientListener, OOrientShutdownListener
```
public class OLuceneFullTextIndexEngine
extends OLuceneIndexEngineAbstract
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class OLuceneFullTextIndexEngine.LuceneIndexCursor
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.index.OIndexEngine
  OIndexEngine.ValuesTransformer

Nested Classes
Modifier and Type	Class and Description
`class`	`OLuceneFullTextIndexEngine.LuceneIndexCursor`

Field Summary

Fields
Modifier and Type Field and Description

protected OLuceneFacetManager facetManager
- Fields inherited from class com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract
  automatic, closed, clusterIndexName, collectionFields, commitTask, index, KEY, metadata, mgrWriter, name, nrt, OLUCENE_BASE_DIR, RID, searcherManager, STORED, version

Fields
Modifier and Type	Field and Description
`protected OLuceneFacetManager`	`facetManager`

Constructor Summary

Constructors
Constructor and Description

OLuceneFullTextIndexEngine(String idxName, DocBuilder builder, OQueryBuilder queryBuilder)

Constructors
Constructor and Description
`OLuceneFullTextIndexEngine(String idxName, DocBuilder builder, OQueryBuilder queryBuilder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.lucene.document.Document`	`buildDocument(Object key, OIdentifiable value)`
`org.apache.lucene.search.Query`	`buildQuery(Object query)`
`boolean`	`contains(Object key)`
`org.apache.lucene.index.IndexWriter`	`createIndexWriter(org.apache.lucene.store.Directory directory)`
`OIndexCursor`	`cursor(OIndexEngine.ValuesTransformer valuesTransformer)`
`void`	`delete()`
`Object`	`get(Object key)`
`Object`	`getFirstKey()`
`Object`	`getInTx(Object key, OLuceneTxChanges changes)`
`Object`	`getLastKey()`
`int`	`getVersion()`
`boolean`	`hasRangeQuerySupport()`
`OIndexCursor`	`iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)`
`OIndexCursor`	`iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)`
`OIndexCursor`	`iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)`
`OIndexKeyCursor`	`keyCursor()`
`void`	`onRecordAddedToResultSet(QueryContext queryContext, OContextualRecordId recordId, org.apache.lucene.document.Document ret, org.apache.lucene.search.ScoreDoc score)`
`org.apache.lucene.index.IndexWriter`	`openIndexWriter(org.apache.lucene.store.Directory directory)`
`void`	`put(Object key, Object value)`
`boolean`	`remove(Object key)`

Methods inherited from class com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract
addDocument, buildTxChanges, clear, close, closeIndex, commit, create, deleteDocument, deleteQuery, deleteWithoutLoad, descCursor, flush, getDatabase, getIndexBasePath, getName, indexAnalyzer, indexName, init, internalDelete, isCollectionDelete, isToStore, load, onShutdown, onStorageRegistered, onStorageUnregistered, queryAnalyzer, release, remove, searcher, sendLookupTime, sendTotalHits, size, sizeInTx

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

Field Detail

facetManager

protected OLuceneFacetManager facetManager

Constructor Detail

OLuceneFullTextIndexEngine

public OLuceneFullTextIndexEngine(String idxName,
                                  DocBuilder builder,
                                  OQueryBuilder queryBuilder)

Method Detail

openIndexWriter

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

Specified by:: openIndexWriter in class OLuceneIndexEngineAbstract
Throws:: IOException

createIndexWriter

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

Specified by:: createIndexWriter in class OLuceneIndexEngineAbstract
Throws:: IOException

delete
```
public void delete()
```
Specified by:

delete in interface OIndexEngine

Overrides:

delete in class OLuceneIndexEngineAbstract

getVersion
```
public int getVersion()
```
Specified by:

getVersion in interface OIndexEngine

Overrides:

getVersion in class OLuceneIndexEngineAbstract

onRecordAddedToResultSet

public void onRecordAddedToResultSet(QueryContext 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

contains
```
public boolean contains(Object key)
```

remove
```
public boolean remove(Object key)
```

get
```
public Object get(Object key)
```

put

public void put(Object key,
                Object value)

getFirstKey
```
public Object getFirstKey()
```

getLastKey
```
public Object getLastKey()
```

iterateEntriesBetween

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

iterateEntriesMajor

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

iterateEntriesMinor

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

cursor

public OIndexCursor cursor(OIndexEngine.ValuesTransformer valuesTransformer)

keyCursor
```
public OIndexKeyCursor keyCursor()
```

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

getInTx

public Object getInTx(Object key,
                      OLuceneTxChanges changes)

Class OLuceneFullTextIndexEngine

Nested Class Summary

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

Field Summary

Fields inherited from class com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

Constructor Summary

Method Summary

Methods inherited from class com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

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

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

Methods inherited from class java.lang.Object

Field Detail

facetManager

Constructor Detail

OLuceneFullTextIndexEngine

Method Detail

openIndexWriter

createIndexWriter

delete

getVersion

onRecordAddedToResultSet

contains

remove

get

put

getFirstKey

getLastKey

iterateEntriesBetween

iterateEntriesMajor

iterateEntriesMinor

cursor

keyCursor

hasRangeQuerySupport

buildDocument

buildQuery

getInTx