Uses of Interface
com.atlassian.confluence.search.v2.SearchQuery

Packages that use SearchQuery

Package	Description
com.atlassian.confluence.event.events.search
com.atlassian.confluence.impl.search
com.atlassian.confluence.impl.search.v2
com.atlassian.confluence.index
com.atlassian.confluence.internal.index.lucene
com.atlassian.confluence.internal.search
com.atlassian.confluence.macro.query
com.atlassian.confluence.plugin.descriptor.search
com.atlassian.confluence.plugins.contentproperty.search.fields
com.atlassian.confluence.plugins.contentproperty.search.query
com.atlassian.confluence.plugins.retentionrules.impl.service.search.query
com.atlassian.confluence.rss
com.atlassian.confluence.search
com.atlassian.confluence.search.contentnames
com.atlassian.confluence.search.lucene
com.atlassian.confluence.search.plugin
com.atlassian.confluence.search.service
com.atlassian.confluence.search.v2	Provides an extensible, flexible search API.
com.atlassian.confluence.search.v2.lucene
com.atlassian.confluence.search.v2.lucene.mapper
com.atlassian.confluence.search.v2.query
com.atlassian.confluence.search.v2.searchfilter

Uses of SearchQuery in com.atlassian.confluence.event.events.search

Methods in com.atlassian.confluence.event.events.search that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	SearchPerformedEvent.getSearchQuery()

Constructors in com.atlassian.confluence.event.events.search with parameters of type SearchQuery

Constructor and Description
SearchPerformedEvent(Object source, SearchQuery search, com.atlassian.user.User user, int numberOfResults)

Uses of SearchQuery in com.atlassian.confluence.impl.search

Methods in com.atlassian.confluence.impl.search with parameters of type SearchQuery

Modifier and Type	Method and Description
ReIndexTask	CompositeIndexManager.reIndex(EnumSet<ReIndexOption> options, SearchQuery searchQuery)

Uses of SearchQuery in com.atlassian.confluence.impl.search.v2

Classes in com.atlassian.confluence.impl.search.v2 that implement SearchQuery

Modifier and Type	Class and Description
class	SiteSearchPermissionsQuery This is used in conjunction with the SiteSearchPermissionsQueryMapper, which map it to a FilteredQuery
class	SpacePermissionQuery This query will remain until Lucene is upgraded to 6.0+ where Filter and FilteredQuery no longer exist.

Methods in com.atlassian.confluence.impl.search.v2 that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	DefaultSiteSearchPermissionsQueryFactory.create()
SearchQuery	SiteSearchPermissionsFilteredQueryFactory.create()
SearchQuery	DefaultSpacePermissionQueryFactory.create(ConfluenceUser user)
SearchQuery	SpacePermissionFilteredQueryFactory.create(ConfluenceUser user)

Methods in com.atlassian.confluence.impl.search.v2 that return types with arguments of type SearchQuery

Modifier and Type	Method and Description
Optional<SearchQuery>	DefaultContentPermissionsQueryFactory.create(ConfluenceUser user)

Uses of SearchQuery in com.atlassian.confluence.index

Methods in com.atlassian.confluence.index that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	ReIndexSpec.getDeleteQuery()

Methods in com.atlassian.confluence.index with parameters of type SearchQuery

Modifier and Type	Method and Description
void	ReIndexer.reIndex(EnumSet<ReIndexOption> options, @NonNull SearchQuery searchQuery, Progress progress) Deprecated. Triggers a system wide re-index re-index all entities loaded from searchQuery.
default void	ReIndexer.reIndex(Set<ReIndexOption> options, SearchQuery searchQuery, Progress progress) Deprecated. since 5.10. Use ReIndexer.reIndex(EnumSet, SearchQuery, Progress) instead.

Constructors in com.atlassian.confluence.index with parameters of type SearchQuery

Constructor and Description
ReIndexSpec(SearchQuery deleteQuery, int concurrencyLevel, List<HibernateHandle> handles, String name)

Uses of SearchQuery in com.atlassian.confluence.internal.index.lucene

Methods in com.atlassian.confluence.internal.index.lucene with parameters of type SearchQuery

