OLuceneIndexEngineAbstract (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<V>

All Implemented Interfaces:

OSharedResource, OLuceneIndexEngine, OIndexEngine, OOrientListener, OOrientShutdownListener

Direct Known Subclasses:

OLuceneFullTextIndexEngine
```
public abstract class OLuceneIndexEngineAbstract<V>
extends OSharedResourceAdaptiveExternal
implements OLuceneIndexEngine, OOrientListener
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.index.OIndexEngine
  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 ODocument`	`metadata`
`protected org.apache.lucene.index.TrackingIndexWriter`	`mgrWriter`
`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`
`static String`	`STORED`
`protected org.apache.lucene.util.Version`	`version`

Constructor Summary

Constructors
Constructor and Description

OLuceneIndexEngineAbstract(String indexName)

Constructors
Constructor and Description
`OLuceneIndexEngineAbstract(String indexName)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addDocument(org.apache.lucene.document.Document doc)`
`OLuceneTxChanges`	`buildTxChanges()`
`void`	`clear()`
`void`	`close()`
`protected void`	`closeIndex()`
`protected void`	`commit()`
`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)`
`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 vValuesTransformer)`
`void`	`flush()`
`protected ODatabaseDocumentInternal`	`getDatabase()`
`protected String`	`getIndexBasePath(OLocalPaginatedStorage storageLocalAbstract)`
`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()`
`protected org.apache.lucene.document.Field.Store`	`isToStore(String f)`
`void`	`load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize, Map<String,String> engineProperties)`
`abstract void`	`onRecordAddedToResultSet(QueryContext queryContext, OContextualRecordId recordId, org.apache.lucene.document.Document ret, org.apache.lucene.search.ScoreDoc score)`
`void`	`onShutdown()`
`void`	`onStorageRegistered(OStorage storage)`
`void`	`onStorageUnregistered(OStorage storage)`
`protected abstract org.apache.lucene.index.IndexWriter`	`openIndexWriter(org.apache.lucene.store.Directory directory)`
`org.apache.lucene.analysis.Analyzer`	`queryAnalyzer()`
`protected void`	`release(org.apache.lucene.search.IndexSearcher searcher)`
`boolean`	`remove(Object key, OIdentifiable value)`
`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)`

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, cursor, get, getFirstKey, getLastKey, hasRangeQuerySupport, iterateEntriesBetween, iterateEntriesMajor, iterateEntriesMinor, keyCursor, put, 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

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

searcherManager

protected org.apache.lucene.search.SearcherManager searcherManager

index
```
protected OIndexDefinition index
```

mgrWriter

protected org.apache.lucene.index.TrackingIndexWriter mgrWriter

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

Constructor Detail

OLuceneIndexEngineAbstract

public OLuceneIndexEngineAbstract(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)

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

commit
```
protected void commit()
```

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

deleteWithoutLoad
```
public void deleteWithoutLoad(String indexName)
```
Specified by:

deleteWithoutLoad in interface OIndexEngine

internalDelete

protected void internalDelete(String indexName)

closeIndex

protected void closeIndex()
                   throws IOException

Throws:: IOException

getDatabase

protected ODatabaseDocumentInternal getDatabase()

getIndexBasePath

protected String getIndexBasePath(OLocalPaginatedStorage storageLocalAbstract)

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

Specified by:: descCursor 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

indexName
```
public String indexName()
```
Specified by:

indexName in interface OLuceneIndexEngine

onRecordAddedToResultSet

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

searcher

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

Specified by:: searcher in interface OLuceneIndexEngine
Throws:: IOException

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

isToStore

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

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

onShutdown in interface OOrientListener

Specified by:

onShutdown in interface OOrientShutdownListener

onStorageRegistered
```
public void onStorageRegistered(OStorage storage)
```
Specified by:

onStorageRegistered in interface OOrientListener

onStorageUnregistered
```
public void onStorageUnregistered(OStorage storage)
```
Specified by:

onStorageUnregistered in interface OOrientListener

Class OLuceneIndexEngineAbstract<V>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

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

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

Field Detail

RID

KEY

STORED

OLUCENE_BASE_DIR

searcherManager

index

mgrWriter

name

clusterIndexName

automatic

nrt

metadata

version

collectionFields

commitTask

closed

Constructor Detail

OLuceneIndexEngineAbstract

Method Detail

sendTotalHits

sendLookupTime

openIndexWriter

addDocument

init

commit

createIndexWriter

flush

create

delete

deleteWithoutLoad

internalDelete

closeIndex

getDatabase

getIndexBasePath

load

clear

close

descCursor

size

release

getVersion

getName

indexName

onRecordAddedToResultSet

indexAnalyzer

queryAnalyzer

remove

deleteDocument

isCollectionDelete

searcher

sizeInTx

buildTxChanges

deleteQuery

isToStore

onShutdown

onStorageRegistered

onStorageUnregistered