Package com.atlassian.confluence.search.v2

Provides an extensible, flexible search API.

See:
Description

Interface Summary

QueryFactory	Used by the query deserializer to map between key/parameters and SearchQuery objects.
ResultFilter	Represents some method for filtering search results before they are returned from the search subsystem.
SearchManager	Facade for the v2 search API.
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.
SearchSort.Order	The two most common sort orders are defined here as constants for convenience.

Class Summary

DefaultQueryFactory	A default implementation of QueryFactory that maps query type keys to plugin module complete keys.
QuerySerializer	Responsible for converting SearchQueries to and from their String form.
Search	A representation of a search to be performed.

Exception Summary

InvalidQueryException	Thrown when a smart list query could not be converted to an index query.
InvalidResultFilterException	Thrown when a Search is invalid because it specifies a filter that can not be mapped by the back-end implementation
InvalidSearchException	Superclass for exceptions thrown due to errors converting from a Search to the native search type.
InvalidSortException	Thrown when a Search is invalid because it specifies a sort that can not be mapped by the back-end implementation

Package com.atlassian.confluence.search.v2 Description

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

• TODO: link to architecture documentation on cac

Since:

2.8