Modifier and Type	Method and Description
ReIndexTask	FullReindexManager.reIndex(EnumSet<ReIndexOption> options, SearchQuery searchQuery) Triggers a system wide re-index where entities are loaded using provided searchQuery.
ReIndexTask	LuceneFullReindexManager.reIndex(EnumSet<ReIndexOption> options, SearchQuery searchQuery)
void	LuceneReIndexer.reIndex(EnumSet<ReIndexOption> maybeOptions, @NonNull SearchQuery searchQuery, Progress progress)
long	LuceneSearchIndexAccessor.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)
long	LuceneSearchIndexAccessor.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<ScannedDocument> consumer, float defaultSCore)

Uses of SearchQuery in com.atlassian.confluence.internal.search

Methods in com.atlassian.confluence.internal.search with parameters of type SearchQuery

Modifier and Type	Method and Description
long	DecoratedSearchManager.scan(EnumSet<SearchIndex> indexes, SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)
long	DecoratedSearchManager.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)

Uses of SearchQuery in com.atlassian.confluence.macro.query

Methods in com.atlassian.confluence.macro.query that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	SearchQueryInterpreter.createSearchQuery(String value)

Methods in com.atlassian.confluence.macro.query with parameters of type SearchQuery

Modifier and Type	Method and Description
void	BooleanQueryFactory.addMust(SearchQuery query) Adds the specified SearchQuery to the "must match" criteria.
void	BooleanQueryFactory.addMustNot(SearchQuery query) Adds the specified SearchQuery to the "must not match" criteria.
void	BooleanQueryFactory.addShould(SearchQuery query) Adds the specified SearchQuery to the "should match" criteria.

Method parameters in com.atlassian.confluence.macro.query with type arguments of type SearchQuery

Modifier and Type	Method and Description
void	BooleanQueryFactory.addMust(Collection<? extends SearchQuery> queries) Adds the specified Collection<SearchQuery> to the "must match" criteria.
void	BooleanQueryFactory.addMustNot(Collection<? extends SearchQuery> queries) Adds the specified Collection<SearchQuery> to the "must not match" criteria.
void	BooleanQueryFactory.addShould(Collection<? extends SearchQuery> queries) Adds the specified Collection<SearchQuery> to the "should match" criteria.

Constructor parameters in com.atlassian.confluence.macro.query with type arguments of type SearchQuery

Constructor and Description
BooleanQueryFactory(Set<SearchQuery> must, Set<SearchQuery> should, Set<SearchQuery> mustNot) Constructs a BooleanQueryFactory with the specified SearchQueries as initial values.
BooleanQueryFactory(Set<SearchQuery> must, Set<SearchQuery> should, Set<SearchQuery> mustNot) Constructs a BooleanQueryFactory with the specified SearchQueries as initial values.
BooleanQueryFactory(Set<SearchQuery> must, Set<SearchQuery> should, Set<SearchQuery> mustNot) Constructs a BooleanQueryFactory with the specified SearchQueries as initial values.

Uses of SearchQuery in com.atlassian.confluence.plugin.descriptor.search

Methods in com.atlassian.confluence.plugin.descriptor.search that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	SearchQueryModuleDescriptor.newQuery(List parameters)

Uses of SearchQuery in com.atlassian.confluence.plugins.contentproperty.search.fields

Methods in com.atlassian.confluence.plugins.contentproperty.search.fields that return SearchQuery

Modifier and Type	Method and Description
protected SearchQuery	NumericContentPropertyAliasFieldHandler.createQuery(Double from, Double to, boolean includesFrom, boolean includesTo)

Uses of SearchQuery in com.atlassian.confluence.plugins.contentproperty.search.query

Methods in com.atlassian.confluence.plugins.contentproperty.search.query that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	ContentPropertySearchQueryFactory.buildNumberRangeQuery(ContentPropertySchemaField schemaField, Range<Double> range)
SearchQuery	ContentPropertySearchQueryFactory.buildStringEqualityQuery(ContentPropertySchemaField schemaField, String... value) Build a generic string equality query.
SearchQuery	ContentPropertySearchQueryFactory.buildTextQuery(ContentPropertySchemaField schemaField, String rawQuery)

Uses of SearchQuery in com.atlassian.confluence.plugins.retentionrules.impl.service.search.query

Classes in com.atlassian.confluence.plugins.retentionrules.impl.service.search.query that implement SearchQuery

