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

Packages that use SearchFilter

Package	Description
com.atlassian.confluence.hosted.search.v2.searchfilter
com.atlassian.confluence.internal.search
com.atlassian.confluence.search.contentnames
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.searchfilter

Uses of SearchFilter in com.atlassian.confluence.hosted.search.v2.searchfilter

Classes in com.atlassian.confluence.hosted.search.v2.searchfilter that implement SearchFilter

Modifier and Type	Class and Description
class	ExcludePersonalInformationSearchFilter Deprecated. since 7.20, use TermQuery instead. e.g new TermQuery(SearchFieldNames.CLASS_NAME, PersonalInformation.class.getName()); will find only PersonalInformation. Negate it in a BooleanQuery to exclude PersonalInformation. See SearchFilter deprecation for context.

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

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

Modifier and Type	Method and Description
long	DecoratedSearchManager.scan(SearchFilter searchFilter, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)

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

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

Modifier and Type	Method and Description
default SearchFilter	ContentNameSearchSectionSpec.getSearchFilter() Deprecated. since 7.20. Please use ContentNameSearchSectionSpec.getFilter() instead. Will be removed when Lucene is upgraded to a version which no longer uses filters.

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

Classes in com.atlassian.confluence.search.v2 that implement SearchFilter

Modifier and Type	Class and Description
class	AbstractChainableSearchFilter Deprecated. since 7.20. There will be no replacement to extend. Use BooleanQuery to chain equivalent SearchQuery. See SearchFilter deprecation for context.

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

Modifier and Type	Field and Description
protected SearchFilter	AbstractSearch.searchFilter

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

Modifier and Type	Method and Description
SearchFilter	AbstractChainableSearchFilter.and(SearchFilter other) Deprecated.
SearchFilter	SearchFilter.and(SearchFilter other) Deprecated. Combines this filter with the one specified, returning a new filter.
default SearchFilter	SearchFilter.expand() Deprecated. Expands this filter into a composite filter (that composes other filters).
SearchFilter	DefaultSearchWithToken.getSearchFilter() Deprecated. since 7.20, SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
SearchFilter	AbstractSearch.getSearchFilter() Deprecated. since 7.20, SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
default SearchFilter	ISearch.getSearchFilter() Deprecated. since 7.20, SearchFilter has been replaced by SearchQuery. It will be removed when Lucene is upgraded to a version which no longer supports Filter.
SearchFilter	SearchManager.Categorizer.getSearchFilter(T category) Returns search filter of the given category.
SearchFilter	AbstractChainableSearchFilter.or(SearchFilter other) Deprecated.
SearchFilter	SearchFilter.or(SearchFilter other) Deprecated. Combines this filter with the one specified, returning a new filter.

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

Modifier and Type	Method and Description
default Stream<SubClause<SearchFilter>>	SearchFilter.getSubClauses() Deprecated. Returns a stream of nested filters.

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

