@Internal public class

CascadingSelectStatisticsMapper

extends Object
implements SearchRequestAppender.Factory<T> ValueStatisticMapper<T>
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.statistics.CascadingSelectStatisticsMapper

@Internal

This class is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Summary

Constants
String PARENT_AND_CHILD_INDEX_SEPARATOR
String SUB_VALUE_SUFFIX
Public Constructors
CascadingSelectStatisticsMapper(CustomField customField, SelectConverter selectConverter, JiraAuthenticationContext authenticationContext, CustomFieldInputHelper customFieldInputHelper)
Public Methods
Comparator<CascadingOption> getComparator()
A comparator that can be used to order objects returned by getValueFromLuceneField(String).
String getDocumentConstant()
Get the constant that this field is indexed with.
SearchRequestAppender<CascadingOption> getSearchRequestAppender()
@Deprecated SearchRequest getSearchUrlSuffix(CascadingOption option, SearchRequest searchRequest)
This method is deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
Comparator<CascadingOption> getValueComparator()
CascadingOption getValueFromLuceneField(String documentValue)
Convert the lucene document field back to the object that you wish to use to display it.
int hashCode()
boolean isFieldAlwaysPartOfAnIssue()
Check if the field is always part of an issues data.
boolean isValidValue(CascadingOption value)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.search.LuceneFieldSorter
From interface com.atlassian.jira.issue.search.SearchRequestAppender.Factory
From interface com.atlassian.jira.issue.statistics.StatisticsMapper
From interface com.atlassian.jira.issue.statistics.ValueStatisticMapper

Constants

public static final String PARENT_AND_CHILD_INDEX_SEPARATOR

Constant Value: "|"

public static final String SUB_VALUE_SUFFIX

Constant Value: "_combined"

Public Constructors

public CascadingSelectStatisticsMapper (CustomField customField, SelectConverter selectConverter, JiraAuthenticationContext authenticationContext, CustomFieldInputHelper customFieldInputHelper)

Public Methods

public Comparator<CascadingOption> getComparator ()

A comparator that can be used to order objects returned by getValueFromLuceneField(String).

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

public String getDocumentConstant ()

Get the constant that this field is indexed with.

public SearchRequestAppender<CascadingOption> getSearchRequestAppender ()

@Deprecated public SearchRequest getSearchUrlSuffix (CascadingOption option, SearchRequest searchRequest)

This method is deprecated.
Use #getSearchRequestAppender().appendInclusiveSingleValueClause()

public Comparator<CascadingOption> getValueComparator ()

public CascadingOption getValueFromLuceneField (String documentValue)

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

eg. '1000' -> Version 1.

This does the reverse of what com.atlassian.jira.issue.index.IssueDocument does.

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

Parameters
documentValue The value of the field in the lucene index
Returns
  • The value that will be passed to the display

public int hashCode ()

public boolean isFieldAlwaysPartOfAnIssue ()

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.

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

public boolean isValidValue (CascadingOption value)