Package com.atlassian.jira.lucene.internal.issue.statistics.util

Class StatisticsMapperWrapper

java.lang.Object
com.atlassian.jira.lucene.internal.issue.statistics.util.StatisticsMapperWrapper
All Implemented Interfaces:
StatisticsMapper, FieldValueLoader
Direct Known Subclasses:
CachingStatisticsMapper
@Deprecated(since="10.4", forRemoval=true) public class StatisticsMapperWrapper extends Object implements StatisticsMapper
Deprecated, for removal: This API element is subject to removal in a future version.
since 10.4, to be removed when we remove Lucene support
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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StatisticsMapperWrapper(StatisticsMapper statisticsMapper)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    field()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the field name that this field is indexed with.
    Comparator
    getComparator()
    Deprecated, for removal: This API element is subject to removal in a future version.
    A comparator by which the resulting values should be ordered when multiple values are present.
    SearchRequest
    getSearchUrlSuffix(Object value, SearchRequest searchRequest)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get a suffix for the issue navigator, which allows for filtering on this value.
    boolean
    isFieldAlwaysPartOfAnIssue()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check if the field is always part of an issues' data.
    boolean
    isValidValue(Object value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether this value is valid for this particular search.
    Object
    loadValue(String documentValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert the document field back to the object that you wish to use to display it.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StatisticsMapperWrapper

      public StatisticsMapperWrapper(StatisticsMapper statisticsMapper)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • isValidValue

      public boolean isValidValue(Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • isFieldAlwaysPartOfAnIssue

      public boolean isFieldAlwaysPartOfAnIssue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • getSearchUrlSuffix

      public SearchRequest getSearchUrlSuffix(Object value, SearchRequest searchRequest)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • field

      public String field()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: FieldValueLoader
      Get the field name that this field is indexed with.
      Specified by:
      field in interface FieldValueLoader

    • loadValue

      public Object loadValue(String documentValue)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: FieldValueLoader
      Convert the document field back to the object that you wish to use to display it.

      e.g. '1000' -> Version 1.

      For custom fields, the return value will be passed to CustomFieldSearcherModuleDescriptor.getStatHtml(com.atlassian.jira.issue.fields.CustomField, Object, String)

      Specified by:
      loadValue in interface FieldValueLoader
      Parameters:
      documentValue - The value of the field in the index or null if no values exist
      Returns:
      The value that will be passed to the display

    • getComparator

      public Comparator getComparator()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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