com.atlassian.jira.issue.search
Interface LuceneFieldSorter

All Known Subinterfaces:

StatisticsMapper

All Known Implementing Classes:

AbstractConstantStatisticsMapper, AbstractCustomFieldStatisticsMapper, AbstractUserStatisticsMapper, AbstractVersionStatisticsMapper, ComponentStatisticsMapper, DateFieldSorter, FixForVersionStatisticsMapper, IssueKeyStatisticsMapper, LongFieldStatisticsMapper, NumericFieldStatisticsMapper, ProjectStatisticsMapper, RaisedInVersionStatisticsMapper, SecurityLevelStatisticsMapper, SubTaskStatisticsMapper, TextFieldSorter, VotesStatisticsMapper

public interface LuceneFieldSorter

Method Summary

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

Method Detail

getDocumentConstant

public String getDocumentConstant()

Get the constant that this field is indexed with.

See Also:

IssueDocument, CustomFieldSearcher

getValueFromLuceneField

public Object getValueFromLuceneField(String documentValue)

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

eg. '1000' -> Version 1.

This does the reverse of what IssueDocument does.

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 lucene index

Returns:

The value that will be passed to the display

getComparator

public Comparator getComparator()

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