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

Class LuceneIndex

java.lang.Object

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

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 LuceneIndex
extends Object
implements org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvanceFulltextQueryIndex

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NATIVE_QUERY_FUNCTION
protected org.apache.jackrabbit.oak.plugins.index.lucene.IndexTracker	tracker

Constructor Summary

Constructors

Constructor and Description
LuceneIndex(org.apache.jackrabbit.oak.plugins.index.lucene.IndexTracker tracker, org.apache.jackrabbit.oak.plugins.index.aggregate.NodeAggregator aggregator)

Method Summary

Methods

Modifier and Type	Method and Description
double	getCost(org.apache.jackrabbit.oak.spi.query.Filter filter, org.apache.jackrabbit.oak.spi.state.NodeState root)
String	getIndexName()
double	getMinimumCost()
org.apache.jackrabbit.oak.plugins.index.aggregate.NodeAggregator	getNodeAggregator()
String	getPlan(org.apache.jackrabbit.oak.spi.query.Filter filter, org.apache.jackrabbit.oak.spi.state.NodeState root)
String	getPlanDescription(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan, org.apache.jackrabbit.oak.spi.state.NodeState root)
List<org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan>	getPlans(org.apache.jackrabbit.oak.spi.query.Filter filter, List<org.apache.jackrabbit.oak.spi.query.QueryIndex.OrderEntry> sortOrder, org.apache.jackrabbit.oak.spi.state.NodeState rootState)
protected static org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan.Builder	planBuilder(org.apache.jackrabbit.oak.spi.query.Filter filter)
org.apache.jackrabbit.oak.spi.query.Cursor	query(org.apache.jackrabbit.oak.spi.query.Filter filter, org.apache.jackrabbit.oak.spi.state.NodeState root)
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 java.lang.Object

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

Field Detail

NATIVE_QUERY_FUNCTION

public static final String NATIVE_QUERY_FUNCTION

See Also:

Constant Field Values

tracker

protected final org.apache.jackrabbit.oak.plugins.index.lucene.IndexTracker tracker

Constructor Detail

LuceneIndex

public LuceneIndex(org.apache.jackrabbit.oak.plugins.index.lucene.IndexTracker tracker,
           org.apache.jackrabbit.oak.plugins.index.aggregate.NodeAggregator aggregator)

Method Detail

getMinimumCost

public double getMinimumCost()

Specified by:

getMinimumCost in interface org.apache.jackrabbit.oak.spi.query.QueryIndex

getIndexName

public String getIndexName()

Specified by:

getIndexName in interface org.apache.jackrabbit.oak.spi.query.QueryIndex

getPlans

public List<org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan> getPlans(org.apache.jackrabbit.oak.spi.query.Filter filter,
                                                                      List<org.apache.jackrabbit.oak.spi.query.QueryIndex.OrderEntry> sortOrder,
                                                                      org.apache.jackrabbit.oak.spi.state.NodeState rootState)

Specified by:

getPlans in interface org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvancedQueryIndex

getCost

public double getCost(org.apache.jackrabbit.oak.spi.query.Filter filter,
             org.apache.jackrabbit.oak.spi.state.NodeState root)

Specified by:

getCost in interface org.apache.jackrabbit.oak.spi.query.QueryIndex

getPlan

public String getPlan(org.apache.jackrabbit.oak.spi.query.Filter filter,
             org.apache.jackrabbit.oak.spi.state.NodeState root)

Specified by:

getPlan in interface org.apache.jackrabbit.oak.spi.query.QueryIndex

getPlanDescription

public String getPlanDescription(org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan plan,
                        org.apache.jackrabbit.oak.spi.state.NodeState root)

Specified by:

getPlanDescription in interface org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvancedQueryIndex

query

public org.apache.jackrabbit.oak.spi.query.Cursor query(org.apache.jackrabbit.oak.spi.query.Filter filter,
                                               org.apache.jackrabbit.oak.spi.state.NodeState root)

Specified by:

query in interface org.apache.jackrabbit.oak.spi.query.QueryIndex

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)

Specified by:

query in interface org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvancedQueryIndex

planBuilder

protected static org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan.Builder planBuilder(org.apache.jackrabbit.oak.spi.query.Filter filter)

getNodeAggregator

public org.apache.jackrabbit.oak.plugins.index.aggregate.NodeAggregator getNodeAggregator()

Specified by:

getNodeAggregator in interface org.apache.jackrabbit.oak.spi.query.QueryIndex.FulltextQueryIndex