Modifier and Type	Class and Description
class	RetentionRulesQuery Retention rules filter marker, which is used in v2 search to filter out spaces without retention policies.

Uses of SearchQuery in com.atlassian.confluence.rss

Methods in com.atlassian.confluence.rss that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	FeedCustomContentType.toSearchQuery()

Uses of SearchQuery in com.atlassian.confluence.search

Methods in com.atlassian.confluence.search that return SearchQuery

Modifier and Type	Method and Description
abstract SearchQuery	ReIndexOption.getDeleteQuery()

Methods in com.atlassian.confluence.search with parameters of type SearchQuery

Modifier and Type	Method and Description
ReIndexTask	IndexManager.reIndex(EnumSet<ReIndexOption> options, SearchQuery searchQuery) Triggers a system wide re-index.

Constructors in com.atlassian.confluence.search with parameters of type SearchQuery

Constructor and Description
ReIndexTask(ReIndexer reIndexer, SearchableDao searchableDao, Set<ReIndexOption> options, SearchQuery luceneQuery, int jobID) Deprecated. since 5.10

Constructor parameters in com.atlassian.confluence.search with type arguments of type SearchQuery

Constructor and Description
ReIndexTask(ReIndexer reIndexer, SearchableDao searchableDao, EnumSet<ReIndexOption> options, Optional<SearchQuery> searchQuery, int jobID)

Uses of SearchQuery in com.atlassian.confluence.search.contentnames

Methods in com.atlassian.confluence.search.contentnames that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	ContentNameSearchSectionSpec.getFilter()

Uses of SearchQuery in com.atlassian.confluence.search.lucene

Methods in com.atlassian.confluence.search.lucene with parameters of type SearchQuery

Modifier and Type	Method and Description
default ReIndexTask	ConfluenceIndexManager.reIndex(Set<ReIndexOption> options, SearchQuery searchQuery) Deprecated. since 5.10, use IndexManager.reIndex(EnumSet, SearchQuery)

Uses of SearchQuery in com.atlassian.confluence.search.plugin

Methods in com.atlassian.confluence.search.plugin that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	ContentTypeSearchDescriptor.getQuery()

Uses of SearchQuery in com.atlassian.confluence.search.service

Methods in com.atlassian.confluence.search.service that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	SearchQueryParameters.getSearchQueryFilter()

Methods in com.atlassian.confluence.search.service with parameters of type SearchQuery

Modifier and Type	Method and Description
void	SearchQueryParameters.setSearchQueryFilter(SearchQuery searchQueryFilter)

Uses of SearchQuery in com.atlassian.confluence.search.v2

Fields in com.atlassian.confluence.search.v2 declared as SearchQuery

Modifier and Type	Field and Description
protected SearchQuery	AbstractSearch.query

Methods in com.atlassian.confluence.search.v2 that return SearchQuery

Modifier and Type	Method and Description
SearchQuery	SiteSearchPermissionsQueryFactory.create()
SearchQuery	SpacePermissionQueryFactory.create(ConfluenceUser user)
default SearchQuery	SearchQuery.expand() Expands this query into a composite query (that composes other queries).
SearchQuery	DefaultHighlightParams.getQuery()
@NonNull SearchQuery	DefaultSearchWithToken.getQuery()
@NonNull SearchQuery	AbstractSearch.getQuery() Gets the query component of the search
default SearchQuery	HightlightParams.getQuery()
@NonNull SearchQuery	ISearch.getQuery()
SearchQuery	DefaultQueryFactory.newQuery(String queryKey)
SearchQuery	QueryFactory.newQuery(String queryKey) Generate a SearchQuery without parameters
SearchQuery	DefaultQueryFactory.newQuery(String queryKey, List parameters)
SearchQuery	QueryFactory.newQuery(String queryKey, List parameters) Generate a SearchQuery with parameters.
SearchQuery	QuerySerializer.stringToQuery(String s) Convert a string-form query back into object form.

Methods in com.atlassian.confluence.search.v2 that return types with arguments of type SearchQuery

Modifier and Type	Method and Description
Optional<SearchQuery>	ContentPermissionsQueryFactory.create(ConfluenceUser user)
default Stream<SubClause<SearchQuery>>	SearchQuery.getSubClauses() Returns a stream of nested queries.

