Package com.atlassian.jira.issue.statistics

Class UserStatisticsMapper

java.lang.Object

com.atlassian.jira.issue.statistics.UserStatisticsMapper

All Implemented Interfaces:

SearchRequestAppender.Factory<ApplicationUser>, StatisticsMapper<ApplicationUser>, FieldValueLoader<ApplicationUser>

Direct Known Subclasses:

AssigneeStatisticsMapper, CreatorStatisticsMapper, CustomFieldUserStatisticsMapper, ReporterStatisticsMapper

public class UserStatisticsMapper
extends Object
implements StatisticsMapper<ApplicationUser>, SearchRequestAppender.Factory<ApplicationUser>

Field Summary

Fields

Modifier and Type	Field	Description
protected final JiraAuthenticationContext	jiraAuthenticationContext

Constructor Summary

Constructors

Constructor	Description
UserStatisticsMapper(UserFieldSearchConstantsWithEmpty searchConstants, UserManager userManager, JiraAuthenticationContext jiraAuthenticationContext)
UserStatisticsMapper(String clauseName, String emptyIndexValue, String indexedField, UserManager userManager, JiraAuthenticationContext jiraAuthenticationContext)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	field()	Get the field name that this field is indexed with.
protected String	getClauseName()
Comparator<ApplicationUser>	getComparator()	A comparator by which the resulting values should be ordered when multiple values are present.
SearchRequestAppender<ApplicationUser>	getSearchRequestAppender()
SearchRequest	getSearchUrlSuffix(ApplicationUser user, SearchRequest searchRequest)	Deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
int	hashCode()
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.
ApplicationUser	loadValue(String documentValue)	Convert the document field back to the object that you wish to use to display it.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

jiraAuthenticationContext

protected final JiraAuthenticationContext jiraAuthenticationContext

Constructor Details

UserStatisticsMapper

public UserStatisticsMapper(UserFieldSearchConstantsWithEmpty searchConstants,
 UserManager userManager,
 JiraAuthenticationContext jiraAuthenticationContext)

UserStatisticsMapper

public UserStatisticsMapper(String clauseName,
 String emptyIndexValue,
 String indexedField,
 UserManager userManager,
 JiraAuthenticationContext jiraAuthenticationContext)

Method Details

getComparator

public Comparator<ApplicationUser> getComparator()

Description copied from interface: FieldValueLoader

A comparator by which the resulting values should be ordered when multiple values are present.

The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.

Specified by:

getComparator in interface FieldValueLoader<ApplicationUser>

isValidValue

public boolean isValidValue(ApplicationUser value)

Description copied from interface: StatisticsMapper

Check whether this value is valid for this particular search. This is useful if you do not wish to display all the values that are indexed (eg - only show released versions)

Specified by:

isValidValue in interface StatisticsMapper<ApplicationUser>

Parameters:

value - This is the same value that will be returned from

invalid reference

#getValueFromLuceneField(String)

Returns:

true if this value is valid for this particular search

field

public String field()

Description copied from interface: FieldValueLoader

Get the field name that this field is indexed with.

Specified by:

field in interface FieldValueLoader<ApplicationUser>

loadValue

public ApplicationUser loadValue(String documentValue)

Description copied from interface: FieldValueLoader

Convert the document field back to the object that you wish to use to display it.

e.g. '1000' -> Version 1.

For custom fields, the return value will be passed to CustomFieldSearcherModuleDescriptor.getStatHtml(com.atlassian.jira.issue.fields.CustomField, Object, String)

Specified by:

loadValue in interface FieldValueLoader<ApplicationUser>

Parameters:

documentValue - The value of the field in the index or null if no values exist

Returns:

The value that will be passed to the display

isFieldAlwaysPartOfAnIssue

public boolean isFieldAlwaysPartOfAnIssue()

Description copied from interface: StatisticsMapper

Check if the field is always part of an issues' data. This should only return false in the case of a custom field where the value does not have to be set for each issue.

Specified by:

isFieldAlwaysPartOfAnIssue in interface StatisticsMapper<ApplicationUser>

Returns:

true if this mapper will always be part of an issues data

getSearchUrlSuffix

@Deprecated
public SearchRequest getSearchUrlSuffix(ApplicationUser user,
 SearchRequest searchRequest)

Deprecated.

Use #getSearchRequestAppender().appendInclusiveSingleValueClause()

Description copied from interface: StatisticsMapper

Get a suffix for the issue navigator, which allows for filtering on this value.

e.g. 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.

Specified by:

getSearchUrlSuffix in interface StatisticsMapper<ApplicationUser>

Parameters:

user - This is the same value that will be returned from

invalid reference

#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.

Returns:

a SearchRequest object that will generate the correct issue navigator url to search the correct statistics set, null otherwise.

See Also:

• URLEncoder.encode(String)

getSearchRequestAppender

public SearchRequestAppender<ApplicationUser> getSearchRequestAppender()

Specified by:

getSearchRequestAppender in interface SearchRequestAppender.Factory<ApplicationUser>

Since:

v6.0

getClauseName

protected String getClauseName()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object