Package com.atlassian.jira.search

Interface FieldValueLoader<T>

Type Parameters:
T - - the type of loaded value
All Known Subinterfaces:
StatisticsMapper<T>, ValueStatisticMapper<T>
All Known Implementing Classes:
AbstractConstantStatisticsMapper, AbstractCustomFieldStatisticsMapper, AssigneeStatisticsMapper, CachingStatisticsMapper, CascadingOptionFieldSorter, CascadingSelectStatisticsMapper, ComponentStatisticsMapper, CreatorStatisticsMapper, CustomFieldLabelsStatisticsMapper, CustomFieldProjectStatisticsMapper, CustomFieldUserStatisticsMapper, CustomFieldVersionStatisticsMapper, DateFieldValueLoader, DatePeriodStatisticsMapper, FixForVersionStatisticsMapper, GroupPickerStatisticsMapper, IssueKeyStatisticsMapper, IssueTypeStatisticsMapper, LabelsStatisticsMapper, LocalDateFieldSorter, LocalDateFieldValueLoader, LongFieldStatisticsMapper, NumericFieldStatisticsMapper, PriorityStatisticsMapper, ProjectSelectStatisticsMapper, ProjectStatisticsMapper, RaisedInVersionStatisticsMapper, ReporterStatisticsMapper, ResolutionStatisticsMapper, ReversePriorityStatisticsMapper, SecurityLevelStatisticsMapper, SelectStatisticsMapper, StatisticsMapperWrapper, StatusStatisticsMapper, SubTaskStatisticsMapper, TextFieldValueLoader, TimeTrackingStatisticsMapper, UserPickerStatisticsMapper, UserStatisticsMapper, VersionStatisticsMapper, VotesStatisticsMapper, WatchesStatisticsMapper
@PublicSpi public interface FieldValueLoader<T>
Implementations of this interface are used to load the value of a field from the index.
Since:
11.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    field()
    Get the field name that this field is indexed with.
    Comparator<T>
    getComparator()
    A comparator by which the resulting values should be ordered when multiple values are present.
    T
    loadValue(String documentValue)
    Convert the document field back to the object that you wish to use to display it.

  • Method Details

    • field

      String field()
      Get the field name that this field is indexed with.

    • loadValue

      @Nullable T loadValue(@Nullable String documentValue)
      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)

      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

      Comparator<T> getComparator()
      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.