Methods in com.atlassian.confluence.search.v2 with parameters of type SearchQuery

Modifier and Type	Method and Description
void	SearchIndexWriter.delete(SearchQuery searchQuery)
static String	QuerySerializer.queryToString(SearchQuery query) Convert a SearchQuery into a string form that can be transported over the wire, saved, and so on
long	ProfiledSearchManager.scan(EnumSet<SearchIndex> indexes, SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)
long	SearchManager.scan(EnumSet<SearchIndex> indexes, SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Execute Consumer.accept(T) for each search result.
long	ProfiledSearchManager.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)
long	DelegatingSearchIndexAccessor.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)
long	SearchIndexAccessor.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Scans the index for documents that match the provided searchQuery.
long	SearchManager.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Deprecated. since 7.9.0. Use SearchManager.scan(EnumSet, SearchQuery, Set, Consumer)
long	DelegatingSearchIndexAccessor.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<ScannedDocument> consumer, float defaultScore)
long	SearchIndexAccessor.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<ScannedDocument> consumer, float defaultScore) Scans the index for documents that match the provided searchQuery.

Constructors in com.atlassian.confluence.search.v2 with parameters of type SearchQuery

Constructor and Description
AbstractSearch(EnumSet<SearchIndex> indexes, @NonNull SearchQuery query, SearchSort sort) Constructs an abstract representation of a search to be performed.
AbstractSearch(EnumSet<SearchIndex> indexes, @NonNull SearchQuery query, SearchSort sort, int startOffset, int limit) Constructs an abstract representation of a search to be performed.
AbstractSearch(EnumSet<SearchIndex> indexes, SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit) Deprecated. since 7.20, use AbstractSearch(EnumSet, SearchQuery, SearchSort, int, int) instead. See SearchFilter deprecation for context.
AbstractSearch(EnumSet<SearchIndex> indexes, @NonNull SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit, ResultFilter resultFilter) Deprecated. since 7.20. Use AbstractSearch(EnumSet, SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecation for context.
AbstractSearch(EnumSet<SearchIndex> indexes, SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Deprecated. since 7.20, use AbstractSearch(EnumSet, SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecation for context.
AbstractSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit) Deprecated. since 7.9.0, use AbstractSearch(EnumSet, SearchQuery, SearchSort, int, int) instead. See SearchFilter deprecation for context. You must also now specify which indexes to perform the search on.
AbstractSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit, ResultFilter resultFilter) Deprecated. since 7.9.0, use AbstractSearch(EnumSet, SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecation for context. You must also now specify which indexes to perform the search on.
AbstractSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Deprecated. since 7.9.0, use AbstractSearch(EnumSet, SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecation for context. You must also now specify which indexes to perform the search on.
ChangesSearch(@NonNull SearchQuery query, SearchSort sort) Constructs a search against change information.
ChangesSearch(@NonNull SearchQuery query, SearchSort sort, int startOffset, int limit) Constructs a search against change information.
ChangesSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit) Deprecated. since 7.20, use ChangesSearch(SearchQuery, SearchSort, int, int) instead. See SearchFilter deprecation for context.
ChangesSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Deprecated. since 7.20, use ChangesSearch(SearchQuery, SearchSort) instead. See SearchFilter and ResultFilter deprecation for context.
ContentSearch(SearchQuery query, SearchSort sort) Constructs a search against Confluence content.
ContentSearch(SearchQuery query, SearchSort sort, int startOffset, int limit) Constructs a search against Confluence content.
ContentSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit) Deprecated. since 7.20, use ContentSearch(SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecations for context.
ContentSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Deprecated. since 7.20, use ContentSearch(SearchQuery, SearchSort) instead. See SearchFilter and ResultFilter deprecations for context.
CustomSearch(@NonNull SearchQuery query, SearchSort sort) Constructs a search against custom indexes.
CustomSearch(@NonNull SearchQuery query, SearchSort sort, int startOffset, int limit) Constructs a search against custom indexes.
CustomSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit) Deprecated. since 7.20, use CustomSearch(SearchQuery, SearchSort, int, int) instead. See SearchFilter deprecation for context.
CustomSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Deprecated. since 7.20, use CustomSearch(SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecation for context.
DefaultHighlightParams(SearchQuery query) Constructs a parameter object used for highlighting
DefaultHighlightParams(String encoder, SearchQuery query) Constructs a parameter object used for highlighting
DefaultSearch(EnumSet<SearchIndex> indexes, SearchQuery query, SearchSort sort, int startOffset, int limit)
DefaultSearch(EnumSet<SearchIndex> indexes, SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit)
DefaultSearch(EnumSet<SearchIndex> indexes, SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter)

Uses of SearchQuery in com.atlassian.confluence.search.v2.lucene

Classes in com.atlassian.confluence.search.v2.lucene with type parameters of type SearchQuery

Modifier and Type	Interface and Description
interface	LuceneQueryMapper<T extends SearchQuery> A lucene query mapper represents an object that is able to map from a Confluence SearchQuery to a Lucene Query.

Methods in com.atlassian.confluence.search.v2.lucene with parameters of type SearchQuery

Modifier and Type	Method and Description
org.apache.lucene.search.Query	DelegatingLuceneSearchMapper.convertToLuceneQuery(SearchQuery searchQuery)
long	LuceneSearchManager.scan(EnumSet<SearchIndex> indexes, SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Execute Consumer.accept(T) for each search result.
long	LuceneSearchManager.scan(SearchQuery searchQuery, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Execute Consumer.accept(T) for each search result.

Uses of SearchQuery in com.atlassian.confluence.search.v2.lucene.mapper

Classes in com.atlassian.confluence.search.v2.lucene.mapper with type parameters of type SearchQuery

Modifier and Type	Class and Description
class	AbstractTextFieldQueryMapper<T extends SearchQuery>
class	BaseConstantScoreQueryMapper<T extends SearchQuery> A base LuceneQueryMapper class that produces ConstantScoreQuery, removing any effect of the query from the lucene scoring, this is equivalent of using a LuceneFilter.

Methods in com.atlassian.confluence.search.v2.lucene.mapper with parameters of type SearchQuery

Modifier and Type	Method and Description
org.apache.lucene.search.Query	MatchNoDocsQueryMapper.convertToLuceneQuery(SearchQuery searchQuery)
org.apache.lucene.search.Query	PermittedSpacesQueryMapper.convertToLuceneQuery(SearchQuery searchQuery)

Uses of SearchQuery in com.atlassian.confluence.search.v2.query

Classes in com.atlassian.confluence.search.v2.query that implement SearchQuery

Modifier and Type	Class and Description
class	AbstractParameterListQuery<T> Abstract superclass for queries holding a list of parameters of a single type.
class	AbstractUserQuery
class	ActiveUserQuery Query which filters out documents representing users that are no longer active.
class	AllQuery Represent an entire set of documents.
class	ArchivedSpacesQuery Filters archived spaces (and their contents) out of search results.
class	AttachmentTypeQuery Search for attachments of a particular type or types.
class	BooleanQuery A boolean query that allows and/or and not combinations of sub queries.
class	BoostingQuery Deprecated. since 7.0 use FunctionScoreQuery instead.
class	BrowseUsersPermissionQuery
class	ConstantScoreQuery v2 primitive query
class	ContainingContentTypeQuery Search for an entity contained within content of a particular type.
class	ContentCategoryQuery SearchQuery that finds content where content type is from the list of specified categories
class	ContentPermissionsQuery
class	ContentStatusQuery SearchQuery which matches content by their content status.
class	ContentTypeQuery Search for content of a particular type.
class	ContributorQuery Creates a query to find content a user has contributed to (any edit or create is considered a contribution)
class	CreatorQuery Query for the original creator of content.
class	CustomContentTypeQuery This V2 query is used for filtering custom contents based on their types.
class	DateRangeQuery Query for search results that have been modified within the specified range of dates.
class	DoubleRangeQuery v2 primitive query
class	EnabledCustomContentTypesQuery A V2 SearchQuery implementation which only finds custom content which have been enabled, or non-custom content.
class	ExistsQuery Deprecated. since 7.20. Please use FieldExistsQuery instead. This query will be removed in 8.0 with CONFSRVDEV-23231
class	FieldExistsQuery A V2 SearchQuery implementation which finds documents which contain a specific field.
class	FileExtensionQuery Search for content with a particular file extension.
class	FunctionScoreQuery v2 primitive query that modifies the wrapped query score of a retrieved document by combining it according to FunctionScoreQuery.BoostMode with an value provided by ScoreFunction.
class	HasPersonalSpaceQuery Search for content belonging to a user who has a personal space.
class	InheritedLabelQuery Query for matching a single Label that was inherited from a piece of parent content, for example, searching for comments attached to pages with a certain label
class	InSpaceQuery Search using a set of space keys for content that occurs within some set of spaces.
class	IntegerRangeQuery v2 primitive query
class	LabelQuery Query for matching a single Label.
class	LabelsQuery Allows querying by multiple labels.
class	LastModifierUserQuery SearchQuery to find the content where the SearchFieldNames.LAST_MODIFIER field has to match one of the users in the provided last modifiers list
class	LongRangeQuery v2 primitive query
class	MacroStorageVersionQuery
class	MacroUsageQuery A search query that finds usages of a macro in a content entity object by the macro name.
class	MatchNoDocsQuery
class	MultiTextFieldQuery Represents a query against multiple fields.
class	NonViewableCustomContentTypeQuery A V2 SearchQuery implementation which only finds viewable custom content types or non-custom content.
class	NotAnonymousUserQuery SearchQuery that filters out anonymous users.
class	PermittedSpacesQuery Deprecated. since 3.0. Please use SpacePermissionsSearchFilter instead.
class	PhraseQuery v2 primitive query
class	PrefixQuery v2 primitive query
class	QueryStringQuery v2 primitive query
class	SiteTextSearchQuery Relocation from confluence-search plugin.
class	SpaceCategoryQuery Search for content within spaces of a particular category (or categories).
class	SpanNearQuery v2 primitive query
class	TermQuery v2 primitive query
class	TermRangeQuery v2 primitive query
class	TermSetQuery
class	TextFieldPrefixQuery Deprecated. since 7.0 This query is redundant, misleading. It is replaced by PrefixSearchFilter or PrefixQuery
class	TextFieldQuery Represents a raw query from the user that may be parsed.
class	TextQuery A multi text field query that searches across a range of text fields for the query string
class	TextSearchQuery This query represents a text search on a Lucene field.
class	UserInfoQuery SearchQuery for user info.
class	UserTextQuery Searches for text within common user-related text fields: full name, email address and username
class	WildcardTextFieldQuery

Methods in com.atlassian.confluence.search.v2.query that return SearchQuery

Modifier and Type	Method and Description
static SearchQuery	BooleanQuery.andQuery(SearchQuery... queries) Build an AND query from one or more subqueries.
SearchQuery	BooleanQuery.Builder.build()
static SearchQuery	BooleanQuery.composeAndQuery(Set<? extends SearchQuery> subqueries) Return a query that "ANDs" together a list of queries.
static SearchQuery	BooleanQuery.composeOrQuery(Set<? extends SearchQuery> subqueries) Return a query that "ORs" together a list of queries.
SearchQuery	BoostingQuery.expand() Deprecated. This primitive but is similar to BooleanQuery, which in some sense primitive but also need to implement expand method, because the wrapped query need to be expanded.
SearchQuery	ContentStatusQuery.expand()
SearchQuery	ContainingContentTypeQuery.expand()
SearchQuery	LabelsQuery.expand()
SearchQuery	HasPersonalSpaceQuery.expand()
SearchQuery	ContentCategoryQuery.expand()
SearchQuery	InSpaceQuery.expand()
SearchQuery	BooleanQuery.expand()
SearchQuery	BrowseUsersPermissionQuery.expand()
SearchQuery	DateRangeQuery.expand()
SearchQuery	WildcardTextFieldQuery.expand()
SearchQuery	NonViewableCustomContentTypeQuery.expand() Expands into a SearchQuery which will not find custom content which is not viewable.
SearchQuery	SpaceCategoryQuery.expand()
SearchQuery	SiteTextSearchQuery.expand() Rewrite it into function score query that boosts score by modified date.
SearchQuery	MacroUsageQuery.expand()
SearchQuery	ConstantScoreQuery.expand() This primitive but is similar to BooleanQuery, which in some sense primitive but also need to implement expand method, because the wrapped query need to be expanded.
SearchQuery	NotAnonymousUserQuery.expand()
SearchQuery	TextFieldPrefixQuery.expand() Deprecated.
SearchQuery	LabelQuery.expand()
SearchQuery	LastModifierUserQuery.expand()
SearchQuery	MultiTextFieldQuery.expand()
SearchQuery	FunctionScoreQuery.expand() This primitive but is similar to BooleanQuery, which in some sense primitive but also need to implement expand method, because the wrapped query need to be expanded.
SearchQuery	EnabledCustomContentTypesQuery.expand()
SearchQuery	CustomContentTypeQuery.expand()
SearchQuery	FileExtensionQuery.expand()
SearchQuery	ContributorQuery.expand()
SearchQuery	ArchivedSpacesQuery.expand()
SearchQuery	InheritedLabelQuery.expand()
SearchQuery	ActiveUserQuery.expand()
SearchQuery	AttachmentTypeQuery.expand()
SearchQuery	ContentTypeQuery.expand()
static SearchQuery	ContentStatusQuery.getDefaultContentStatusQuery() The default SearchQuery will only match content which has the current status.
SearchQuery	BoostingQuery.getWrappedQuery() Deprecated.
SearchQuery	ConstantScoreQuery.getWrappedQuery()
SearchQuery	FunctionScoreQuery.getWrappedQuery()
static SearchQuery	BooleanQuery.orQuery(SearchQuery... queries) Create a query that is the OR of the provided sub-queries
static SearchQuery	ContainingContentTypeQuery.searchForTypesWithinContainerType(ContentTypeEnum containerType, Set<ContentTypeEnum> contentTypes) Helper method for the common "Find me all attachments attached to pages" query - which would be ContainingContentTypeQuery.searchForTypesWithinContainerType(ContentTypeEnum.ATTACHMENT, ContentTypeEnum.PAGE)

Methods in com.atlassian.confluence.search.v2.query that return types with arguments of type SearchQuery

Modifier and Type	Method and Description
BooleanQueryBuilder<SearchQuery>	BooleanQuery.Builder.addFilter(SearchQuery filter)
BooleanQueryBuilder<SearchQuery>	BooleanQuery.Builder.addFilters(Set<SearchQuery> filters)
static BiFunction<String,Set<String>,SearchQuery>	TermSetQuery.builder()
static BiFunction<String,String,SearchQuery>	TermQuery.builder()
Set<SearchQuery>	BooleanQuery.getFilters()
Set<SearchQuery>	BooleanQuery.getMustNotQueries()
Set<SearchQuery>	BooleanQuery.getMustQueries()
Set<SearchQuery>	BooleanQuery.getShouldQueries()
Stream<SubClause<SearchQuery>>	BoostingQuery.getSubClauses() Deprecated.
Stream<SubClause<SearchQuery>>	BooleanQuery.getSubClauses()
Stream<SubClause<SearchQuery>>	ConstantScoreQuery.getSubClauses()
Stream<SubClause<SearchQuery>>	FunctionScoreQuery.getSubClauses()

Methods in com.atlassian.confluence.search.v2.query with parameters of type SearchQuery

Modifier and Type	Method and Description
BooleanQueryBuilder<SearchQuery>	BooleanQuery.Builder.addFilter(SearchQuery filter)
static SearchQuery	BooleanQuery.andQuery(SearchQuery... queries) Build an AND query from one or more subqueries.
static SearchQuery	BooleanQuery.orQuery(SearchQuery... queries) Create a query that is the OR of the provided sub-queries

Method parameters in com.atlassian.confluence.search.v2.query with type arguments of type SearchQuery

Modifier and Type	Method and Description
BooleanQueryBuilder<SearchQuery>	BooleanQuery.Builder.addFilters(Set<SearchQuery> filters)
static SearchQuery	BooleanQuery.composeAndQuery(Set<? extends SearchQuery> subqueries) Return a query that "ANDs" together a list of queries.
static SearchQuery	BooleanQuery.composeOrQuery(Set<? extends SearchQuery> subqueries) Return a query that "ORs" together a list of queries.

Constructors in com.atlassian.confluence.search.v2.query with parameters of type SearchQuery

Constructor and Description
BoostingQuery(SearchQuery wrappedQuery, SearchQueryParameters searchQueryParameters) Deprecated.
ConstantScoreQuery(SearchQuery wrappedQuery)
ConstantScoreQuery(SearchQuery query, float boost)
FunctionScoreQuery(SearchQuery wrappedQuery, ScoreFunction function, FunctionScoreQuery.BoostMode boostMode)

Constructor parameters in com.atlassian.confluence.search.v2.query with type arguments of type SearchQuery

Constructor and Description
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot) Construct a new BooleanQuery encapsulating the supplied sub queries with a default boost value.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot) Construct a new BooleanQuery encapsulating the supplied sub queries with a default boost value.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot) Construct a new BooleanQuery encapsulating the supplied sub queries with a default boost value.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters) Construct a new BooleanQuery encapsulating the supplied sub queries with the default boost.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters) Construct a new BooleanQuery encapsulating the supplied sub queries with the default boost.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters) Construct a new BooleanQuery encapsulating the supplied sub queries with the default boost.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters) Construct a new BooleanQuery encapsulating the supplied sub queries with the default boost.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, Collection<? extends SearchQuery> filters, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries without any filters.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries without any filters.
BooleanQuery(Collection<? extends SearchQuery> must, Collection<? extends SearchQuery> should, Collection<? extends SearchQuery> mustNot, float boost) Construct a new BooleanQuery encapsulating the supplied sub queries without any filters.
BooleanQuery(Set<? extends SearchQuery> must, Set<? extends SearchQuery> should, Set<? extends SearchQuery> mustNot) Deprecated. since 5.9 use BooleanQuery(Collection, Collection, Collection)
BooleanQuery(Set<? extends SearchQuery> must, Set<? extends SearchQuery> should, Set<? extends SearchQuery> mustNot) Deprecated. since 5.9 use BooleanQuery(Collection, Collection, Collection)
BooleanQuery(Set<? extends SearchQuery> must, Set<? extends SearchQuery> should, Set<? extends SearchQuery> mustNot) Deprecated. since 5.9 use BooleanQuery(Collection, Collection, Collection)

