public class

OrderedNGramMatchingFilter

extends Filter
java.lang.Object
   ↳ org.apache.lucene.search.Filter
     ↳ com.atlassian.confluence.search.lucene.filter.OrderedNGramMatchingFilter

Class Overview

Filter that leaves only documents that contain term(s) that match the supplied query in its entirety (no partial matching is permitted). This filter effectively implements a "*foo*" search (without incurring a potentially expensive leading and/or trailing wildcard search).

Summary

Public Constructors
OrderedNGramMatchingFilter(String fieldName, String query, Analyzer queryAnalyzer)
Matches the query specified as one cohesive token.
Public Methods
BitSet bits(IndexReader reader)
[Expand]
Inherited Methods
From class org.apache.lucene.search.Filter
From class java.lang.Object

Public Constructors

public OrderedNGramMatchingFilter (String fieldName, String query, Analyzer queryAnalyzer)

Matches the query specified as one cohesive token. If multiple space delimited terms are specified, filtering will be performed on all terms and the result will be AND-ed. If a single term query is specified that is shorter than the length of the smallest n-gram produced by the analyzer, this filter will return an empty bitset.

Parameters
fieldName the name of the field that filtering will be performed on
query the query to search on
queryAnalyzer the analyer used to tokenize the fieldName into n-grams
Throws
IllegalArgumentException if fieldName or queryAnalyzer is null.

Public Methods

public BitSet bits (IndexReader reader)

Throws
IOException