com.atlassian.confluence.search.v2

Interface SearchQuery

All Superinterfaces:

Expandable<SearchQuery>

All Known Implementing Classes:

AbstractParameterListQuery, AbstractUserQuery, AllQuery, AttachmentTypeQuery, BooleanQuery, BoostingQuery, ConstantScoreQuery, ContainingContentTypeQuery, ContentTypeQuery, ContributorQuery, CreatorQuery, CustomContentTypeQuery, DateRangeQuery, DateRangeQuery, DoubleRangeQuery, FileExtensionQuery, FunctionScoreQuery, HasPersonalSpaceQuery, InheritedLabelQuery, InSpaceQuery, IntegerRangeQuery, LabelQuery, LongRangeQuery, MacroStorageVersionQuery, MacroUsageQuery, MatchNoDocsQuery, MultiTermQuery, MultiTextFieldQuery, NumberRangeQuery, PermittedSpacesQuery, PhraseQuery, PrefixQuery, QueryStringQuery, SiteTextSearchQuery, SpaceCategoryQuery, SpanNearQuery, TermQuery, TermRangeQuery, TextFieldPrefixQuery, TextFieldQuery, TextQuery, TextQuery, UserTextQuery

public interface SearchQuery
extends Expandable<SearchQuery>

A query to be performed against the search index. Implementations should be immutable.

Queries consist of a key (a unique string, usually a plugin module complete key, to identify the type of query being performed) and a list of parameters which may either be strings, or other instances of SearchQuery.

Method Summary

Modifier and Type	Method and Description
default SearchQuery	expand() Expands this query into a composite query (that composes other queries).
default float	getBoost() Return boost factor of this query.
String	getKey()
List	getParameters() List of parameters as Strings or SearchQuerys.

Method Detail

getKey

String getKey()

Returns:

the plugin key

getParameters

List getParameters()

List of parameters as Strings or SearchQuerys.

Returns:

Strings or SearchQuerys.

expand

default SearchQuery expand()

Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.

Specified by:

expand in interface Expandable<SearchQuery>

Returns:

a query

getBoost

@ExperimentalApi
default float getBoost()

Return boost factor of this query. It will take effect when the query is used in combination with others e.g. in BooleanQuery.

Returns:

boost factor