SiteTextSearchQueryMapper (Atlassian Confluence 8.5.7 API)

java.lang.Object
- com.atlassian.confluence.impl.search.v2.mappers.SiteTextSearchQueryMapper

All Implemented Interfaces:

LuceneQueryMapper<SiteTextSearchQuery>
```
public class SiteTextSearchQueryMapper
extends Object
implements LuceneQueryMapper<SiteTextSearchQuery>
```
Relocation from confluence-search plugin.

Since:

6.16.0

Constructor Summary

Constructors
Constructor Description

SiteTextSearchQueryMapper(LuceneSiteTextSearchQueryFactory luceneQueryFactory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.lucene.search.Query`	`convertToLuceneQuery(SiteTextSearchQuery siteTextSearchQuery)`	Convert a SearchQuery into a lucene query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SiteTextSearchQueryMapper
```
public SiteTextSearchQueryMapper(LuceneSiteTextSearchQueryFactory luceneQueryFactory)
```
- Method Detail
  - convertToLuceneQuery
```
public org.apache.lucene.search.Query convertToLuceneQuery(SiteTextSearchQuery siteTextSearchQuery)
```
    Description copied from interface: LuceneQueryMapper
    
    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.
    
    Specified by:
    
    convertToLuceneQuery in interface LuceneQueryMapper<SiteTextSearchQuery>
    
    Parameters:
    
    siteTextSearchQuery - 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.