Package com.atlassian.confluence.search.v2
Provides an extensible, flexible search API. This API supercedes, and should be used for in preference to
SmartListManager
, SearchQueryBean
, SearchScope
, or accessing
Lucene directly.
Package Specification
To external client code, this package provides a single service:
SearchManager
.
Related Documentation
- Since:
- 2.8
-
Interface Summary Interface Description AtlassianDocumentBuilder<T> AutoCorrectRawQueryTransformer This class will help to transform invalid input raw query to a valid one.BaseSearchResult A simpler super interface of SearchResult.BatchUpdateAction A simple functional interface for the batch update actionContentPermissionCalculator Calculates encoded string of content permission.ContentPermissionsQueryFactory This factory creates a newContentPermissionsQuery
instance if the user is not a superuserCustomSearchIndexRegistry This interface is available to plugins and allows 3rd-party vendors to add their own custom indexesExpandable<T> Interface that allows classes implemented it to be transformed into composition of primitive ones.FieldMappings.FieldMappingWriter Writer for creating field mappings physically on the underlying index.HightlightParams Parameters for highlighting in search.ISearch A representation of a search to be performed.ISearchResultConverter Fascilitates conversion fromSearchResult
toSearchable
QueryFactory Used by the query deserializer to map between key/parameters andSearchQuery
objects.SearchableAttachment An object representing some searchable file.SearchDecorator Decorates aISearch
with a custom logic e.g.SearchIndexAccessor An V2 interface which provides the following thread-safe actions on a search index: Searching bySearchIndexAccessor.search(ISearch, Set)
,SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing bySearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes viaSearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets viaSearchIndexAccessor.reset(Runnable)
Snapshotting viaSearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring.SearchIndexAction SearchIndexWriter A mean to write to or remove a document from a search index.SearchManager A V2 interface which provides searching functionality on a search index.SearchManager.Categorizer<T> SearchQuery A query to be performed against the search index.SearchResult An individual search result.SearchResults The results of a search.SearchSort Represents some method for sorting search results, and the order in which to search them.SearchWithToken A search that additionally specifies a search token.SiteSearchPermissionsQueryFactory This factory class creates aSearchQuery
instance for filtering the documents by permissions.SiteTextSearchQueryFactory Factory to expand query string fromSiteTextSearchQuery
into a primitiveSearchQuery
.SpaceCategories SpacePermissionQueryFactory This factory class creates aSearchQuery
that takes the user's space permissions into account. -
Class Summary Class Description AbstractSearch An abstract representation of a search to be performed.AbstractSearchResult Abstract base implementation of SearchResult taken from LuceneSearchResult after removing dependency from Lucene classesAbstractSearchResult.AlternateFieldNames Handles alternate names for fields, typically when a field has been split or moved into another field.AtlassianDocument BooleanQueryBuilder<T> ChangesSearch Represents a search against change information.ContentSearch Represents a search against Confluence content.CustomSearch Deprecated, for removal: This API element is subject to removal in a future version. since 8.7.0DefaultHighlightParams DefaultSearch DefaultSearchResults Default implementation of SearchResultsDefaultSearchWithToken DelegatingSearchIndexAccessor An abstract delegatingSearchIndexAccessor
that can be extended by a custom accessor.FieldMappings Contains the field-mappings associated with a particular index.Index This class represents an index, which replaces the deprecatedSearchIndex
A developer can only define a new custom index viaIndex.custom(String)
method.ProjectedSearchResult QuerySerializer Note: Query serialization and deserialization does not work for all possible permutations of query parts at the moment.QueryUtil Range<T> Represent a set of data needed to perform a Lucene range queries.Range.Builder<T> ScannedDocument Contains the score and a field-value map of the underlying document returned by Lucene.SearchConstants Defines search constants.SearchExpander search expander that expands query until no longer possible.SearchFieldMappings A helper class that contains the known set of field mappings for the core indexes.SearchFieldMappings.ChangeMappingsProvider SearchFieldMappings.ContentMappingsProvider SearchFieldNames Deprecated. since 8.6.SearchResultConverter SearchResultLink Represents a HTML link constructed from data contained in a search result (and ultimately the search index).SiteSearchContainsSearchSyntaxEvent Relocation from confluence-search plugin.SubClause<T> A data class representing a sub clause within a query designed to easy traversal a query tree. -
Enum Summary Enum Description BooleanOperator ClauseType Clause type in boolean query.Index.Type ScoringStrategy Deprecated, for removal: This API element is subject to removal in a future version. since 8.7SearchManager.EntityVersionPolicy Determines how search results will be converted into entities bySearchManager.convertToEntities(SearchResults, EntityVersionPolicy)
andSearchManager.searchEntities(ISearch, EntityVersionPolicy)
.SearchResultType Represents a confluence search result type.SearchSort.Order Enum defining the types of ordering supported.SearchSort.Type -
Exception Summary Exception Description FieldNotRequestedException Exception thrown when an attempt is made to access a search field when it was not included in the collection of requested fields.IndexFieldMappingConflictException Deprecated. since 8.7InvalidQueryException Thrown when a smart list query could not be converted to an index query.InvalidSearchException Superclass for exceptions thrown due to errors converting from a Search to the native search type.SearchIndexAccessException SearchTokenExpiredException An exception thrown when the search token has expired. -
Annotation Types Summary Annotation Type Description SearchPrimitive The annotated element as v2 search primitive means it is a building block for composing higher level search classes.