org.apache.jackrabbit.oak.plugins.index.lucene

Class LucenePropertyIndex

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

org.apache.jackrabbit.oak.plugins.index.lucene.LucenePropertyIndex

All Implemented Interfaces:

org.apache.jackrabbit.oak.spi.query.QueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvancedQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvanceFulltextQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.FulltextQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.NativeQueryIndex

public class LucenePropertyIndex
extends org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

Used to query new (compatVersion 2) Lucene indexes. Provides a QueryIndex that does lookups against a Lucene-based index

To define a lucene index on a subtree you have to add an oak:index node. Under it follows the index definition node that:

• must be of type oak:QueryIndexDefinition
• must have the type property set to lucene
• must have the async property set to async

Optionally you can add

• what subset of property types to be included in the index via the includePropertyTypes property
• a blacklist of property names: what property to be excluded from the index via the excludePropertyNames property
• the reindex flag which when set to true, triggers a full content re-index.

 {
     NodeBuilder index = root.child("oak:index");
     index.child("lucene")
         .setProperty("jcr:primaryType", "oak:QueryIndexDefinition", Type.NAME)
         .setProperty("type", "lucene")
         .setProperty("async", "async")
         .setProperty("reindex", "true");
 }
 

See Also:

QueryIndex

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex.Facet, org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex.FacetProvider, org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex.FulltextPathCursor, org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex.FulltextResultRow

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.spi.query.QueryIndex

org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvancedQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvanceFulltextQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.FulltextQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan, org.apache.jackrabbit.oak.spi.query.QueryIndex.NativeQueryIndex, org.apache.jackrabbit.oak.spi.query.QueryIndex.NodeAggregator, org.apache.jackrabbit.oak.spi.query.QueryIndex.OrderEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	LUCENE_QUERY_BATCH_SIZE Batch size for fetching results from Lucene queries.
protected IndexTracker	tracker

Fields inherited from class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

ATTR_PLAN_RESULT

Constructor Summary

Constructors

Constructor and Description
LucenePropertyIndex(IndexTracker tracker)
LucenePropertyIndex(IndexTracker tracker, ScorerProviderFactory factory)
LucenePropertyIndex(IndexTracker tracker, ScorerProviderFactory factory, IndexAugmentorFactory augmentorFactory)

Method Summary

Modifier and Type	Method and Description
protected LuceneIndexNode	acquireIndexNode(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan)
protected LuceneIndexNode	acquireIndexNode(String indexPath)
protected String	getFulltextRequestString(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan, org.apache.jackrabbit.oak.plugins.index.search.IndexNode indexNode)
protected Predicate<org.apache.jackrabbit.oak.spi.state.NodeState>	getIndexDefinitionPredicate()
String	getIndexName()
double	getMinimumCost()
protected org.apache.jackrabbit.oak.plugins.index.search.SizeEstimator	getSizeEstimator(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan)
protected String	getType()
static @NotNull org.apache.jackrabbit.oak.plugins.index.lucene.LuceneRequestFacade<org.apache.lucene.search.Query>	performAdditionalWraps(@NotNull List<org.apache.lucene.search.Query> qs) Perform additional wraps on the list of queries to allow, for example, the NOT CONTAINS to play properly when sent to lucene.
org.apache.jackrabbit.oak.spi.query.Cursor	query(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan, org.apache.jackrabbit.oak.spi.state.NodeState rootState)

Methods inherited from class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

addSyncIndexPlan, determinePropertyType, getCost, getIndexName, getNodeAggregator, getPathRestriction, getPlan, getPlanDescription, getPlanResult, getPlans, getPropertyType, isNodePath, parseFacetField, query, rewriteQueryText, shouldInclude

Methods inherited from class java.lang.Object

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

Field Detail

LUCENE_QUERY_BATCH_SIZE

public static final int LUCENE_QUERY_BATCH_SIZE

Batch size for fetching results from Lucene queries.

See Also:

Constant Field Values

tracker

protected final IndexTracker tracker

Constructor Detail

LucenePropertyIndex

public LucenePropertyIndex(IndexTracker tracker)

LucenePropertyIndex

public LucenePropertyIndex(IndexTracker tracker,
                           ScorerProviderFactory factory)

LucenePropertyIndex

public LucenePropertyIndex(IndexTracker tracker,
                           ScorerProviderFactory factory,
                           IndexAugmentorFactory augmentorFactory)

Method Detail

getMinimumCost

public double getMinimumCost()

getIndexName

public String getIndexName()

query

public org.apache.jackrabbit.oak.spi.query.Cursor query(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan,
                                                        org.apache.jackrabbit.oak.spi.state.NodeState rootState)

acquireIndexNode

protected LuceneIndexNode acquireIndexNode(String indexPath)

Specified by:

acquireIndexNode in class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

acquireIndexNode

protected LuceneIndexNode acquireIndexNode(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan)

Overrides:

acquireIndexNode in class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

getType

protected String getType()

Specified by:

getType in class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

getSizeEstimator

protected org.apache.jackrabbit.oak.plugins.index.search.SizeEstimator getSizeEstimator(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan)

Specified by:

getSizeEstimator in class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

getIndexDefinitionPredicate

protected Predicate<org.apache.jackrabbit.oak.spi.state.NodeState> getIndexDefinitionPredicate()

Specified by:

getIndexDefinitionPredicate in class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

getFulltextRequestString

protected String getFulltextRequestString(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan,
                                          org.apache.jackrabbit.oak.plugins.index.search.IndexNode indexNode)

Specified by:

getFulltextRequestString in class org.apache.jackrabbit.oak.plugins.index.search.spi.query.FulltextIndex

performAdditionalWraps

@NotNull
public static @NotNull org.apache.jackrabbit.oak.plugins.index.lucene.LuceneRequestFacade<org.apache.lucene.search.Query> performAdditionalWraps(@NotNull
                                                                                                                                                          @NotNull List<org.apache.lucene.search.Query> qs)

Perform additional wraps on the list of queries to allow, for example, the NOT CONTAINS to play properly when sent to lucene.

Parameters:

qs - the list of queries. Cannot be null.

Returns:

the request facade