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 Excludes Personal Information Objects from the search results.

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
SearchFilter	ContentNameSearchSectionSpec.getSearchFilter() Search index filter that accepts only desire content entities.

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 A super class that defines standard AND and OR chaining behaviour.

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	SearchFilter.and(SearchFilter other) Combines this filter with the one specified, returning a new filter.
SearchFilter	AbstractChainableSearchFilter.and(SearchFilter other)
default SearchFilter	SearchFilter.expand() Expands this filter into a composite filter (that composes other filters).
SearchFilter	AbstractSearch.getSearchFilter()
SearchFilter	ISearch.getSearchFilter()
SearchFilter	DefaultSearchWithToken.getSearchFilter()
SearchFilter	SearchManager.Categorizer.getSearchFilter(T category) Returns search filter of the given category.
SearchFilter	SearchFilter.or(SearchFilter other) Combines this filter with the one specified, returning a new filter.
SearchFilter	AbstractChainableSearchFilter.or(SearchFilter other)

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

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

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

Constructor and Description
AbstractSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit)
AbstractSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit, ResultFilter resultFilter)
AbstractSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter)
ChangesSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit)
ChangesSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter)
ChangesSearch(SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter)
ContentSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit)
ContentSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, ResultFilter resultFilter) Construct a new Search.
DefaultSearch(SearchQuery query, SearchSort sort, SearchFilter searchFilter, int startOffset, int limit)
DefaultSearch(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)

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 Filters out documents representing users that are nolonger active e.g.
class	AnonymousUserInfoSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	ArchivedSpacesSearchFilter Filters archived spaces (and their contents) out of search results.
class	AttachmentTypeSearchFilter
class	AuthorSearchFilter Filter by a query on author.
class	BooleanSearchFilter
class	ChainedSearchFilter Deprecated. since 5.10, use BooleanSearchFilter instead
class	ContentCategorySearchFilter
class	ContentPermissionsSearchFilter Filter for performing filtering by content permissions.
class	ContentStatusFilter Filter content out of search results based on their content status, e.g.
class	CustomContentTypeSearchFilter
class	DeactivatedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	DisabledContentTypeSearchFilter The logic is from DisabledContentTypeFilterFactory in confluence-search plugin.
class	ExcludedContentTypeSearchFilter A filter used to exclude certain content types from Site Searches.
class	ExternallyDeletedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	FieldValueSearchFilter v2 primitive filter
class	InSpaceSearchFilter Filters for documents that belong to spaces with the specified space keys.
class	LabelsSearchFilter Allows filtering by multiple labels.
class	LastModifierSearchFilter Deprecated. since 5.2. Use LastModifierUserSearchFilter instead.
class	LastModifierUserSearchFilter Filter on the DocumentFieldName.LAST_MODIFIER_NAME field.
class	MatchAllDocsFilter Represent an entire set of documents
class	MatchNoDocsFilter Represent an empty set of documents
class	NonViewableContentTypeSearchFilter The logic is from NonViewableContentTypeFilterFactory in confluence-search plugin.
class	PrefixSearchFilter v2 primitive filter
class	SearchResultTypeSearchFilter Filter by SearchResultType.
class	ShadowedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	SiteSearchPermissionsSearchFilter The filter used to apply permission in Site Search.
class	SpaceCategorySearchFilter
class	SpacePermissionsSearchFilter Filters by the spaces a user can see.
class	TermRangeSearchFilter v2 primitive filter, use in ES code path only.
class	TermSearchFilter v2 primitive filter
class	TextSearchFilter v2 primitive filter
class	UnlicensedUserSearchFilter Deprecated. since 6.7 use ActiveUserSearchFilter instead.
class	ViewUserProfilePermissionsSearchFilter Filter for filtering out statuses if there is no view user profile permission.

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 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	BooleanSearchFilter.and(SearchFilter other)
SearchFilter	ChainedSearchFilter.and(SearchFilter other) Deprecated.
SearchFilter	MatchNoDocsFilter.and(SearchFilter other)
SearchFilter	MatchAllDocsFilter.and(SearchFilter other)
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
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, boolean expanded) Deprecated. since 5.10
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, float ignore)
SearchFilter	ViewUserProfilePermissionsSearchFilter.expand()
SearchFilter	SpaceCategorySearchFilter.expand()
SearchFilter	ContentStatusFilter.expand()
SearchFilter	BooleanSearchFilter.expand()
SearchFilter	ChainedSearchFilter.expand() Deprecated.
SearchFilter	AnonymousUserInfoSearchFilter.expand() Deprecated.
SearchFilter	NonViewableContentTypeSearchFilter.expand()
SearchFilter	ExternallyDeletedUserSearchFilter.expand() Deprecated.
SearchFilter	SearchResultTypeSearchFilter.expand()
SearchFilter	ExcludedContentTypeSearchFilter.expand() The logic is from ExcludedContentTypeSearchFilterMapper in confluence-search plugin.
SearchFilter	ArchivedSpacesSearchFilter.expand()
SearchFilter	ShadowedUserSearchFilter.expand() Deprecated.
SearchFilter	SiteSearchPermissionsSearchFilter.expand()
SearchFilter	LastModifierUserSearchFilter.expand()
SearchFilter	LabelsSearchFilter.expand()
SearchFilter	DisabledContentTypeSearchFilter.expand()
SearchFilter	SpacePermissionsSearchFilter.expand()
SearchFilter	DeactivatedUserSearchFilter.expand() Deprecated.
SearchFilter	UnlicensedUserSearchFilter.expand() Deprecated.
SearchFilter	InSpaceSearchFilter.expand()
static SearchFilter	MatchNoDocsFilter.getInstance()
static SearchFilter	MatchAllDocsFilter.getInstance()
SearchFilter	BooleanSearchFilter.or(SearchFilter other)
SearchFilter	ChainedSearchFilter.or(SearchFilter other) Deprecated.
SearchFilter	MatchNoDocsFilter.or(SearchFilter other)
SearchFilter	MatchAllDocsFilter.or(SearchFilter other)

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()
static Collection<SearchFilter>	SearchFilterUtils.expandFilter(SearchFilter filter) If the provided filter is a chained filter, return the top level list of filters in the chain.
List<SearchFilter>	ChainedSearchFilter.getFilters() Deprecated.
Set<SearchFilter>	BooleanSearchFilter.getMust()
Set<SearchFilter>	BooleanSearchFilter.getMustNot()
Set<SearchFilter>	BooleanSearchFilter.getShould()

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

