Summary: Methods | [Expand All]
public interface

LuceneQueryMapper

com.atlassian.confluence.search.v2.lucene.LuceneQueryMapper<T extends com.atlassian.confluence.search.v2.SearchQuery>
Known Indirect Subclasses

Class Overview

A lucene query mapper represents an object that is able to map from a Confluence SearchQuery to a Lucene org.apache.lucene.search.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.

Summary

Public Methods
Query convertToLuceneQuery(T searchQuery)
Convert a SearchQuery into a lucene query.

Public Methods

public 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