com.atlassian.jira.issue.statistics
Class CustomFieldLabelsStatisticsMapper

java.lang.Object
  com.atlassian.jira.issue.statistics.LabelsStatisticsMapper
      com.atlassian.jira.issue.statistics.CustomFieldLabelsStatisticsMapper

All Implemented Interfaces:

LuceneFieldSorter, SearchRequestAppender.Factory, StatisticsMapper

public class CustomFieldLabelsStatisticsMapper
extends LabelsStatisticsMapper
implements SearchRequestAppender.Factory

Since:

v4.2

Constructor Summary

CustomFieldLabelsStatisticsMapper(CustomField customField, CustomFieldInputHelper customFieldInputHelper, JiraAuthenticationContext authenticationContext, boolean includeEmpty)

Method Summary

protected String	getClauseName()
SearchRequestAppender	getSearchRequestAppender()
SearchRequest	getSearchUrlSuffix(Object value, SearchRequest searchRequest) Deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()

Methods inherited from class com.atlassian.jira.issue.statistics.LabelsStatisticsMapper

getComparator, getDocumentConstant, getValueFromLuceneField, isFieldAlwaysPartOfAnIssue, isValidValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.search.LuceneFieldSorter

equals, hashCode

Constructor Detail

CustomFieldLabelsStatisticsMapper

public CustomFieldLabelsStatisticsMapper(CustomField customField,
                                         CustomFieldInputHelper customFieldInputHelper,
                                         JiraAuthenticationContext authenticationContext,
                                         boolean includeEmpty)

Method Detail

getClauseName

protected String getClauseName()

Overrides:

getClauseName in class LabelsStatisticsMapper

getSearchUrlSuffix

@Deprecated
public SearchRequest getSearchUrlSuffix(Object value,
                                                   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.

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.

Specified by:

getSearchUrlSuffix in interface StatisticsMapper

Overrides:

getSearchUrlSuffix in class LabelsStatisticsMapper

Parameters:

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

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 getSearchRequestAppender()

Specified by:

getSearchRequestAppender in interface SearchRequestAppender.Factory

Overrides:

getSearchRequestAppender in class LabelsStatisticsMapper

Since:

v6.0