com.atlassian.jira.issue.statistics
Class AbstractVersionStatisticsMapper

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

All Implemented Interfaces:

LuceneFieldSorter

Direct Known Subclasses:

FixForVersionStatisticsMapper, RaisedInVersionStatisticsMapper, VersionSearcher.VersionLuceneFieldSorter

public abstract class AbstractVersionStatisticsMapper

extends Object

implements LuceneFieldSorter

Field Summary

(package private) boolean

includeArchived

Constructor Summary

AbstractVersionStatisticsMapper(VersionManager versionManager, boolean includeArchived)

Method Summary

boolean	equals(Object o) As this object is used as a key in a cache, this method must be provided and respect all internal state.
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 SearchParameter	getProjectParameter(Long value)
SearchRequest	getSearchUrlSuffix(Object value, SearchRequest searchRequest)
Object	getValueFromLuceneField(String documentValue) Convert the lucene document field back to the object that you wish to use to display it.
protected abstract SearchParameter	getVersionParameter(Long value)
int	hashCode() As this object is used as a key in a cache, this method must be provided and respect all internal state.
boolean	isFieldAlwaysPartOfAnIssue()
boolean	isValidValue(Object value)

Methods inherited from class java.lang.Object

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

Field Detail

includeArchived

boolean includeArchived

Constructor Detail

AbstractVersionStatisticsMapper

public AbstractVersionStatisticsMapper(VersionManager versionManager,
                                       boolean includeArchived)

Method Detail

getComparator

public Comparator getComparator()

Description copied from interface: LuceneFieldSorter

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

The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.

Specified by:

getComparator in interface LuceneFieldSorter

isValidValue

public boolean isValidValue(Object value)

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

getSearchUrlSuffix

public SearchRequest getSearchUrlSuffix(Object value,
                                        SearchRequest searchRequest)

isFieldAlwaysPartOfAnIssue

public boolean isFieldAlwaysPartOfAnIssue()

getVersionParameter

protected abstract SearchParameter getVersionParameter(Long value)

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

getProjectParameter

protected SearchParameter getProjectParameter(Long value)

equals

public boolean equals(Object o)

Description copied from interface: LuceneFieldSorter

As this object is used as a key in a cache, this method must be provided and respect all internal state.

See the class javadoc entry for more details.

Specified by:

equals in interface LuceneFieldSorter

hashCode

public int hashCode()

Description copied from interface: LuceneFieldSorter

As this object is used as a key in a cache, this method must be provided and respect all internal state.

See the class javadoc entry for more details.

Specified by:

hashCode in interface LuceneFieldSorter