com.orientechnologies.spatial.engine

Class OLuceneSpatialIndexEngineAbstract

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

com.orientechnologies.common.concur.resource.OSharedResourceAdaptiveExternal

com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

com.orientechnologies.spatial.engine.OLuceneSpatialIndexEngineAbstract

All Implemented Interfaces:

OSharedResource, OLuceneIndexEngine, OBaseIndexEngine, OIndexEngine, OFreezableStorageComponent, OLuceneSpatialIndexContainer

Direct Known Subclasses:

OLuceneGeoSpatialIndexEngine, OLuceneLegacySpatialIndexEngine

public abstract class OLuceneSpatialIndexEngineAbstract
extends OLuceneIndexEngineAbstract
implements OLuceneSpatialIndexContainer

Created by Enrico Risa on 26/09/15.

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

Modifier and Type	Field and Description
protected org.locationtech.spatial4j.context.SpatialContext	ctx
protected OShapeBuilder	factory
protected SpatialQueryBuilder	queryStrategy
protected org.apache.lucene.spatial.SpatialStrategy	strategy
protected OSpatialStrategyFactory	strategyFactory

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

KEY, metadata, name, RID, version

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

VERSION

Constructor Summary

Constructors

Constructor and Description
OLuceneSpatialIndexEngineAbstract(OStorage storage, String indexName, OShapeBuilder factory)

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 query)
boolean	contains(Object key)
org.apache.lucene.index.IndexWriter	createIndexWriter(org.apache.lucene.store.Directory directory)
protected abstract org.apache.lucene.spatial.SpatialStrategy	createSpatialStrategy(OIndexDefinition indexDefinition, ODocument metadata)
OIndexCursor	cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)
Object	getFirstKey()
Object	getLastKey()
boolean	hasRangeQuerySupport()
void	init(String indexName, String indexType, OIndexDefinition indexDefinition, boolean isAutomatic, ODocument metadata)
OIndexCursor	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, OBaseIndexEngine.ValuesTransformer transformer)
OIndexKeyCursor	keyCursor()
protected org.apache.lucene.document.Document	newGeoDocument(OIdentifiable oIdentifiable, org.locationtech.spatial4j.shape.Shape shape)
boolean	remove(OAtomicOperation atomicOperation, Object key)
org.apache.lucene.spatial.SpatialStrategy	strategy()

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

acquireAtomicExclusiveLock, addDocument, buildTxChanges, clear, close, create, delete, deleteQuery, deleteWithoutLoad, descCursor, flush, freeze, getDatabase, getIndexNameByKey, getName, getVersion, indexAnalyzer, indexName, isCollectionIndex, load, onRecordAddedToResultSet, openIfClosed, queryAnalyzer, release, release, remove, searcher, size, sizeInTx, 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.spatial.engine.OLuceneSpatialIndexContainer

isLegacy, searcher

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

getInTx

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

getEngineAPIVersion, put, update, validatedPut

Methods inherited from interface com.orientechnologies.orient.core.index.engine.OBaseIndexEngine

get

Field Detail

factory

protected final OShapeBuilder factory

ctx

protected org.locationtech.spatial4j.context.SpatialContext ctx

strategy

protected org.apache.lucene.spatial.SpatialStrategy strategy

strategyFactory

protected OSpatialStrategyFactory strategyFactory

queryStrategy

protected SpatialQueryBuilder queryStrategy

Constructor Detail

OLuceneSpatialIndexEngineAbstract

public OLuceneSpatialIndexEngineAbstract(OStorage storage,
                                         String indexName,
                                         OShapeBuilder factory)

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

createSpatialStrategy

protected abstract org.apache.lucene.spatial.SpatialStrategy createSpatialStrategy(OIndexDefinition indexDefinition,
                                                                                   ODocument metadata)

createIndexWriter

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

Specified by:

createIndexWriter in class OLuceneIndexEngineAbstract

Throws:

IOException

contains

public boolean contains(Object key)

Specified by:

contains in interface OBaseIndexEngine

remove

public boolean remove(OAtomicOperation atomicOperation,
                      Object key)

Specified by:

remove in interface OBaseIndexEngine

getFirstKey

public Object getFirstKey()

Specified by:

getFirstKey in interface OBaseIndexEngine

getLastKey

public Object getLastKey()

Specified by:

getLastKey in interface OBaseIndexEngine

iterateEntriesBetween

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

Specified by:

iterateEntriesBetween in interface OBaseIndexEngine

iterateEntriesMajor

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

Specified by:

iterateEntriesMajor in interface OBaseIndexEngine

iterateEntriesMinor

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

Specified by:

iterateEntriesMinor in interface OBaseIndexEngine

cursor

public OIndexCursor cursor(OBaseIndexEngine.ValuesTransformer valuesTransformer)

Specified by:

cursor in interface OBaseIndexEngine

Overrides:

cursor in class OLuceneIndexEngineAbstract

keyCursor

public OIndexKeyCursor keyCursor()

Specified by:

keyCursor in interface OBaseIndexEngine

Overrides:

keyCursor in class OLuceneIndexEngineAbstract

hasRangeQuerySupport

public boolean hasRangeQuerySupport()

Specified by:

hasRangeQuerySupport in interface OBaseIndexEngine

newGeoDocument

protected org.apache.lucene.document.Document newGeoDocument(OIdentifiable oIdentifiable,
                                                             org.locationtech.spatial4j.shape.Shape shape)

buildDocument

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

Specified by:

buildDocument in interface OLuceneIndexEngine

buildQuery

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

Specified by:

buildQuery in interface OLuceneIndexEngine

strategy

public org.apache.lucene.spatial.SpatialStrategy strategy()

Specified by:

strategy in interface OLuceneSpatialIndexContainer