com.atlassian.jira.issue.statistics
Class AbstractUserStatisticsMapper

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

All Implemented Interfaces:

LuceneFieldSorter, StatisticsMapper

Direct Known Subclasses:

AssigneeStatisticsMapper, ReporterStatisticsMapper

public abstract class AbstractUserStatisticsMapper

extends Object

implements StatisticsMapper

Constructor Summary

AbstractUserStatisticsMapper(UserManager userManager)

Method Summary

Comparator	getComparator() A comparator that can be used to order objects returned by getValueFromLuceneField(String)
abstract String	getDocumentConstant() Get the constant that this field is indexed with.
protected abstract SearchParameter	getUserParameter(String s)
Object	getValueFromLuceneField(String documentValue) Convert the lucene document field back to the object that you wish to use to display it.
boolean	isFieldAlwaysPartOfAnIssue() Check if the field is always part of an issues data.
boolean	isValidValue(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

Methods inherited from interface com.atlassian.jira.issue.statistics.StatisticsMapper

getSearchUrlSuffix

Constructor Detail

AbstractUserStatisticsMapper

public AbstractUserStatisticsMapper(UserManager userManager)

Method Detail

getDocumentConstant

public abstract String getDocumentConstant()

Description copied from interface: LuceneFieldSorter

Get the constant that this field is indexed with.

Specified by:

getDocumentConstant in interface LuceneFieldSorter

See Also:

IssueDocument, CustomFieldSearcher

getComparator

public Comparator getComparator()

Description copied from interface: LuceneFieldSorter

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

Specified by:

getComparator in interface LuceneFieldSorter

isValidValue

public boolean isValidValue(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 LuceneFieldSorter.getValueFromLuceneField(String)

Returns:

true if this value is valid for this particular search

getValueFromLuceneField

public Object getValueFromLuceneField(String documentValue)

Description copied from interface: LuceneFieldSorter

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 LuceneFieldSorter

Parameters:

documentValue - The value of the field in the lucene index

Returns:

The value that will be passed to the display

isFieldAlwaysPartOfAnIssue

public boolean isFieldAlwaysPartOfAnIssue()

Description copied from interface: StatisticsMapper

Check if the field is always part of an issues data. This should only return false in the case of a custom field where the value does not have to be set for each issue.

Specified by:

isFieldAlwaysPartOfAnIssue in interface StatisticsMapper

Returns:

true if this mapper will always be part of an issues data

getUserParameter

protected abstract SearchParameter getUserParameter(String s)