Package com.atlassian.confluence.search.v2
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
-
ClassDescriptionAn abstract representation of a search to be performed.AbstractSearch.AbstractBuilder<SELF extends AbstractSearch.AbstractBuilder<SELF>>Abstract base implementation of SearchResult taken from LuceneSearchResult after removing dependency from Lucene classesThis class will help to transform invalid input raw query to a valid one.A simpler super interface of SearchResult.A simple functional interface for the batch update actionRepresents a search against change information.Clause type in boolean query.Calculates encoded string of content permission.This factory creates a new
ContentPermissionsQueryinstance if the user is not a superuserRepresents a search against Confluence content.This interface is available to plugins and allows 3rd-party vendors to add their own custom indexesDecoratorSearchBuilder<SEARCH extends ISearch>A builder for a search object that decorates another search object.Default implementation of SearchResultsAn abstract delegatingSearchIndexAccessorthat can be extended by a custom accessor.Expandable<T>Interface that allows classes implemented it to be transformed into composition of primitive ones.Contains the field-mappings associated with a particular index.Writer for creating field mappings physically on the underlying index.Exception thrown when an attempt is made to access a search field when it was not included in the collection of requested fields.Parameters for highlighting in search.This class represents an index, which replaces the deprecatedSearchIndexA developer can only define a new custom index viaIndex.custom(String)method.Thrown when a smart list query could not be converted to an index query.Superclass for exceptions thrown due to errors converting from a Search to the native search type.A representation of a search to be performed.ISearch.Builder<SEARCH extends ISearch>Builder interface to create new search instance with the specified valuesFascilitates conversion fromSearchResulttoSearchableUsed by the query deserializer to map between key/parameters andSearchQueryobjects.Note: Query serialization and deserialization does not work for all possible permutations of query parts at the moment.Range<T>Represent a set of data needed to perform a Lucene range queries.Contains the score and a field-value map of the underlying document returned by Lucene.An object representing some searchable file.Defines search constants.Decorates aISearchwith a custom logic e.g.search expander that expands query until no longer possible.A helper class that contains the known set of field mappings for the core indexes.Deprecated, for removal: This API element is subject to removal in a future version.This is a temporary solution for backward compatibility purposes, and will be removed in a future version.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.A mean to write to or remove a document from a search index.A V2 interface which provides searching functionality on a search index.Determines how search results will be converted into entities bySearchManager.convertToEntities(SearchResults, EntityVersionPolicy)andSearchManager.searchEntities(ISearch, EntityVersionPolicy).The annotated element as v2 search primitive means it is a building block for composing higher level search classes.A query to be performed against the search index.An individual search result.Represents a HTML link constructed from data contained in a search result (and ultimately the search index).The results of a search.Represents a confluence search result type.Represents some method for sorting search results, and the order in which to search them.Enum defining the types of ordering supported.An exception thrown when the search token has expired.A search that additionally specifies a search token.Relocation from confluence-search plugin.This factory class creates aSearchQueryinstance for filtering the documents by permissions.Factory to expand query string fromSiteTextSearchQueryinto a primitiveSearchQuery.This factory class creates aSearchQuerythat takes the user's space permissions into account.Defines the contractual obligation of a component which provides the ability to manage a staging index which can potentially be used as a primary index.Defines the contractual obligation of a staging index.SubClause<T>A data class representing a sub clause within a query designed to easy traversal a query tree.