Modifier and Type	Method and Description
SearchFilter	AbstractChainableSearchFilter.and(SearchFilter other) Deprecated.
SearchFilter	SearchFilter.and(SearchFilter other) Deprecated. Combines this filter with the one specified, returning a new filter.
SearchFilter	AbstractChainableSearchFilter.or(SearchFilter other) Deprecated.
SearchFilter	SearchFilter.or(SearchFilter other) Deprecated. Combines this filter with the one specified, returning a new filter.
long	ProfiledSearchManager.scan(SearchFilter searchFilter, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer)
long	SearchManager.scan(SearchFilter searchFilter, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Deprecated. since 7.0. use SearchManager.scan(EnumSet, SearchQuery, Set, Consumer) instead.

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

Constructor and Description
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(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.
ChangesSearch(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, 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(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.
CustomSearch(SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Deprecated. since 7.20, use CustomSearch(SearchQuery, SearchSort, int, int) instead. See SearchFilter and ResultFilter deprecation for context.
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 SearchFilter in com.atlassian.confluence.search.v2.lucene

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

Modifier and Type	Interface and Description
interface	LuceneSearchFilterMapper<T extends SearchFilter> Deprecated. since 7.0 use expand() instead.

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

Modifier and Type	Method and Description
org.apache.lucene.search.Filter	DelegatingLuceneSearchMapper.convertToLuceneSearchFilter(SearchFilter searchFilter)
long	LuceneSearchManager.scan(SearchFilter searchFilter, Set<String> requestedFields, Consumer<Map<String,String[]>> consumer) Execute Consumer.accept(T) for each search result.

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

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

Modifier and Type	Method and Description
org.apache.lucene.search.Filter	SiteSearchPermissionsSearchFilterMapper.convertToLuceneSearchFilter(SearchFilter searchFilter) Deprecated.

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

Classes in com.atlassian.confluence.search.v2.searchfilter that implement SearchFilter

Modifier and Type	Class and Description
class	ActiveUserSearchFilter Deprecated. since 7.20 use ActiveUserQuery instead. Will be removed when Lucene is upgraded to a version which no longer uses filters.
class	AnonymousUserInfoSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	ArchivedSpacesSearchFilter Deprecated. since 7.20 use ArchivedSpacesQuery instead.
class	AttachmentTypeSearchFilter Deprecated. since 7.20 use AttachmentTypeQuery instead. Will be removed when Lucene is upgraded to a version which no longer uses filters.
class	AuthorSearchFilter Deprecated. since 7.20. Please use UserInfoQuery instead. Will be removed when Lucene is upgraded to a version where Filter is no longer supported.
class	BooleanSearchFilter Deprecated. since 7.20 use BooleanQuery instead.
class	ChainedSearchFilter Deprecated. since 5.10, use BooleanSearchFilter instead
class	ContentCategorySearchFilter Deprecated. since 7.20. Please use ContentCategoryQuery instead. Will be removed when Lucene is upgraded to a version which no longer uses filters.
class	ContentPermissionsSearchFilter Deprecated. since 7.16. Please use ContentPermissionsQuery instead.
class	ContentStatusFilter Deprecated. since 7.20, use ContentStatusQuery instead. Notable change is that no IllegalArgumentException will be thrown where no content statuses are provided. Instead, all content will be matched by this query.
class	CustomContentTypeSearchFilter Deprecated. since 7.20. Please use CustomContentTypeQuery instead. This class will be removed in 8.0 with CONFSRVDEV-23116
class	DeactivatedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	DisabledContentTypeSearchFilter Deprecated. since 7.20 use EnabledCustomContentTypesQuery instead. Will be removed when Lucene is upgraded to a version where Filter is no longer supported.
class	ExcludedContentTypeSearchFilter Deprecated. since 7.20 use NonViewableCustomContentTypeQuery instead. Will be removed when Lucene is upgraded to a version which no longer supports Filter.
class	ExternallyDeletedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	FieldValueSearchFilter Deprecated. since 7.20. Use FieldExistsQuery instead. This class and its mapper class will be removed in 8.0 with CONFSRVDEV-23231
class	InSpaceSearchFilter Deprecated. since 7.20, remove in 8.0. Use InSpaceQuery instead.
class	LabelsSearchFilter Deprecated. since 7.20. This class will be removed in 8.0 with CONFSRVDEV-23110
class	LastModifierSearchFilter Deprecated. since 5.2. Use LastModifierUserSearchFilter instead.
class	LastModifierUserSearchFilter Deprecated. since 7.20 use LastModifierUserQuery instead. Will be removed when Lucene is upgraded to a version which no longer uses filters.
class	MatchAllDocsFilter Deprecated. since 7.20. This filter is replaced with AllQuery and will be removed in 8.0 with CONFSRVDEV-23162
class	MatchNoDocsFilter Deprecated. since 7.20. Use MatchNoDocsQuery instead. Will be removed in 8.0 with CONFSRVDEV-23162
class	NonViewableContentTypeSearchFilter Deprecated. since 7.20, please use NonViewableCustomContentTypeQuery instead. See SearchFilter deprecation for context.
class	PrefixSearchFilter Deprecated. since 7.20. will be removed in 8.0 with CONFSRVDEV-23110
class	SearchResultTypeSearchFilter Deprecated. since 7.9.0. This can be replaced by SearchIndex
class	ShadowedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	SiteSearchPermissionsSearchFilter Deprecated. since 7.20, will be removed in 8.0. Use SiteSearchPermissionsQuery instead.
class	SpaceCategorySearchFilter Deprecated. since 7.20.
class	SpacePermissionsSearchFilter Deprecated. since 7.20 use SpacePermissionQueryFactory.create(ConfluenceUser) instead.
class	TermRangeSearchFilter Deprecated. since 7.20. To be removed in 8.0
class	TermSearchFilter Deprecated. since 7.20. Please use TermQuery instead. To be removed in 8.0 with CONFSRVDEV-23232
class	TextSearchFilter Deprecated. since 7.20. Will be removed in 8.0 with CONFSRVDEV-23115
class	UnlicensedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	ViewUserProfilePermissionsSearchFilter Deprecated. since 7.20. Use BrowseUsersPermissionQuery instead

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

Modifier and Type	Method and Description
static <T extends SearchFilter> boolean	SearchFilterUtils.containsFilter(SearchFilter filter, Class<T> filterClass) Traverses the provided filter tree and checks whether it contains any filters of the specified class

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

Modifier and Type	Method and Description
SearchFilter	MatchNoDocsFilter.and(SearchFilter other) Deprecated.
SearchFilter	ChainedSearchFilter.and(SearchFilter other) Deprecated.
SearchFilter	MatchAllDocsFilter.and(SearchFilter other) Deprecated.
SearchFilter	BooleanSearchFilter.and(SearchFilter other) Deprecated.
static SearchFilter	SearchFilterUtils.appendFilterIfNotPresent(SearchFilter filter, SearchFilter filterToAppend) Append the specified filter as a top-level filter with an AND operator if it doesn't exist anywhere in the tree
SearchFilter	BooleanSearchFilter.Builder.build()
SearchFilter	ExternallyDeletedUserSearchFilter.expand() Deprecated.
SearchFilter	ExcludedContentTypeSearchFilter.expand() Deprecated. The logic is from ExcludedContentTypeSearchFilterMapper in confluence-search plugin.
SearchFilter	SearchResultTypeSearchFilter.expand() Deprecated.
SearchFilter	SiteSearchPermissionsSearchFilter.expand() Deprecated.
SearchFilter	ChainedSearchFilter.expand() Deprecated.
SearchFilter	LabelsSearchFilter.expand() Deprecated.
SearchFilter	ContentStatusFilter.expand() Deprecated.
SearchFilter	SpacePermissionsSearchFilter.expand() Deprecated.
SearchFilter	InSpaceSearchFilter.expand() Deprecated.
SearchFilter	ShadowedUserSearchFilter.expand() Deprecated.
SearchFilter	UnlicensedUserSearchFilter.expand() Deprecated.
SearchFilter	ViewUserProfilePermissionsSearchFilter.expand() Deprecated.
SearchFilter	ArchivedSpacesSearchFilter.expand() Deprecated.
SearchFilter	SpaceCategorySearchFilter.expand() Deprecated.
SearchFilter	LastModifierUserSearchFilter.expand() Deprecated.
SearchFilter	DisabledContentTypeSearchFilter.expand() Deprecated.
SearchFilter	DeactivatedUserSearchFilter.expand() Deprecated.
SearchFilter	NonViewableContentTypeSearchFilter.expand() Deprecated.
SearchFilter	BooleanSearchFilter.expand() Deprecated.
SearchFilter	AnonymousUserInfoSearchFilter.expand() Deprecated.
static SearchFilter	MatchNoDocsFilter.getInstance() Deprecated.
static SearchFilter	MatchAllDocsFilter.getInstance() Deprecated.
SearchFilter	MatchNoDocsFilter.or(SearchFilter other) Deprecated.
SearchFilter	ChainedSearchFilter.or(SearchFilter other) Deprecated.
SearchFilter	MatchAllDocsFilter.or(SearchFilter other) Deprecated.
SearchFilter	BooleanSearchFilter.or(SearchFilter other) Deprecated.

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

Modifier and Type	Method and Description
static BiFunction<String,String,SearchFilter>	TermSearchFilter.builder() Deprecated.
static Collection<SearchFilter>	SearchFilterUtils.expandFilter(SearchFilter filter) Collect all atomic filters from a given filter tree.
List<SearchFilter>	ChainedSearchFilter.getFilters() Deprecated.
Set<SearchFilter>	BooleanSearchFilter.getMust() Deprecated.
Set<SearchFilter>	BooleanSearchFilter.getMustNot() Deprecated.
Set<SearchFilter>	BooleanSearchFilter.getShould() Deprecated.
Stream<SubClause<SearchFilter>>	ChainedSearchFilter.getSubClauses() Deprecated.
Stream<SubClause<SearchFilter>>	BooleanSearchFilter.getSubClauses() Deprecated.

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

Modifier and Type	Method and Description
SearchFilter	MatchNoDocsFilter.and(SearchFilter other) Deprecated.
SearchFilter	ChainedSearchFilter.and(SearchFilter other) Deprecated.
SearchFilter	MatchAllDocsFilter.and(SearchFilter other) Deprecated.
SearchFilter	BooleanSearchFilter.and(SearchFilter other) Deprecated.
static SearchFilter	SearchFilterUtils.appendFilterIfNotPresent(SearchFilter filter, SearchFilter filterToAppend) Append the specified filter as a top-level filter with an AND operator if it doesn't exist anywhere in the tree
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 SearchFilter> boolean	SearchFilterUtils.containsFilter(SearchFilter filter, Class<T> filterClass) Traverses the provided filter tree and checks whether it contains any filters of the specified class
static Collection<SearchFilter>	SearchFilterUtils.expandFilter(SearchFilter filter) Collect all atomic filters from a given filter tree.
SearchFilter	MatchNoDocsFilter.or(SearchFilter other) Deprecated.
SearchFilter	ChainedSearchFilter.or(SearchFilter other) Deprecated.
SearchFilter	MatchAllDocsFilter.or(SearchFilter other) Deprecated.
SearchFilter	BooleanSearchFilter.or(SearchFilter other) Deprecated.

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

Constructor and Description
ChainedSearchFilter(SearchFilter... filters) Deprecated. Constructs a chained search filter that AND's the list of specified filters.

Constructor parameters in com.atlassian.confluence.search.v2.searchfilter with type arguments of type SearchFilter

Constructor and Description
BooleanSearchFilter(Collection<? extends SearchFilter> must, Collection<? extends SearchFilter> should, Collection<? extends SearchFilter> mustNot) Deprecated.
BooleanSearchFilter(Collection<? extends SearchFilter> must, Collection<? extends SearchFilter> should, Collection<? extends SearchFilter> mustNot) Deprecated.
BooleanSearchFilter(Collection<? extends SearchFilter> must, Collection<? extends SearchFilter> should, Collection<? extends SearchFilter> mustNot) Deprecated.
ChainedSearchFilter(List<? extends SearchFilter> filters, ChainedSearchFilter.Operator logicOperator) Deprecated. Constructs a chained search filter.
ChainedSearchFilter(List<? extends SearchFilter> filters, List<ChainedSearchFilter.Operator> logicOperators) Deprecated. Constructs a chained search filter.