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

Interface FulltextQueryTermsProvider

public interface FulltextQueryTermsProvider

Implementations of this interface would get callbacks while forming lucene full text queries.

Field Summary

Fields

Modifier and Type	Field and Description
static FulltextQueryTermsProvider	DEFAULT Implementation which doesn't do anything useful...

Method Summary

Modifier and Type	Method and Description
@Nullable Query	getQueryTerm(java.lang.String text, Analyzer analyzer, NodeState indexDefinition) This method would get called while forming full text clause for full text clause not constrained on a particular field.
@NotNull java.util.Set<java.lang.String>	getSupportedTypes() This method is used to find which node types are supported by the implementation.

Field Detail

DEFAULT

static final FulltextQueryTermsProvider DEFAULT

Implementation which doesn't do anything useful... yet, abides with the contract.

Method Detail

getQueryTerm

@Nullable
@Nullable Query getQueryTerm(java.lang.String text,
                                       Analyzer analyzer,
                                       NodeState indexDefinition)

This method would get called while forming full text clause for full text clause not constrained on a particular field.

Parameters:

text - full text term

analyzer - Analyzer being used while forming the query. Can be used to analyze text consistently.

indexDefinition - NodeState of index definition

Returns:

Query object to be OR'ed with query being prepared. null, if nothing is to be added.

getSupportedTypes

@NotNull
@NotNull java.util.Set<java.lang.String> getSupportedTypes()

This method is used to find which node types are supported by the implementation. Based, on the index definition being used to query the document, only those implementations would get callback to getQueryTerm(java.lang.String, org.apache.lucene.analysis.Analyzer, org.apache.jackrabbit.oak.spi.state.NodeState) which declare a matching node type. Note, node types are exact matches and do not support inheritance.

Returns:

Set of types supported by the implementation