com.atlassian.jira.issue.customfields

Interface NaturallyOrderedCustomFieldSearcher

All Known Implementing Classes:

AbstractDateRangeSearcher, DateRangeSearcher, DateTimeRangeSearcher, ExactNumberSearcher, ExactTextSearcher, TextSearcher

@PublicSpi
public interface NaturallyOrderedCustomFieldSearcher

This interface indicates the values stored in the Lucene index for this searcher are naturally ordered and as a result natural Lucene sorting can be used allowing for best sort performance.

Method Summary

Modifier and Type	Method and Description
String	getSortField(CustomField customField) Return the name of the Lucene field to use for ordering.
org.apache.lucene.search.SortField.Type	getSortFieldType() Returns the type to use when sorting on the values of this custom field.

Method Detail

getSortField

String getSortField(CustomField customField)

Return the name of the Lucene field to use for ordering. This will normally be just the field, .i.e customField.getId() but some searchers, e.g. TextSearcher, store additional fields to support sorting.

Parameters:

customField - The custom field to be searched

Returns:

The Lucene field name to use for ordering.

getSortFieldType

org.apache.lucene.search.SortField.Type getSortFieldType()

Returns the type to use when sorting on the values of this custom field. This also necessitates adding NumericDocValues to documents for numeric and date data types, and SortedDocValues for string types at indexing time.

Returns:

type to expect when sorting values of this custom field.