@Internal public class

CascadingOptionFieldSorter

extends Object
implements LuceneFieldSorter<T>
java.lang.Object
   ↳ com.atlassian.jira.issue.customfields.statistics.CascadingOptionFieldSorter
Known Direct Subclasses

@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).

Class Overview

LuceneFieldSorter implementation for CascadingOption.

Summary

Fields
protected final CustomField customField
protected final SelectConverter selectConverter
Public Constructors
CascadingOptionFieldSorter(CustomField customField, SelectConverter selectConverter)
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.
CascadingOption getValueFromLuceneField(String documentValue)
Convert the lucene document field back to the object that you wish to use to display it.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.search.LuceneFieldSorter

Fields

protected final CustomField customField

protected final SelectConverter selectConverter

Public Constructors

public CascadingOptionFieldSorter (CustomField customField, SelectConverter selectConverter)

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

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