Package com.atlassian.confluence.internal.search.v2.lucene
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
-
Interface Summary Interface Description DocumentBuilder Creates a LuceneDocumentfrom the suppliedSearchable.ILuceneConnection A connection to a Lucene index.ILuceneConnection.BatchUpdateAction ILuceneConnection.Configuration Provide configuration for the index writers used by implementations of this interface.ILuceneConnection.ReaderAction ILuceneConnection.SearcherAction ILuceneConnection.SearcherWithTokenAction<T> ILuceneConnection.WriterAction LuceneAccessor This interface will allow to allow transition from atlassian-bonnie.LuceneQueryMapper<T extends SearchQuery> A lucene query mapper represents an object that is able to map from a ConfluenceSearchQueryto a LuceneQuery.LuceneQueryParserFactory LuceneSearchMapper LuceneSearchMapperRegistry Class that is responsible for converting a v2 search abstraction likeSearchQueryorSearchSortinto the equivalent technology specific object.LuceneSortMapper<T extends SearchSort> Deprecated. since 7.0 useSearchSort.expand()instead.MultiConnection This class imitates lucene connection, but works for arbitrary subset of indexesSearcherInitialisation Implement this interface to initialise a searcher. -
Class Summary Class Description BM25LSimilarity Extension of BM25 which shifts the term frequency normalization formula to boost scores of very long documents.BonnieConstants CustomFlexibleQueryParser CustomFlexibleQueryParser.CustomQueryConfigHandler DefaultConfiguration Configuration for anILuceneConnection, with the default values as used by Confluence.DelegatingLuceneSearchMapper DirectoryUtil HibernateUnwrapper Unwraps Hibernate proxies reflectively, without adding a compile-time dependency on Hibernate itself.InstrumentedIndexSearcher InstrumentedIndexWriter LoggingReentrantLock Adds logging and profiling to lock and unlock methods.LuceneConnection The implementation ofILuceneConnectionthat allows concurrent searching/reading and writing/deleting.LuceneConstants LuceneIndexMetrics Provides timer for capture metrics for low level Lucene library call.LuceneMapperClassPredicate Deprecated. since 7.0.1.LuceneMapperPredicate Deprecated. since 7.0.1.LuceneMultiTermFieldComparator<T> When returned from FieldComparatorSource.newComparator, a LuceneMultiTermFieldComparator compares hits so as to determine their sort order when collecting results, using a custom sort comparator that operates on terms that may have multiple values per document.LuceneQueryBuilders Deprecated. since 7.20 useBooleanQuery.Builderinstead orTermQuery.LuceneQueryBuilders.BooleanQueryBuilder LuceneQueryUtil Utility class to help with creating queries.LuceneSearchManager LuceneSearchQueryTokenizer The Lucene implementation ofSearchQueryTokenizer.LuceneSearchResult LuceneSearchResultFactory LuceneSearchResultFactory.UserLookupHelper Deprecated. LuceneSearchResults Deprecated. since 5.9.LuceneSiteTextSearchQueryFactory Relocation from confluence-search plugin.LuceneSiteTextSearchSpanQueryBuilder Relocation from confluence-search plugin.LuceneTermFieldComparator<T> When returned from FieldComparatorSource.newComparator, a LuceneTermFieldComparator compares hits so as to determine their sort order when collecting results, using a custom sort comparator.LuceneTextFieldTokenizer PluggableLuceneSearchMapperRegistry SearcherWithTokenAction Slf4JInfoStream Adapts Lucene's logging mechanism,InfoStream, to SLF4J.TopDocuments -
Exception Summary Exception Description LuceneConnectionClosedException Thrown when trying to use a closedILuceneConnection.LuceneException Thrown when a disaster happens in the underlying Lucene layer.LuceneMapperNotFoundException Exception thrown when a mapper (LuceneSortMapper,LuceneQueryMappercannot be found.SearchTokenExpiredException Thrown when the search token has expired.