com.atlassian.confluence.search.v2.lucene

Interface LuceneQueryMapper<T extends SearchQuery>

All Known Subinterfaces:

LuceneSearchMapper

All Known Implementing Classes:

AbstractUserQueryMapper, AllQueryMapper, AttachmentTypeQueryMapper, BaseConstantScoreQueryMapper, BooleanQueryMapper, ContainingContentTypeQueryMapper, ContentTypeQueryMapper, ContributorQueryMapper, CreatorQueryMapper, CustomContentTypeQueryMapper, DateRangeQueryMapper, DateRangeQueryMapper, DelegatingLuceneSearchMapper, FileExtensionQueryMapper, HasPersonalSpaceQueryMapper, InheritedLabelQueryMapper, InSpaceQueryMapper, LabelQueryMapper, MacroStorageVersionQueryMapper, MacroUsageQueryMapper, MatchNoDocsQueryMapper, MultiTermQueryMapper, MultiTextFieldQueryMapper, NumberRangeFieldQueryMapper, PermittedSpacesQueryMapper, SpaceCategoryQueryMapper, TermQueryMapper, TermRangeQueryMapper, TextFieldPrefixQueryMapper, TextFieldQueryMapper, TextQueryMapper, UserTextQueryMapper

public interface LuceneQueryMapper<T extends SearchQuery>

A lucene query mapper represents an object that is able to map from a Confluence SearchQuery to a Lucene Query.

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

Modifier and Type	Method and Description
org.apache.lucene.search.Query	convertToLuceneQuery(T searchQuery) Convert a SearchQuery into a lucene query.

Method Detail

convertToLuceneQuery

org.apache.lucene.search.Query convertToLuceneQuery(T searchQuery)

Convert a SearchQuery into a lucene query. So a query that represents a search for any value in a particular index field should map to null.

Parameters:

searchQuery - the query to convert

Returns:

the lucene query corresponding to the search query. null can be returned and signifies that no mapped query is necessary for the mapped query.

Throws:

IllegalArgumentException - if the search query is null or invalid