OLuceneStorage (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.OLuceneStorage

All Implemented Interfaces:: OSharedResource, OOrientListener, OOrientShutdownListener

public class OLuceneStorage
extends OSharedResourceAdaptiveExternal
implements OOrientListener

Field Summary

Fields
Modifier and Type	Field and Description
`protected AtomicBoolean`	`closed`
`protected TimerTask`	`commitTask`
`protected OLuceneFacetManager`	`facetManager`
`protected org.apache.lucene.index.TrackingIndexWriter`	`mgrWriter`
`protected org.apache.lucene.search.ControlledRealTimeReopenThread`	`nrt`
`protected org.apache.lucene.search.SearcherManager`	`searcherManager`

Constructor Summary

Constructors
Constructor and Description

OLuceneStorage(String name, DocBuilder builder, OQueryBuilder queryBuilder, ODocument metadata)

Constructors
Constructor and Description
`OLuceneStorage(String name, DocBuilder builder, OQueryBuilder queryBuilder, ODocument metadata)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDocument(org.apache.lucene.document.Document doc)`
`OLuceneTxChanges`	`buildTxChanges()`
`void`	`clear(String indexName)`
`void`	`close()`
`protected void`	`closeIndex()`
`void`	`commit()`
`boolean`	`contains(Object key)`
`void`	`create(OBinarySerializer valueSerializer, boolean isAutomatic, OType[] keyTypes, boolean nullPointerSupport, OBinarySerializer keySerializer, int keySize)`
`org.apache.lucene.index.IndexWriter`	`createIndexWriter(org.apache.lucene.store.Directory directory)`
`OIndexCursor`	`cursor(OIndexEngine.ValuesTransformer valuesTransformer)`
`void`	`delete(ODatabaseInternal database)`
`void`	`delete(String indexName)`
`org.apache.lucene.search.Query`	`deleteQuery(String indexName, Object key, OIdentifiable value)`
`void`	`deleteWithoutLoad(String indexName)`
`OIndexCursor`	`descCursor(OIndexEngine.ValuesTransformer valuesTransformer)`
`void`	`flush()`
`Object`	`getFirstKey()`
`Object`	`getLastKey()`
`String`	`getName()`
`int`	`getVersion()`
`boolean`	`hasRangeQuerySupport()`
`org.apache.lucene.analysis.Analyzer`	`indexAnalyzer()`
`void`	`init()`
`void`	`initIndex(OLuceneClassIndexContext indexContext)`
`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`	`load(String indexName, OBinarySerializer valueSerializer, boolean isAutomatic, OBinarySerializer keySerializer, OType[] keyTypes, boolean nullPointerSupport, int keySize)`
`void`	`onShutdown()`
`void`	`onStorageRegistered(OStorage storage)`
`void`	`onStorageUnregistered(OStorage storage)`
`org.apache.lucene.analysis.Analyzer`	`queryAnalyzer()`
`boolean`	`remove(Object key)`
`boolean`	`remove(Object key, OIdentifiable value)`
`org.apache.lucene.search.IndexSearcher`	`searcher()`
`long`	`size()`
`long`	`size(OIndexEngine.ValuesTransformer transformer)`

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

commitTask
```
protected TimerTask commitTask
```

closed
```
protected AtomicBoolean closed
```

mgrWriter

protected org.apache.lucene.index.TrackingIndexWriter mgrWriter

searcherManager

protected org.apache.lucene.search.SearcherManager searcherManager

nrt

protected org.apache.lucene.search.ControlledRealTimeReopenThread nrt

Constructor Detail

OLuceneStorage

public OLuceneStorage(String name,
                      DocBuilder builder,
                      OQueryBuilder queryBuilder,
                      ODocument metadata)

Method Detail

commit
```
public void commit()
```

createIndexWriter

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

Throws:: IOException

flush
```
public void flush()
```

indexAnalyzer

public org.apache.lucene.analysis.Analyzer indexAnalyzer()

initIndex

public void initIndex(OLuceneClassIndexContext indexContext)

remove

public boolean remove(Object key,
                      OIdentifiable value)

searcher

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

Throws:: IOException

size
```
public long size()
```

buildTxChanges

public OLuceneTxChanges buildTxChanges()
                                throws IOException

Throws:: IOException

deleteQuery

public org.apache.lucene.search.Query deleteQuery(String indexName,
                                                  Object key,
                                                  OIdentifiable value)

init
```
public void init()
```

create

public void create(OBinarySerializer valueSerializer,
                   boolean isAutomatic,
                   OType[] keyTypes,
                   boolean nullPointerSupport,
                   OBinarySerializer keySerializer,
                   int keySize)

delete
```
public void delete(String indexName)
```

delete

public void delete(ODatabaseInternal database)

close
```
public void close()
```

closeIndex

protected void closeIndex()
                   throws IOException

Throws:: IOException

deleteWithoutLoad

public void deleteWithoutLoad(String indexName)

load

public void load(String indexName,
                 OBinarySerializer valueSerializer,
                 boolean isAutomatic,
                 OBinarySerializer keySerializer,
                 OType[] keyTypes,
                 boolean nullPointerSupport,
                 int keySize)

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

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

clear
```
public void clear(String indexName)
```

addDocument

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

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)

descCursor

public OIndexCursor descCursor(OIndexEngine.ValuesTransformer valuesTransformer)

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

size

public long size(OIndexEngine.ValuesTransformer transformer)

hasRangeQuerySupport
```
public boolean hasRangeQuerySupport()
```

getVersion
```
public int getVersion()
```

getName
```
public String getName()
```

queryAnalyzer

public org.apache.lucene.analysis.Analyzer queryAnalyzer()

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 OLuceneStorage

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

Field Detail

facetManager

commitTask

closed

mgrWriter

searcherManager

nrt

Constructor Detail

OLuceneStorage

Method Detail

commit

createIndexWriter

flush

indexAnalyzer

initIndex

remove

searcher

size

buildTxChanges

deleteQuery

init

create

delete

delete

close

closeIndex

deleteWithoutLoad

load

contains

remove

clear

addDocument

getFirstKey

getLastKey

iterateEntriesBetween

iterateEntriesMajor

iterateEntriesMinor

cursor

descCursor

keyCursor

size

hasRangeQuerySupport

getVersion

getName

queryAnalyzer

onShutdown

onStorageRegistered

onStorageUnregistered