com.atlassian.bonnie.search
Class SearchWordsLister

java.lang.Object
  com.atlassian.bonnie.search.SearchWordsLister

public class SearchWordsLister
extends java.lang.Object

The SearchWordLister is like a reverse builder that takes a query string and decomposes it into words to be search on and ignored words

Author:

ROSS

Constructor Summary

SearchWordsLister()
Default Constructor uses the StandardAnalyzer to parse queries.

SearchWordsLister(org.apache.lucene.analysis.Analyzer referenceAnalyzer, org.apache.lucene.analysis.Analyzer queryAnalyzer)
Construct a SearchWordsLister that uses the supplied analyzers.

Method Summary

java.util.List	getIgnoredWords()
java.lang.String	getIgnoredWordsAsString()
java.util.List	getSearchWords()
java.lang.String	getSearchWordsAsString()
void	parseQuery(java.lang.String query) generates a comma separated string of words that would be removed from the search query

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchWordsLister

public SearchWordsLister()

Default Constructor uses the StandardAnalyzer to parse queries.

SearchWordsLister

public SearchWordsLister(org.apache.lucene.analysis.Analyzer referenceAnalyzer,
                         org.apache.lucene.analysis.Analyzer queryAnalyzer)

Construct a SearchWordsLister that uses the supplied analyzers. The ignored words are the difference between the output of referenceAnalyzer and queryAnalyzer.

Parameters:

referenceAnalyzer - a query analyzer which will not remove any stop words.

queryAnalyzer - a query Analyzer which may remove stop words from the query.

Method Detail

getIgnoredWords

public java.util.List getIgnoredWords()

getSearchWords

public java.util.List getSearchWords()

getIgnoredWordsAsString

public java.lang.String getIgnoredWordsAsString()

getSearchWordsAsString

public java.lang.String getSearchWordsAsString()

parseQuery

public void parseQuery(java.lang.String query)
                throws java.io.IOException

generates a comma separated string of words that would be removed from the search query

Parameters:

query - the query being invoked

Throws:

java.io.IOException