ProjectStatisticsMapper (Atlassian Jira

java.lang.Object
- com.atlassian.jira.issue.statistics.ProjectStatisticsMapper

All Implemented Interfaces:

LuceneFieldSorter<Project>, SearchRequestAppender.Factory<Project>, StatisticsMapper<Project>

Direct Known Subclasses:

CustomFieldProjectStatisticsMapper
```
public class ProjectStatisticsMapper
extends Object
implements StatisticsMapper<Project>, SearchRequestAppender.Factory<Project>
```

Constructor Summary

Constructors
Constructor and Description
`ProjectStatisticsMapper(ProjectManager projectManager)`
`ProjectStatisticsMapper(ProjectManager projectManager, SimpleFieldSearchConstants searchConstants)`
`ProjectStatisticsMapper(ProjectManager projectManager, String clauseName, String documentConstant)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` As this object is used as a key in a cache, this method must be provided and respect all internal state.
`protected String`	`getClauseName()`
`Comparator<Project>`	`getComparator()` A comparator that can be used to order objects returned by `LuceneFieldSorter.getValueFromLuceneField(String)`.
`String`	`getDocumentConstant()` Get the constant that this field is indexed with.
`SearchRequestAppender<Project>`	`getSearchRequestAppender()`
`SearchRequest`	`getSearchUrlSuffix(Project value, SearchRequest searchRequest)` Deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
`Project`	`getValueFromLuceneField(String documentValue)` Convert the lucene document field back to the object that you wish to use to display it.
`int`	`hashCode()` As this object is used as a key in a cache, this method must be provided and respect all internal state.
`boolean`	`isFieldAlwaysPartOfAnIssue()` Check if the field is always part of an issues data.
`boolean`	`isValidValue(Project value)` Check whether this value is valid for this particular search.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProjectStatisticsMapper
```
public ProjectStatisticsMapper(ProjectManager projectManager)
```
  - ProjectStatisticsMapper
```
public ProjectStatisticsMapper(ProjectManager projectManager,
                               SimpleFieldSearchConstants searchConstants)
```
  - ProjectStatisticsMapper
```
public ProjectStatisticsMapper(ProjectManager projectManager,
                               String clauseName,
                               String documentConstant)
```
- Method Detail
  - getDocumentConstant
```
public String getDocumentConstant()
```
    Description copied from interface: LuceneFieldSorter
    
    Get the constant that this field is indexed with.
    
    Specified by:
    
    getDocumentConstant in interface LuceneFieldSorter<Project>
    
    See Also:
    
    CustomFieldSearcher
  - getValueFromLuceneField
```
public Project getValueFromLuceneField(String documentValue)
```
    Description copied from interface: LuceneFieldSorter
    
    Convert the lucene document field back to the object that you wish to use to display it.
    eg. '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:
    
    getValueFromLuceneField in interface LuceneFieldSorter<Project>
    
    Parameters:
    
    documentValue - The value of the field in the lucene index
    
    Returns:
    
    The value that will be passed to the display
  - getComparator
```
public Comparator<Project> getComparator()
```
    Description copied from interface: LuceneFieldSorter
    
    A comparator that can be used to order objects returned by LuceneFieldSorter.getValueFromLuceneField(String).
    The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.
    
    Specified by:
    
    getComparator in interface LuceneFieldSorter<Project>
  - isValidValue
```
public boolean isValidValue(Project 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<Project>
    
    Parameters:
    
    value - This is the same value that will be returned from LuceneFieldSorter.getValueFromLuceneField(String)
    
    Returns:
    
    true if this value is valid for this particular search
  - 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<Project>
    
    Returns:
    
    true if this mapper will always be part of an issues data
  - getSearchUrlSuffix
```
@Deprecated
public SearchRequest getSearchUrlSuffix(Project value,
                                                    SearchRequest searchRequest)
```
    Deprecated. Use #getSearchRequestAppender().appendInclusiveSingleValueClause()
    
    Description copied from interface: StatisticsMapper
    
    Get a suffix for the issue navigator, which allows for filtering on this value.
    eg. 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<Project>
    
    Parameters:
    
    value - This is the same value that will be returned from LuceneFieldSorter.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:
    
    URLEncoder.encode(String)
  - getSearchRequestAppender
```
public SearchRequestAppender<Project> getSearchRequestAppender()
```
    Specified by:
    
    getSearchRequestAppender in interface SearchRequestAppender.Factory<Project>
    
    Since:
    
    v6.0
  - getClauseName
```
protected String getClauseName()
```
  - equals
```
public boolean equals(Object o)
```
    Description copied from interface: LuceneFieldSorter
    
    As this object is used as a key in a cache, this method must be provided and respect all internal state.
    See the class javadoc entry for more details.
    
    Specified by:
    
    equals in interface LuceneFieldSorter<Project>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Description copied from interface: LuceneFieldSorter
    
    As this object is used as a key in a cache, this method must be provided and respect all internal state.
    See the class javadoc entry for more details.
    
    Specified by:
    
    hashCode in interface LuceneFieldSorter<Project>
    
    Overrides:
    
    hashCode in class Object

Class ProjectStatisticsMapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectStatisticsMapper

ProjectStatisticsMapper

ProjectStatisticsMapper

Method Detail

getDocumentConstant

getValueFromLuceneField

getComparator

isValidValue

isFieldAlwaysPartOfAnIssue

getSearchUrlSuffix

getSearchRequestAppender

getClauseName

equals

hashCode