| Package | Description |
|---|---|
| com.atlassian.confluence.hosted.search.v2.searchfilter | |
| com.atlassian.confluence.impl.search.v2 | |
| com.atlassian.confluence.plugins.retentionrules.impl.service.search.query | |
| com.atlassian.confluence.search.v2 |
Provides an extensible, flexible search API.
|
| com.atlassian.confluence.search.v2.query | |
| com.atlassian.confluence.search.v2.searchfilter | |
| com.atlassian.confluence.search.v2.sort |
| Modifier and Type | Class and Description |
|---|---|
class |
ExcludePersonalInformationSearchFilter
Deprecated.
since 7.20, use
TermQuery instead.
e.g
See |
| 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. |
| 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.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SearchFilter
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.
e.g.
Add filters to a query using |
interface |
SearchQuery
A query to be performed against the search index.
|
interface |
SearchSort
Represents some method for sorting search results, and the order in which to search them.
|
| 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 |
| Modifier and Type | Method and Description |
|---|---|
static <T extends Expandable<T>> |
SearchExpander.expandAll(Collection<T> expandables) |
static <T extends Expandable<T>> |
SearchExpander.expandAll(T expandable) |
| 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 |
| 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 |
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 |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractSort
Abstract superclass for simple sort types that just sort in a particular direction on some field.
|
class |
ContentIdSort
Sort content by its id that is stored as part of the handle field in Lucene index.
|
class |
CreatedSort
Order search results by time created
|
class |
FavouriteSort
Order search results by favourite date.
|
class |
FieldSort
Sort based on value of a field.
|
class |
FilenameSort
Sort based on an attachment's filename.
|
class |
FilesizeSort |
class |
FullnameSort
Sort by a user's full name
|
class |
LowercaseFieldSort
Sort based on lower case value of a keyword field.
|
class |
ModifiedSort
Order search results by time last modified
|
class |
MultiSearchSort
This composite SearchSort that allows sort by multiple fields.
|
class |
RelevanceSort
Order search results most relevant first.
|
class |
TitleSort
Order search results by title
|
class |
UserAttributeSort
A base user sort that allows userkey fields to be sorted on either UserKey, Username, Full name or Email.
|
Copyright © 2003–2022 Atlassian. All rights reserved.