com.atlassian.confluence.internal.index.lucene

Class LuceneSearchIndexAccessor

java.lang.Object

com.atlassian.confluence.internal.index.lucene.LuceneSearchIndexAccessor

All Implemented Interfaces:

SearchIndexAccessor

@Internal
public class LuceneSearchIndexAccessor
extends Object
implements SearchIndexAccessor

Since:

7.14

Constructor Summary

Constructors

Constructor and Description
LuceneSearchIndexAccessor(com.atlassian.bonnie.LuceneAccessor luceneAccessor, LuceneFieldVisitor luceneFieldVisitor, LuceneQueryMapper<SearchQuery> luceneQueryMapper)

Method Summary

Modifier and Type	Method and Description
void	execute(SearchIndexAction action) Executes a SearchIndexAction on the underlying search index.
long	scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Scans the index for documents that match the provided searchQuery.

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneSearchIndexAccessor

public LuceneSearchIndexAccessor(com.atlassian.bonnie.LuceneAccessor luceneAccessor,
                                 LuceneFieldVisitor luceneFieldVisitor,
                                 LuceneQueryMapper<SearchQuery> luceneQueryMapper)

Method Detail

scan

public long scan(SearchQuery searchQuery,
                 Set<String> requestedFields,
                 Consumer<Map<String,String[]>> consumer)

Description copied from interface: SearchIndexAccessor

Scans the index for documents that match the provided searchQuery. The requestedFields set is used to specify which values need to be returned. The consumer will collect all the results found by the scan. Note that it is possible for a document to match the query, but not have any of the requested fields. This will result in an empty String[] for those fields that don't exist on the document. If you don't want to return those documents, you should specify a consumer that filters these out.

Specified by:

scan in interface SearchIndexAccessor

Parameters:

searchQuery - SearchQuery to scan the index for.

requestedFields - Set of field names that are requested from the index. Any fields provided here that is not on the document will return an empty String[] When providing an empty set, the consumer will only get empty maps to consume.

consumer - Consumer that handles each found document.

Returns:

long number of documents that matched the searchQuery.

execute

public void execute(SearchIndexAction action)

Description copied from interface: SearchIndexAccessor

Executes a SearchIndexAction on the underlying search index.

Specified by:

execute in interface SearchIndexAccessor

Parameters:

action - SearchIndexAction