org.janusgraph.diskstorage.lucene

Class LuceneIndex

java.lang.Object

org.janusgraph.diskstorage.lucene.LuceneIndex

All Implemented Interfaces:

IndexInformation, IndexProvider

public class LuceneIndex
extends Object
implements IndexProvider

Author:

Matthias Broecheler (me@matthiasb.com)

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_GEO_DIST_ERROR_PCT Default measure of shape precision used when creating the prefix tree.
static int	DEFAULT_GEO_MAX_LEVELS Default tree levels used when creating the prefix tree.

Fields inherited from interface org.janusgraph.diskstorage.indexing.IndexProvider

REPLACEMENT_CHAR

Constructor Summary

Constructors

Constructor and Description
LuceneIndex(Configuration config)

Method Summary

Modifier and Type	Method and Description
BaseTransactionConfigurable	beginTransaction(BaseTransactionConfig config)
void	clearStorage()
void	clearStore(String storeName)
void	close()
boolean	exists()
IndexFeatures	getFeatures()
String	mapKey2Field(String key, KeyInformation information)
void	mutate(Map<String,Map<String,IndexMutation>> mutations, KeyInformation.IndexRetriever information, BaseTransaction tx)
Stream<String>	query(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
Stream<RawQuery.Result<String>>	query(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)
Number	queryAggregation(IndexQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx, Aggregation aggregation)
void	register(String store, String key, KeyInformation information, BaseTransaction tx)
void	restore(Map<String,Map<String,List<IndexEntry>>> documents, KeyInformation.IndexRetriever information, BaseTransaction tx)
boolean	supports(KeyInformation information)
boolean	supports(KeyInformation information, JanusGraphPredicate janusgraphPredicate)
Long	totals(RawQuery query, KeyInformation.IndexRetriever information, BaseTransaction tx)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.janusgraph.diskstorage.indexing.IndexProvider

checkKeyValidity

Field Detail

DEFAULT_GEO_MAX_LEVELS

public static final int DEFAULT_GEO_MAX_LEVELS

Default tree levels used when creating the prefix tree.

See Also:

Constant Field Values

DEFAULT_GEO_DIST_ERROR_PCT

public static final double DEFAULT_GEO_DIST_ERROR_PCT

Default measure of shape precision used when creating the prefix tree.

See Also:

Constant Field Values

Constructor Detail

LuceneIndex

public LuceneIndex(Configuration config)

Method Detail

register

public void register(String store,
                     String key,
                     KeyInformation information,
                     BaseTransaction tx)
              throws BackendException

Specified by:

register in interface IndexProvider

Throws:

BackendException

mutate

public void mutate(Map<String,Map<String,IndexMutation>> mutations,
                   KeyInformation.IndexRetriever information,
                   BaseTransaction tx)
            throws BackendException

Specified by:

mutate in interface IndexProvider

Throws:

BackendException

restore

public void restore(Map<String,Map<String,List<IndexEntry>>> documents,
                    KeyInformation.IndexRetriever information,
                    BaseTransaction tx)
             throws BackendException

Specified by:

restore in interface IndexProvider

Throws:

BackendException

query

public Stream<String> query(IndexQuery query,
                            KeyInformation.IndexRetriever information,
                            BaseTransaction tx)
                     throws BackendException

Specified by:

query in interface IndexProvider

Throws:

BackendException

query

public Stream<RawQuery.Result<String>> query(RawQuery query,
                                             KeyInformation.IndexRetriever information,
                                             BaseTransaction tx)
                                      throws BackendException

Specified by:

query in interface IndexProvider

Throws:

BackendException

queryAggregation

public Number queryAggregation(IndexQuery query,
                               KeyInformation.IndexRetriever information,
                               BaseTransaction tx,
                               Aggregation aggregation)
                        throws BackendException

Specified by:

queryAggregation in interface IndexProvider

Throws:

BackendException

totals

public Long totals(RawQuery query,
                   KeyInformation.IndexRetriever information,
                   BaseTransaction tx)
            throws BackendException

Specified by:

totals in interface IndexProvider

Throws:

BackendException

beginTransaction

public BaseTransactionConfigurable beginTransaction(BaseTransactionConfig config)
                                             throws BackendException

Specified by:

beginTransaction in interface IndexProvider

Throws:

BackendException

supports

public boolean supports(KeyInformation information,
                        JanusGraphPredicate janusgraphPredicate)

Specified by:

supports in interface IndexInformation

supports

public boolean supports(KeyInformation information)

Specified by:

supports in interface IndexInformation

mapKey2Field

public String mapKey2Field(String key,
                           KeyInformation information)

Specified by:

mapKey2Field in interface IndexInformation

getFeatures

public IndexFeatures getFeatures()

Specified by:

getFeatures in interface IndexInformation

close

public void close()
           throws BackendException

Specified by:

close in interface IndexProvider

Throws:

BackendException

clearStorage

public void clearStorage()
                  throws BackendException

Specified by:

clearStorage in interface IndexProvider

Throws:

BackendException

clearStore

public void clearStore(String storeName)
                throws BackendException

Specified by:

clearStore in interface IndexProvider

Throws:

BackendException

exists

public boolean exists()
               throws BackendException

Specified by:

exists in interface IndexProvider

Throws:

BackendException