com.atlassian.jira.issue.statistics
Class AbstractUserStatisticsMapper

java.lang.Object
  extended bycom.atlassian.jira.issue.statistics.AbstractUserStatisticsMapper
All Implemented Interfaces:
StatisticsMapper
Direct Known Subclasses:
AssigneeStatisticsMapper, ReporterStatisticsMapper

public abstract class AbstractUserStatisticsMapper
extends java.lang.Object
implements StatisticsMapper


Constructor Summary
AbstractUserStatisticsMapper(com.opensymphony.user.UserManager projectManager)
           
 
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.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
 
Methods inherited from interface com.atlassian.jira.issue.statistics.StatisticsMapper
getSearchUrlSuffix
 

Constructor Detail

AbstractUserStatisticsMapper

public AbstractUserStatisticsMapper(com.opensymphony.user.UserManager projectManager)
Method Detail

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

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


Copyright © 2002-2005 Atlassian. All Rights Reserved.