Package com.atlassian.jira.sharing.type

Class UserShareQueryFactory

java.lang.Object

com.atlassian.jira.sharing.type.UserShareQueryFactory

All Implemented Interfaces:

ShareQueryFactory<UserShareTypeSearchParameter>

public class UserShareQueryFactory
extends Object
implements ShareQueryFactory<UserShareTypeSearchParameter>

Since:

v7.12

Constructor Summary

Constructors

Constructor	Description
UserShareQueryFactory()

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.document.Field	getField(SharedEntity entity, SharePermission permission)	Get the Field we will later search for.
org.apache.lucene.search.Query	getQuery(ShareTypeSearchParameter parameter)	Get the search query for all shares shares that match the passed parameter.
org.apache.lucene.search.Query	getQuery(ShareTypeSearchParameter parameter, ApplicationUser user)	Get the search query for the shares that can be seen by the passed user for the passed parameter.
org.apache.lucene.index.Term[]	getTerms(ApplicationUser user)	Get the search terms for the shares that can be seen by the passed user.

Methods inherited from class java.lang.Object

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

Constructor Details

UserShareQueryFactory

public UserShareQueryFactory()

Method Details

getQuery

public org.apache.lucene.search.Query getQuery(ShareTypeSearchParameter parameter,
 ApplicationUser user)

Description copied from interface: ShareQueryFactory

Get the search query for the shares that can be seen by the passed user for the passed parameter. Used when the user has specified something to search for.

Specified by:

getQuery in interface ShareQueryFactory<UserShareTypeSearchParameter>

Parameters:

parameter - the parameters for the search.

user - the user to perform the search on behalf of.

Returns:

an array of Terms. It may be empty but never null.

getQuery

public org.apache.lucene.search.Query getQuery(ShareTypeSearchParameter parameter)

Description copied from interface: ShareQueryFactory

Get the search query for all shares shares that match the passed parameter. Used by the system to match all entities that match the parameter, for instance when deleting Group, Project or Role.

Specified by:

getQuery in interface ShareQueryFactory<UserShareTypeSearchParameter>

Parameters:

parameter - the parameters for the search.

Returns:

an array of Terms. It may be empty but never null.

getTerms

public org.apache.lucene.index.Term[] getTerms(ApplicationUser user)

Description copied from interface: ShareQueryFactory

Get the search terms for the shares that can be seen by the passed user.

Specified by:

getTerms in interface ShareQueryFactory<UserShareTypeSearchParameter>

Parameters:

user - the user to perform the search on behalf of.

Returns:

an array of Terms. It may be empty but never null.

getField

public org.apache.lucene.document.Field getField(SharedEntity entity,
 SharePermission permission)

Description copied from interface: ShareQueryFactory

Get the Field we will later search for.

Specified by:

getField in interface ShareQueryFactory<UserShareTypeSearchParameter>

Returns:

the field so we can add it to the index