Package com.atlassian.confluence.search.v2.lucene

Provides a Lucene-backed implementation of the SearchManager.

See:
Description

Interface Summary

LuceneQueryMapper<T extends SearchQuery>	A lucene query mapper represents an object that is able to map from a Confluence SearchQuery to a Lucene Query.
LuceneResultFilter	Deprecated. since 5.5.
LuceneResultFilterMapper	Deprecated. since 5.5 as it depends on the deprecated LuceneResultFilter and ResultFilter classes.
LuceneSearcher	Deprecated. since 5.5.
LuceneSearchFilterMapper<T extends SearchFilter>	A lucene search filter mapper represents an object that is able to map from a Confluence SearchFilter to a Lucene Filter.
LuceneSearchMapper
LuceneSearchMapperRegistry	Class that is responsible for converting a v2 search abstraction like SearchQuery or SearchSort into the equivalent technology specific object.
LuceneSortMapper
WrappedHit	Deprecated. since 5.2.

Class Summary

AbstractLuceneSearchResult
CacheBackedLuceneSearchMapperRegistry	A search mapper registry that operates on a cache only.
DelegatingLuceneSearchMapper
LuceneMapperClassPredicate	Predicate for finding Lucene query mapper plugins of a specified class in the plugin registry.
LuceneMapperPredicate	Predicate for finding matching Lucene query mapper plugins in the plugin registry.
LuceneSearcherImpl
LuceneSearchManager
LuceneSearchMapperRegistryCacheUpdateListener	Listener that is responsible keeping the cache of search mapper module descriptors in CacheBackedLuceneSearchMapperRegistry up to date in response to plugin events.
LuceneSearchResult
LuceneSearchResults
LuceneSubsetResultFilter	Deprecated. since 5.5.
NullResultFilter	Result filter that allows everything into the final result set.
PluggableLuceneSearchMapperRegistry
SearcherAction	Deprecated. since 5.5.
SearcherWithTokenAction
SearchMappersThreadLocal	Holds a thread local cache of plugin mappers involved in search.
Slf4JInfoStream	Adapts Lucene's logging mechanism, InfoStream, to SLF4J.
ThreadCachedSearchMapperRegistry	A facade onto the PluggableLuceneSearchMapperRegistry which will first look for a ThreadLocal cache of available search mappers before delegating.
TopDocuments
WrappedHitImpl	Deprecated. since 5.2.

Exception Summary

LuceneMapperNotFoundException

Exception thrown when a mapper (LuceneSortMapper, LuceneQueryMapper or LuceneResultFilterMapper) cannot be found.

Package com.atlassian.confluence.search.v2.lucene Description

Provides a Lucene-backed implementation of the SearchManager. Configuration of the mappings between Search instances and Lucene queries are done through plugins. Client-code of the v2 search API should not have to refer to any code in this package or below.

Package Specification

Mapping between Searches and their Lucene-specific implementations are handled through the various Registry classes. These in turn are backed by the PluggableLuceneSearchMapperRegistry, which delegates the mapping to plugin modules.

Since:

2.8

See Also:

com.atlassian.confluence.search.v2