com.atlassian.jira.issue.statistics
Interface StatisticsMapper

All Known Implementing Classes:

AbstractConstantStatisticsMapper, AbstractUserStatisticsMapper, AbstractVersionStatisticsMapper, ComponentStatisticsMapper, ProjectStatisticsMapper

public interface StatisticsMapper

Allow mapping from Lucene indexes, back to the fields that they came from.

Any 'field' that implements this is capable of having a statistic calculated from it.

See Also:

FilterStatisticsValuesGenerator

Method Summary

java.util.Comparator	getComparator() A comparator that can be used to order objects returned by getValueFromLuceneField(String)
java.lang.String	getDocumentConstant() Get the constant that this field is indexed with.
java.lang.String	getSearchUrlSuffix(java.lang.Object value) Get a suffix for the issue navigator, which allows for filtering on this value.
java.lang.Object	getValueFromLuceneField(java.lang.String documentValue) Convert the lucene document field back to the object that you wish to use to display it.
boolean	isValidValue(java.lang.Object value) Check whether this value is valid for this particular search.

Method Detail

getDocumentConstant

public java.lang.String getDocumentConstant()

Get the constant that this field is indexed with.

See Also:

IssueDocument, CustomFieldSearcher

getValueFromLuceneField

public java.lang.Object getValueFromLuceneField(java.lang.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 java.util.Comparator getComparator()

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

isValidValue

public boolean isValidValue(java.lang.Object value)

Check whether this value is valid for this particular search. This is useful if you do not wish to display all the values that are indexed (eg - only show released versions)

Parameters:

value - This is the same value that will be returned from getValueFromLuceneField(String)

Returns:

true if this value is valid for this particular search

getSearchUrlSuffix

public java.lang.String getSearchUrlSuffix(java.lang.Object value)

Get a suffix for the issue navigator, which allows for filtering on this value.

eg. a project field would return pid=10240

Note that values returned from implementations should return values that are URLEncoded.

Parameters:

value - This is the same value that will be returned from getValueFromLuceneField(String)

Returns:

the suffix, or null if there is no suffix

See Also:

URLEncoder.encode(String)