@PublicSpi public abstract class

AbstractCustomFieldStatisticsMapper

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

@PublicSpi

This class is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Summary

Fields
protected final CustomField customField
Public Constructors
AbstractCustomFieldStatisticsMapper(CustomField customField)
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.
SearchRequest getSearchUrlSuffix(Object value, SearchRequest searchRequest)
int hashCode()
boolean isFieldAlwaysPartOfAnIssue()
Check if the field is always part of an issues data.
boolean isValidValue(Object value)
Protected Methods
SearchContext getSearchContextFromValue(Object value)
abstract String getSearchValue(Object value)
String value to be passed to the search request to construct a new request URL
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.search.LuceneFieldSorter
From interface com.atlassian.jira.issue.statistics.StatisticsMapper

Fields

protected final CustomField customField

Public Constructors

public AbstractCustomFieldStatisticsMapper (CustomField customField)

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 SearchRequest getSearchUrlSuffix (Object value, SearchRequest searchRequest)

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 SearchContext getSearchContextFromValue (Object value)

protected abstract String getSearchValue (Object value)

String value to be passed to the search request to construct a new request URL

Parameters
value returned from getValueFromLuceneField(String)
Returns
  • String