public class UserStatisticsMapper extends Object implements StatisticsMapper<ApplicationUser>, SearchRequestAppender.Factory<ApplicationUser>
Modifier and Type | Field and Description |
---|---|
protected JiraAuthenticationContext |
jiraAuthenticationContext |
Constructor and Description |
---|
UserStatisticsMapper(String clauseName,
String emptyIndexValue,
String indexedField,
UserManager userManager,
JiraAuthenticationContext jiraAuthenticationContext) |
UserStatisticsMapper(UserFieldSearchConstantsWithEmpty searchConstants,
UserManager userManager,
JiraAuthenticationContext jiraAuthenticationContext) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
As this object is used as a key in a cache, this method must be provided and respect all internal state.
|
protected String |
getClauseName() |
Comparator<ApplicationUser> |
getComparator()
A comparator that can be used to order objects returned by
LuceneFieldSorter.getValueFromLuceneField(String) . |
String |
getDocumentConstant()
Get the constant that this field is indexed with.
|
SearchRequestAppender<ApplicationUser> |
getSearchRequestAppender() |
SearchRequest |
getSearchUrlSuffix(ApplicationUser user,
SearchRequest searchRequest)
Deprecated.
Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
|
ApplicationUser |
getValueFromLuceneField(String documentValue)
Convert the lucene document field back to the object that you wish to use to display it.
|
int |
hashCode()
As this object is used as a key in a cache, this method must be provided and respect all internal state.
|
boolean |
isFieldAlwaysPartOfAnIssue()
Check if the field is always part of an issues data.
|
boolean |
isValidValue(ApplicationUser value)
Check whether this value is valid for this particular search.
|
protected final JiraAuthenticationContext jiraAuthenticationContext
public UserStatisticsMapper(UserFieldSearchConstantsWithEmpty searchConstants, UserManager userManager, JiraAuthenticationContext jiraAuthenticationContext)
public UserStatisticsMapper(String clauseName, String emptyIndexValue, String indexedField, UserManager userManager, JiraAuthenticationContext jiraAuthenticationContext)
public Comparator<ApplicationUser> getComparator()
LuceneFieldSorter
LuceneFieldSorter.getValueFromLuceneField(String)
.
The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.
getComparator
in interface LuceneFieldSorter<ApplicationUser>
public boolean isValidValue(ApplicationUser value)
StatisticsMapper
isValidValue
in interface StatisticsMapper<ApplicationUser>
value
- This is the same value that will be returned from LuceneFieldSorter.getValueFromLuceneField(String)
public ApplicationUser getValueFromLuceneField(String documentValue)
LuceneFieldSorter
eg. '1000' -> Version 1.
For custom fields, the return value will be passed to
CustomFieldSearcherModuleDescriptor.getStatHtml(com.atlassian.jira.issue.fields.CustomField, Object, String)
getValueFromLuceneField
in interface LuceneFieldSorter<ApplicationUser>
documentValue
- The value of the field in the lucene indexpublic boolean isFieldAlwaysPartOfAnIssue()
StatisticsMapper
isFieldAlwaysPartOfAnIssue
in interface StatisticsMapper<ApplicationUser>
@Deprecated public SearchRequest getSearchUrlSuffix(ApplicationUser user, SearchRequest searchRequest)
StatisticsMapper
eg. a project field would return a SearchRequest object who's getQueryString method will produce
pid=10240
Note that values returned from implementations should return values that are URLEncoded.
getSearchUrlSuffix
in interface StatisticsMapper<ApplicationUser>
user
- This is the same value that will be returned from LuceneFieldSorter.getValueFromLuceneField(String)
searchRequest
- is the search request that should be used as the base of the newly generated
SearchRequest object. If this parameter is null then the return type will also be null.URLEncoder.encode(String)
public SearchRequestAppender<ApplicationUser> getSearchRequestAppender()
getSearchRequestAppender
in interface SearchRequestAppender.Factory<ApplicationUser>
protected String getClauseName()
public String getDocumentConstant()
LuceneFieldSorter
getDocumentConstant
in interface LuceneFieldSorter<ApplicationUser>
CustomFieldSearcher
public boolean equals(Object o)
LuceneFieldSorter
See the class javadoc entry for more details.
equals
in interface LuceneFieldSorter<ApplicationUser>
equals
in class Object
public int hashCode()
LuceneFieldSorter
See the class javadoc entry for more details.
hashCode
in interface LuceneFieldSorter<ApplicationUser>
hashCode
in class Object
Copyright © 2002-2022 Atlassian. All Rights Reserved.