public class

ProjectStatisticsMapper

extends Object
implements SearchRequestAppender.Factory<T> StatisticsMapper<T>
java.lang.Object
   ↳ com.atlassian.jira.issue.statistics.ProjectStatisticsMapper
Known Direct Subclasses

Summary

Public Constructors
ProjectStatisticsMapper(ProjectManager projectManager)
ProjectStatisticsMapper(ProjectManager projectManager, SimpleFieldSearchConstants searchConstants)
ProjectStatisticsMapper(ProjectManager projectManager, String clauseName, String documentConstant)
Public Methods
boolean equals(Object o)
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.
SearchRequestAppender<GenericValue> getSearchRequestAppender()
@Deprecated SearchRequest getSearchUrlSuffix(Object value, SearchRequest searchRequest)
This method is deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
Object getValueFromLuceneField(String documentValue)
Convert the lucene document field back to the object that you wish to use to display it.
int hashCode()
boolean isFieldAlwaysPartOfAnIssue()
Check if the field is always part of an issues data.
boolean isValidValue(Object value)
Protected Methods
String getClauseName()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.search.LuceneFieldSorter
From interface com.atlassian.jira.issue.search.SearchRequestAppender.Factory
From interface com.atlassian.jira.issue.statistics.StatisticsMapper

Public Constructors

public ProjectStatisticsMapper (ProjectManager projectManager)

public ProjectStatisticsMapper (ProjectManager projectManager, SimpleFieldSearchConstants searchConstants)

public ProjectStatisticsMapper (ProjectManager projectManager, String clauseName, String documentConstant)

Public Methods

public boolean equals (Object o)

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 SearchRequestAppender<GenericValue> getSearchRequestAppender ()

@Deprecated public SearchRequest getSearchUrlSuffix (Object value, SearchRequest searchRequest)

This method is deprecated.
Use #getSearchRequestAppender().appendInclusiveSingleValueClause()

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 int hashCode ()

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)

Protected Methods

protected String getClauseName ()