com.atlassian.confluence.search.v2.lucene
Interface LuceneSearchFilterMapper<T extends SearchFilter>

All Known Subinterfaces:

LuceneSearchMapper

All Known Implementing Classes:

AuthorSearchFilterMapper, ChainedSearchFilterMapper, ContentPermissionsLuceneSearchFilterMapper, DelegatingLuceneSearchMapper, ExcludePersonalInformationFilterMapper, SiteSearchPermissionsSearchFilterMapper, SpacePermissionsSearchFilterMapper

public interface LuceneSearchFilterMapper<T extends SearchFilter>

A lucene search filter mapper represents an object that is able to map from a Confluence SearchFilter to a Lucene Filter.

Implementations of this class will be autowired automatically.

Implementations of this class must use setter injection instead of constructor injector, as only the former is supported at the moment.

Method Summary

org.apache.lucene.search.Filter

convertToLuceneSearchFilter(T searchFilter) Convert a search filter into a lucene search filter.

Method Detail

convertToLuceneSearchFilter

org.apache.lucene.search.Filter convertToLuceneSearchFilter(T searchFilter)

Convert a search filter into a lucene search filter.

Parameters:

searchFilter - the search filter to convert

Returns:

the lucene search filter corresponding to the search filter

Throws:

java.lang.IllegalArgumentException - if the search filter is null or invalid