Package com.atlassian.jira.lucene.internal.issue.statistics

Class LocalDateFieldSorter

java.lang.Object

com.atlassian.jira.lucene.internal.issue.statistics.LocalDateFieldSorter

All Implemented Interfaces:

FieldValueLoader<LocalDate>

@Internal
public class LocalDateFieldSorter
extends Object
implements FieldValueLoader<LocalDate>

Provides sorting support for LocalDate values by reading a document field.

Platform-specific class intended for the Lucene search platform only.

Jira Search exposes a common API backed by multiple search engines. This class bypasses that abstraction and couples callers to Lucene internals.

Using this class when the runtime search platform is not Lucene (e.g. OpenSearch) may produce incorrect results or failures.

For platform-agnostic usage, use LocalDateFieldValueLoader which works across all supported search platforms.

Internal use only.

Constructor Summary

Constructors

Constructor	Description
LocalDateFieldSorter(String documentConstant)

Method Summary

Modifier and Type	Method	Description
String	field()	Get the field name that this field is indexed with.
Comparator<LocalDate>	getComparator()	A comparator by which the resulting values should be ordered when multiple values are present.
LocalDate	loadValue(String documentValue)	Convert the 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

Constructor Details

LocalDateFieldSorter

public LocalDateFieldSorter(String documentConstant)

Method Details

field

public String field()

Description copied from interface: FieldValueLoader

Get the field name that this field is indexed with.

Specified by:

field in interface FieldValueLoader<LocalDate>

loadValue

public LocalDate loadValue(String documentValue)

Description copied from interface: FieldValueLoader

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

e.g. '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:

loadValue in interface FieldValueLoader<LocalDate>

Parameters:

documentValue - The value of the field in the index or null if no values exist

Returns:

The value that will be passed to the display

getComparator

public Comparator<LocalDate> getComparator()

Description copied from interface: FieldValueLoader

A comparator by which the resulting values should be ordered when multiple values are present.

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

Specified by:

getComparator in interface FieldValueLoader<LocalDate>