Package com.orientechnologies.spatial.engine

Class OLuceneSpatialIndexEngineAbstract

java.lang.Object

com.orientechnologies.lucene.engine.OLuceneIndexEngineAbstract

com.orientechnologies.spatial.engine.OLuceneSpatialIndexEngineAbstract

All Implemented Interfaces:

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.

Field Summary

Fields

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

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	Description
OLuceneSpatialIndexEngineAbstract(OStorage storage, String indexName, int id, OShapeBuilder factory)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.document.Document	buildDocument(Object key, OIdentifiable value)
org.apache.lucene.search.Query	buildQuery(Object query)
org.apache.lucene.index.IndexWriter	createIndexWriter(org.apache.lucene.store.Directory directory)
protected abstract org.apache.lucene.spatial.SpatialStrategy	createSpatialStrategy(OIndexDefinition indexDefinition, ODocument metadata)
protected Object	decodeKey(Object key)
protected Object	encodeKey(Object key)
boolean	hasRangeQuerySupport()
void	init(OIndexMetadata im)
Stream<ORawPair<Object,ORID>>	iterateEntriesBetween(Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMajor(Object fromKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateEntriesMinor(Object toKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<Object>	keyStream()
protected org.apache.lucene.document.Document	newGeoDocument(OIdentifiable oIdentifiable, org.locationtech.spatial4j.shape.Shape shape, ODocument shapeDoc)
boolean	remove(OAtomicOperation atomicOperation, Object key)
boolean	remove(OAtomicOperation atomicOperation, Object key, ORID value)
org.apache.lucene.spatial.SpatialStrategy	strategy()
Stream<ORawPair<Object,ORID>>	stream(IndexEngineValuesTransformer valuesTransformer)

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, load, onRecordAddedToResultSet, openIfClosed, queryAnalyzer, release, release, remove, remove, searcher, size, sizeInTx, updateLastAccess

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.OBaseIndexEngine

applyTxChanges, getUniqueIndexVersion, hasRidBagTreesSupport, updateUniqueIndexVersion

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

get, getEngineAPIVersion, put, put, update, validatedPut

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

getInTx

Methods inherited from interface com.orientechnologies.spatial.engine.OLuceneSpatialIndexContainer

isLegacy, searcher

Field Details

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 Details

OLuceneSpatialIndexEngineAbstract

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

Method Details

init

public void init(OIndexMetadata im)

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

remove

public boolean remove(OAtomicOperation atomicOperation,
 Object key)

Specified by:

remove in interface OBaseIndexEngine

Specified by:

remove in interface OIndexEngine

remove

public boolean remove(OAtomicOperation atomicOperation,
 Object key,
 ORID value)

Specified by:

remove in interface OBaseIndexEngine

Specified by:

remove in interface OIndexEngine

iterateEntriesBetween

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

Specified by:

iterateEntriesBetween in interface OBaseIndexEngine

iterateEntriesMajor

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

Specified by:

iterateEntriesMajor in interface OBaseIndexEngine

iterateEntriesMinor

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

Specified by:

iterateEntriesMinor in interface OBaseIndexEngine

stream

public Stream<ORawPair<Object,ORID>> stream(IndexEngineValuesTransformer valuesTransformer)

Specified by:

stream in interface OBaseIndexEngine

Overrides:

stream in class OLuceneIndexEngineAbstract

keyStream

public Stream<Object> keyStream()

Specified by:

keyStream in interface OBaseIndexEngine

Overrides:

keyStream 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,
 ODocument shapeDoc)

encodeKey

protected Object encodeKey(Object key)

decodeKey

protected Object decodeKey(Object key)

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