com.atlassian.jira.issue.customfields.statistics

Class CascadingOptionFieldSorter

java.lang.Object

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

All Implemented Interfaces:

LuceneFieldSorter<CascadingOption>

Direct Known Subclasses:

CascadingSelectStatisticsMapper

@Internal
public class CascadingOptionFieldSorter
extends Object
implements LuceneFieldSorter<CascadingOption>

LuceneFieldSorter implementation for CascadingOption.

Since:

v6.4

Field Summary

Fields

Modifier and Type	Field and Description
protected CustomField	customField
protected SelectConverter	selectConverter

Constructor Summary

Constructors

Constructor and Description
CascadingOptionFieldSorter(CustomField customField, SelectConverter selectConverter)

Method Summary

Modifier and Type	Method and Description
Comparator<CascadingOption>	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.
CascadingOption	getValueFromLuceneField(String documentValue) Convert the lucene document field back to the object that you wish to use to display it.

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

Field Detail

customField

protected final CustomField customField

selectConverter

protected final SelectConverter selectConverter

Constructor Detail

CascadingOptionFieldSorter

public CascadingOptionFieldSorter(CustomField customField,
                                  SelectConverter selectConverter)

Method Detail

getDocumentConstant

public String getDocumentConstant()

Description copied from interface: LuceneFieldSorter

Get the constant that this field is indexed with.

Specified by:

getDocumentConstant in interface LuceneFieldSorter<CascadingOption>

See Also:

CustomFieldSearcher

getValueFromLuceneField

public CascadingOption getValueFromLuceneField(String documentValue)

Description copied from interface: LuceneFieldSorter

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

eg. '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:

getValueFromLuceneField in interface LuceneFieldSorter<CascadingOption>

Parameters:

documentValue - The value of the field in the lucene index

Returns:

The value that will be passed to the display

getComparator

public Comparator<CascadingOption> getComparator()

Description copied from interface: LuceneFieldSorter

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

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

Specified by:

getComparator in interface LuceneFieldSorter<CascadingOption>