Package com.atlassian.jira.issue.customfields.statistics

Class AbstractCustomFieldStatisticsMapper

java.lang.Object
com.atlassian.jira.issue.customfields.statistics.AbstractCustomFieldStatisticsMapper
All Implemented Interfaces:
StatisticsMapper, FieldValueLoader
Direct Known Subclasses:
ProjectSelectStatisticsMapper, UserPickerStatisticsMapper
@PublicSpi public abstract class AbstractCustomFieldStatisticsMapper extends Object implements StatisticsMapper

  • Field Details

    • customField

      protected final CustomField customField

  • Constructor Details

    • AbstractCustomFieldStatisticsMapper

      public AbstractCustomFieldStatisticsMapper(CustomField customField)

  • Method Details

    • field

      public String field()
      Description copied from interface: FieldValueLoader
      Get the field name that this field is indexed with.
      Specified by:
      field in interface FieldValueLoader

    • isValidValue

      public boolean isValidValue(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
      invalid reference 
      #getValueFromLuceneField(String)
      Returns:
      true if this value is valid for this particular search

    • getSearchUrlSuffix

      public SearchRequest getSearchUrlSuffix(Object value, SearchRequest searchRequest)
      Description copied from interface: StatisticsMapper
      Get a suffix for the issue navigator, which allows for filtering on this value.

      e.g. a project field would return a SearchRequest object who's getQueryString method will produce pid=10240

      Note that values returned from implementations should return values that are URLEncoded.

      Specified by:
      getSearchUrlSuffix in interface StatisticsMapper
      Parameters:
      value - This is the same value that will be returned from
      invalid reference 
      #getValueFromLuceneField(String)
      searchRequest - is the search request that should be used as the base of the newly generated SearchRequest object. If this parameter is null then the return type will also be null.
      Returns:
      a SearchRequest object that will generate the correct issue navigator url to search the correct statistics set, null otherwise.
      See Also:

    • getSearchContextFromValue

      protected SearchContext getSearchContextFromValue(Object value)

    • getSearchValue

      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
      invalid reference 
      #getValueFromLuceneField
      Returns:
      String

    • getComparator

      public Comparator getComparator()
      Description copied from interface: FieldValueLoader
      A comparator by which the resulting values should be ordered when multiple values are present.

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

      Specified by:
      getComparator in interface FieldValueLoader

    • isFieldAlwaysPartOfAnIssue

      public boolean isFieldAlwaysPartOfAnIssue()
      Description copied from interface: StatisticsMapper
      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.
      Specified by:
      isFieldAlwaysPartOfAnIssue in interface StatisticsMapper
      Returns:
      true if this mapper will always be part of an issues data

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object