com.atlassian.confluence.search.v2.lucene

Class SearcherWithTokenAction

java.lang.Object

com.atlassian.confluence.search.v2.lucene.SearcherWithTokenAction

All Implemented Interfaces:

com.atlassian.bonnie.ILuceneConnection.SearcherWithTokenAction<TopDocuments>

public class SearcherWithTokenAction
extends Object
implements com.atlassian.bonnie.ILuceneConnection.SearcherWithTokenAction<TopDocuments>

Constructor Summary

Constructors

Constructor and Description
SearcherWithTokenAction(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, int startOffset, int limit, Set<String> requestedFields)
SearcherWithTokenAction(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, int startOffset, int limit, Set<String> requestedFields, LuceneResultFilter luceneResultFilter) Deprecated. since this constructor accepts the deprecated LuceneResultFilter as a parameter. If you need to perform post-search result filtering, perform it on the SearchResults returned by SearchManager.

Method Summary

Modifier and Type	Method and Description
boolean	isExplain()
TopDocuments	perform(org.apache.lucene.search.IndexSearcher indexSearcher, long searchToken)
void	setExplain(boolean explain)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearcherWithTokenAction

public SearcherWithTokenAction(org.apache.lucene.search.Query query,
                               org.apache.lucene.search.Filter filter,
                               org.apache.lucene.search.Sort sort,
                               int startOffset,
                               int limit,
                               Set<String> requestedFields)

SearcherWithTokenAction

@Deprecated
public SearcherWithTokenAction(org.apache.lucene.search.Query query,
                                           org.apache.lucene.search.Filter filter,
                                           org.apache.lucene.search.Sort sort,
                                           int startOffset,
                                           int limit,
                                           Set<String> requestedFields,
                                           LuceneResultFilter luceneResultFilter)

Deprecated. since this constructor accepts the deprecated LuceneResultFilter as a parameter. If you need to perform post-search result filtering, perform it on the SearchResults returned by SearchManager.

Method Detail

perform

public TopDocuments perform(org.apache.lucene.search.IndexSearcher indexSearcher,
                            long searchToken)
                     throws IOException

Specified by:

perform in interface com.atlassian.bonnie.ILuceneConnection.SearcherWithTokenAction<TopDocuments>

Throws:

IOException

setExplain

public void setExplain(boolean explain)

isExplain

public boolean isExplain()