Package com.atlassian.jira.issue.search.providers

Class LuceneSearchProvider

java.lang.Object

com.atlassian.jira.issue.search.providers.LuceneSearchProvider

All Implemented Interfaces:

SearchProvider

@Deprecated(since="10.4",
            forRemoval=true)
public class LuceneSearchProvider
extends Object
implements SearchProvider

Deprecated, for removal: This API element is subject to removal in a future version.

since 10.4. To be removed when SearchProvider is removed.

Constructor Summary

Constructors

Constructor

Description

LuceneSearchProvider(SearchProviderFactory searchProviderFactory, PermissionsFilterGenerator permissionsFilterGenerator, SearchHandlerManager searchHandlerManager, SearchSortUtil searchSortUtil, LuceneQueryBuilder luceneQueryBuilder, JqlAliasManager jqlAliasManager, FeatureManager featureManager, com.atlassian.event.api.EventPublisher eventPublisher, PermissionQueryCache permissionQueryCache, ApplicationProperties applicationProperties, ProjectManager projectManager, PluginIndexConfigurationManager pluginIndexConfigurationManager, FieldRegistry fieldRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
long	getHitCount(SearchQuery query)	Deprecated, for removal: This API element is subject to removal in a future version. Return the number of documents that match the query
long	getHitCount(SearchQuery query, Long timeout)	Deprecated, for removal: This API element is subject to removal in a future version. Return the number of documents that match the query
SearchResults<DocumentWithId>	search(SearchQuery query, PagerFilter pager)	Deprecated, for removal: This API element is subject to removal in a future version. Run a search against the Issue index, loading all fields for each document.
SearchResults<DocumentWithId>	search(SearchQuery query, PagerFilter pager, Set<String> fieldsToLoad)	Deprecated, for removal: This API element is subject to removal in a future version. Run a search against the Issue index, loading only a restricted subset of fields for each document.
void	search(SearchQuery query, org.apache.lucene.search.Collector collector)	Deprecated, for removal: This API element is subject to removal in a future version. Run a search against the Issue index with the collector called for each document that matches the query.

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneSearchProvider

public LuceneSearchProvider(SearchProviderFactory searchProviderFactory,
 PermissionsFilterGenerator permissionsFilterGenerator,
 SearchHandlerManager searchHandlerManager,
 SearchSortUtil searchSortUtil,
 LuceneQueryBuilder luceneQueryBuilder,
 JqlAliasManager jqlAliasManager,
 FeatureManager featureManager,
 com.atlassian.event.api.EventPublisher eventPublisher,
 PermissionQueryCache permissionQueryCache,
 ApplicationProperties applicationProperties,
 ProjectManager projectManager,
 PluginIndexConfigurationManager pluginIndexConfigurationManager,
 FieldRegistry fieldRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

search

public SearchResults<DocumentWithId> search(SearchQuery query,
 PagerFilter pager,
 Set<String> fieldsToLoad)
                                     throws SearchException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SearchProvider

Run a search against the Issue index, loading only a restricted subset of fields for each document.

Results ordering

Results are sorted according to Query.getOrderByClause() and Lucene scoring.

Specified by:

search in interface SearchProvider

Parameters:

query - Query to define which Lucene documents should be returned.

pager - PagerFilter to restrict the portion of documents matching the query that will be returned.

fieldsToLoad - Set of fields that should be loaded. Only these fields will be available in the returned document. Empty set means only document id will be loaded.

Returns:

SearchResults with Lucene documents (and their internal ids) with only specific fields loaded

Throws:

SearchException

See Also:

• DocumentWithId

search

public SearchResults<DocumentWithId> search(SearchQuery query,
 PagerFilter pager)
                                     throws SearchException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SearchProvider

Run a search against the Issue index, loading all fields for each document. If possible, use the more performant method SearchProvider.search(SearchQuery, PagerFilter, Set), loading only a subset of fields.

Results ordering

Results are sorted according to Query.getOrderByClause() and Lucene scoring.

Specified by:

search in interface SearchProvider

Parameters:

query - Query to define which Lucene documents should be returned.

pager - PagerFilter to restrict the portion of documents matching the query that will be returned.

Returns:

SearchResults with Lucene documents (and their internal ids) with all fields loaded

Throws:

SearchException

See Also:

• DocumentWithId

getHitCount

public long getHitCount(SearchQuery query)
                 throws SearchException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SearchProvider

Return the number of documents that match the query

Specified by:

getHitCount in interface SearchProvider

Parameters:

query - Query to define which Lucene documents should be counted.

Returns:

Throws:

SearchException

getHitCount

public long getHitCount(SearchQuery query,
 Long timeout)
                 throws SearchException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SearchProvider

Return the number of documents that match the query

Specified by:

getHitCount in interface SearchProvider

Parameters:

query - Query to define which Lucene documents should be counted.

timeout - Query timeout in milliseconds

Returns:

Throws:

SearchException

search

public void search(SearchQuery query,
 org.apache.lucene.search.Collector collector)
            throws SearchException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: SearchProvider

Run a search against the Issue index with the collector called for each document that matches the query.

Results ordering

This method disrespects sorting from Query.getOrderByClause(). The collector will be called according to Lucene's internal index structure. The docIds passed to LeafCollector.collect(int) are in order that is safe to be used with DocValuesIterator.advanceExact(int) method.

Performance

This method offers the best performance when processing all data. As opposed to SearchProvider.search(SearchQuery, PagerFilter) and SearchProvider.search(SearchQuery, PagerFilter, Set), it does not load all returned documents into the memory at once. For each result it calls LeafCollector.collect(int) with the document id and leaves it up to the Collector implementation to decide what to do: load all or only specific fields, save just the document id, or ignore the given id completely.

Specified by:

search in interface SearchProvider

Throws:

SearchException