Modifier and Type	Method and Description
SearchFilter	BooleanSearchFilter.and(SearchFilter other)
SearchFilter	ChainedSearchFilter.and(SearchFilter other) Deprecated.
SearchFilter	MatchNoDocsFilter.and(SearchFilter other)
SearchFilter	MatchAllDocsFilter.and(SearchFilter other)
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 <T extends SearchFilter> boolean	SearchFilterUtils.containsFilter(SearchFilter filter, Class<T> filterClass) Traverses the provided tree and checks whether it contains any filters of the specified class
static Collection<SearchFilter>	SearchFilterUtils.expandFilter(SearchFilter filter) If the provided filter is a chained filter, return the top level list of filters in the chain.
SearchFilter	BooleanSearchFilter.or(SearchFilter other)
SearchFilter	ChainedSearchFilter.or(SearchFilter other) Deprecated.
SearchFilter	MatchNoDocsFilter.or(SearchFilter other)
SearchFilter	MatchAllDocsFilter.or(SearchFilter other)

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

Modifier and Type	Method and Description
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, boolean expanded) Deprecated. since 5.10
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, boolean expanded) Deprecated. since 5.10
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, boolean expanded) Deprecated. since 5.10
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, float ignore)
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, float ignore)
protected SearchFilter	BooleanSearchFilter.Builder.combine(Collection<SearchFilter> must, Collection<SearchFilter> should, Collection<SearchFilter> mustNot, float ignore)

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)
BooleanSearchFilter(Collection<? extends SearchFilter> must, Collection<? extends SearchFilter> should, Collection<? extends SearchFilter> mustNot)
BooleanSearchFilter(Collection<? extends SearchFilter> must, Collection<? extends SearchFilter> should, Collection<? extends SearchFilter> mustNot)
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.