com.atlassian.jira.issue.statistics
Class AbstractVersionStatisticsMapper

java.lang.Object
  com.atlassian.jira.issue.statistics.AbstractVersionStatisticsMapper

All Implemented Interfaces:

StatisticsMapper

Direct Known Subclasses:

FixForVersionStatisticsMapper, RaisedInVersionStatisticsMapper

public abstract class AbstractVersionStatisticsMapper

extends java.lang.Object

implements StatisticsMapper

Field Summary

(package private) boolean

includeArchived

Constructor Summary

AbstractVersionStatisticsMapper(VersionManager versionManager, boolean includeArchived)

Method Summary

java.util.Comparator	getComparator() A comparator that can be used to order objects returned by getValueFromLuceneField(String)
abstract 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.
protected abstract java.lang.String	getSearchUrlType()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

includeArchived

boolean includeArchived

Constructor Detail

AbstractVersionStatisticsMapper

public AbstractVersionStatisticsMapper(VersionManager versionManager,
                                       boolean includeArchived)

Method Detail

getComparator

public java.util.Comparator getComparator()

Description copied from interface: StatisticsMapper

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

Specified by:

getComparator in interface StatisticsMapper

isValidValue

public boolean isValidValue(java.lang.Object value)

Description copied from interface: StatisticsMapper

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)

Specified by:

isValidValue in interface StatisticsMapper

Parameters:

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

Returns:

true if this value is valid for this particular search

getValueFromLuceneField

public java.lang.Object getValueFromLuceneField(java.lang.String documentValue)

Description copied from interface: StatisticsMapper

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)

Specified by:

getValueFromLuceneField in interface StatisticsMapper

Parameters:

documentValue - The value of the field in the lucene index

Returns:

The value that will be passed to the display

getSearchUrlSuffix

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

Description copied from interface: StatisticsMapper

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.

Specified by:

getSearchUrlSuffix in interface StatisticsMapper

Parameters:

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

Returns:

the suffix, or null if there is no suffix

See Also:

URLEncoder.encode(String)

getSearchUrlType

protected abstract java.lang.String getSearchUrlType()

getDocumentConstant

public abstract java.lang.String getDocumentConstant()

Description copied from interface: StatisticsMapper

Get the constant that this field is indexed with.

Specified by:

getDocumentConstant in interface StatisticsMapper

See Also:

IssueDocument, CustomFieldSearcher