public class

StatisticsMapperWrapper

extends Object
implements StatisticsMapper<T>
java.lang.Object
   ↳ com.atlassian.jira.issue.statistics.util.StatisticsMapperWrapper
Known Direct Subclasses

Class Overview

Provides a convenient implementation of the StatisticsMapper interface that can be subclassed by developers wishing to adapt the request to a mapper. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped statisticsMapper object.

Summary

Public Constructors
StatisticsMapperWrapper(StatisticsMapper statisticsMapper)
Public Methods
Comparator getComparator()
A comparator that can be used to order objects returned by getValueFromLuceneField(String).
String getDocumentConstant()
Get the constant that this field is indexed with.
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.
boolean isFieldAlwaysPartOfAnIssue()
Check if the field is always part of an issues data.
boolean isValidValue(Object value)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.search.LuceneFieldSorter
From interface com.atlassian.jira.issue.statistics.StatisticsMapper

Public Constructors

public StatisticsMapperWrapper (StatisticsMapper statisticsMapper)

Public Methods

public Comparator getComparator ()

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

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

public String getDocumentConstant ()

Get the constant that this field is indexed with.

public SearchRequest getSearchUrlSuffix (Object value, SearchRequest searchRequest)

public Object getValueFromLuceneField (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 com.atlassian.jira.issue.index.IssueDocument does.

For custom fields, the return value will be passed to 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

public boolean isFieldAlwaysPartOfAnIssue ()

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.

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

public boolean isValidValue (Object value)