SiteSearchPermissionsQueryMapper (Atlassian Confluence 8.8.0 API)

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

All Implemented Interfaces:

LuceneQueryMapper<SiteSearchPermissionsQuery>
```
public class SiteSearchPermissionsQueryMapper
extends Object
implements LuceneQueryMapper<SiteSearchPermissionsQuery>
```
This mapper is to map SiteSearchPermissionsQuery to a FilteredQuery, which is more performant than the query generated by SiteSearchPermissionsQueryFactory.
This mapper will be removed when Lucene is upgraded to 6.0+, in which FilteredQuery no longer exists.

Since:

7.20

Constructor Summary

Constructors
Constructor Description

SiteSearchPermissionsQueryMapper()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.lucene.search.Query`	`convertToLuceneQuery(SiteSearchPermissionsQuery searchQuery)`	Convert a SearchQuery into a lucene query.
`void`	`setBrowseUsersPermissionsFilterFactory(BrowseUsersPermissionsFilterFactory browseUsersPermissionsFilterFactory)`
`void`	`setPermissionManager(PermissionManager permissionManager)`
`void`	`setSpacePermissionsFilterFactory(SpacePermissionsFilterFactory spacePermissionsFilterFactory)`
`void`	`setUserAccessor(UserAccessor userAccessor)`

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

- Constructor Detail
  - SiteSearchPermissionsQueryMapper
```
public SiteSearchPermissionsQueryMapper()
```
- Method Detail
  - convertToLuceneQuery
```
public org.apache.lucene.search.Query convertToLuceneQuery(SiteSearchPermissionsQuery searchQuery)
```
    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<SiteSearchPermissionsQuery>
    
    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.
  - setUserAccessor
```
public void setUserAccessor(UserAccessor userAccessor)
```
  - setPermissionManager
```
public void setPermissionManager(PermissionManager permissionManager)
```
  - setSpacePermissionsFilterFactory
```
public void setSpacePermissionsFilterFactory(SpacePermissionsFilterFactory spacePermissionsFilterFactory)
```
  - setBrowseUsersPermissionsFilterFactory
```
public void setBrowseUsersPermissionsFilterFactory(BrowseUsersPermissionsFilterFactory browseUsersPermissionsFilterFactory)
```