com.atlassian.confluence.search.lucene.filter
Class OrderedNGramMatchingFilter

java.lang.Object
  extended by org.apache.lucene.search.Filter
      extended by com.atlassian.confluence.search.lucene.filter.OrderedNGramMatchingFilter
All Implemented Interfaces:
Serializable

public class OrderedNGramMatchingFilter
extends org.apache.lucene.search.Filter

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

See Also:
Serialized Form

Constructor Summary
OrderedNGramMatchingFilter(String fieldName, String query, org.apache.lucene.analysis.Analyzer queryAnalyzer)
          Matches the query specified as one cohesive token.
 
Method Summary
 BitSet bits(org.apache.lucene.index.IndexReader reader)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrderedNGramMatchingFilter

public OrderedNGramMatchingFilter(String fieldName,
                                  String query,
                                  org.apache.lucene.analysis.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.
Method Detail

bits

public BitSet bits(org.apache.lucene.index.IndexReader reader)
            throws IOException
Specified by:
bits in class org.apache.lucene.search.Filter
Throws:
IOException


Copyright © 2003-2011 Atlassian. All Rights Reserved.