Uses of SearchQuery in com.atlassian.confluence.search.v2.searchfilter

Methods in com.atlassian.confluence.search.v2.searchfilter with type parameters of type SearchQuery

Modifier and Type	Method and Description
static <T extends SearchQuery> boolean	SearchFilterUtils.containsQuery(SearchQuery searchQuery, Class<T> searchQueryClass) Traverses the provided search query tree and checks whether it contains any queries of the specified class

Methods in com.atlassian.confluence.search.v2.searchfilter that return SearchQuery

Modifier and Type

Method and Description

static SearchQuery

SearchFilterUtils.appendQueryIfQueryAndFilterNotPresent(@Nullable SearchQuery searchQuery, SearchQuery searchQueryToCheck, SearchQuery searchQueryToAppend, @Nullable SearchFilter searchFilter, SearchFilter searchFilterToCheckFor) Append a search query as a top level AND query, iff both the search query and search filter to be appended and checked for respectively, do not exist in their respective search query and search filter trees to be checked against.

Methods in com.atlassian.confluence.search.v2.searchfilter with parameters of type SearchQuery

Modifier and Type	Method and Description
static SearchQuery	SearchFilterUtils.appendQueryIfQueryAndFilterNotPresent(@Nullable SearchQuery searchQuery, SearchQuery searchQueryToCheck, SearchQuery searchQueryToAppend, @Nullable SearchFilter searchFilter, SearchFilter searchFilterToCheckFor) Append a search query as a top level AND query, iff both the search query and search filter to be appended and checked for respectively, do not exist in their respective search query and search filter trees to be checked against.
static SearchQuery	SearchFilterUtils.appendQueryIfQueryAndFilterNotPresent(@Nullable SearchQuery searchQuery, SearchQuery searchQueryToCheck, SearchQuery searchQueryToAppend, @Nullable SearchFilter searchFilter, SearchFilter searchFilterToCheckFor) Append a search query as a top level AND query, iff both the search query and search filter to be appended and checked for respectively, do not exist in their respective search query and search filter trees to be checked against.
static <T extends SearchQuery> boolean	SearchFilterUtils.containsQuery(SearchQuery searchQuery, Class<T> searchQueryClass) Traverses the provided search query tree and checks whether it contains any queries of the specified class