com.atlassian.confluence.search.v2.lucene.mapper
Class PermittedSpacesQueryMapper

java.lang.Object
  com.atlassian.confluence.search.v2.lucene.mapper.PermittedSpacesQueryMapper

All Implemented Interfaces:

LuceneQueryMapper

public class PermittedSpacesQueryMapper
extends java.lang.Object
implements LuceneQueryMapper

Maps a PermittedSpacesQuery to an appropriate lucene query for the currently logged in user. This mapper should construct a query that searches only the spaces that the current logged in user can see.

Field Summary

static java.lang.String

SPACEKEY_FIELD Deprecated. Use DocumentFieldName.SPACE_KEY instead

Constructor Summary

PermittedSpacesQueryMapper()

Method Summary

org.apache.lucene.search.Query	convertToLuceneQuery(SearchQuery searchQuery) Convert a SearchQuery into a lucene query.
void	setSpaceManager(SpaceManager spaceManager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPACEKEY_FIELD

@Deprecated
public static final java.lang.String SPACEKEY_FIELD

Deprecated. Use DocumentFieldName.SPACE_KEY instead

See Also:

Constant Field Values

Constructor Detail

PermittedSpacesQueryMapper

public PermittedSpacesQueryMapper()

Method Detail

convertToLuceneQuery

public org.apache.lucene.search.Query convertToLuceneQuery(SearchQuery 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

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.

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)