com.atlassian.jira.issue.customfields.statistics

Class CascadingSelectStatisticsMapper

java.lang.Object

com.atlassian.jira.issue.customfields.statistics.CascadingOptionFieldSorter

com.atlassian.jira.issue.customfields.statistics.CascadingSelectStatisticsMapper

All Implemented Interfaces:

LuceneFieldSorter<CascadingOption>, SearchRequestAppender.Factory<CascadingOption>, StatisticsMapper<CascadingOption>, ValueStatisticMapper<CascadingOption>

@Internal
public class CascadingSelectStatisticsMapper
extends CascadingOptionFieldSorter
implements ValueStatisticMapper<CascadingOption>, SearchRequestAppender.Factory<CascadingOption>

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARENT_AND_CHILD_INDEX_SEPARATOR
static String	SUB_VALUE_SUFFIX

Fields inherited from class com.atlassian.jira.issue.customfields.statistics.CascadingOptionFieldSorter

customField, selectConverter

Constructor Summary

Constructors

Constructor and Description
CascadingSelectStatisticsMapper(CustomField customField, SelectConverter selectConverter, JiraAuthenticationContext authenticationContext, CustomFieldInputHelper customFieldInputHelper)

Method Summary

Methods

Modifier and Type	Method and Description
SearchRequestAppender<CascadingOption>	getSearchRequestAppender()
SearchRequest	getSearchUrlSuffix(CascadingOption option, SearchRequest searchRequest) Deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
Comparator<CascadingOption>	getValueComparator()
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(CascadingOption value) Check whether this value is valid for this particular search.

Methods inherited from class com.atlassian.jira.issue.customfields.statistics.CascadingOptionFieldSorter

getComparator, getDocumentConstant, getValueFromLuceneField

Methods inherited from class java.lang.Object

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

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

equals, getComparator, getDocumentConstant, getValueFromLuceneField

Field Detail

SUB_VALUE_SUFFIX

public static final String SUB_VALUE_SUFFIX

See Also:

Constant Field Values

PARENT_AND_CHILD_INDEX_SEPARATOR

public static final String PARENT_AND_CHILD_INDEX_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

CascadingSelectStatisticsMapper

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

Method Detail

getSearchRequestAppender

public SearchRequestAppender<CascadingOption> getSearchRequestAppender()

Specified by:

getSearchRequestAppender in interface SearchRequestAppender.Factory<CascadingOption>

getValueComparator

public Comparator<CascadingOption> getValueComparator()

Specified by:

getValueComparator in interface ValueStatisticMapper<CascadingOption>

isValidValue

public boolean isValidValue(CascadingOption 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<CascadingOption>

Parameters:

value - This is the same value that will be returned from LuceneFieldSorter.getValueFromLuceneField(String)

Returns:

true if this value is valid for this particular search

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<CascadingOption>

Returns:

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

getSearchUrlSuffix

@Deprecated
public SearchRequest getSearchUrlSuffix(CascadingOption option,
                                          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<CascadingOption>

Parameters:

option - 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)

hashCode

public int hashCode()

Description copied from interface: LuceneFieldSorter

As this object is used as a key in a cache, this method must be provided and respect all internal state.

See the class javadoc entry for more details.

Specified by:

hashCode in interface LuceneFieldSorter<CascadingOption>

Overrides:

hashCode in class Object