AbstractConstantStatisticsMapper (Atlassian JIRA 7.0.5 API)

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

All Implemented Interfaces:

LuceneFieldSorter<IssueConstant>, StatisticsMapper<IssueConstant>

Direct Known Subclasses:

IssueTypeStatisticsMapper, PriorityStatisticsMapper, ResolutionStatisticsMapper, StatusStatisticsMapper
```
@ThreadSafe
 @PublicSpi
public abstract class AbstractConstantStatisticsMapper
extends Object
implements StatisticsMapper<IssueConstant>
```

Field Summary

Fields
Modifier and Type Field and Description

protected ConstantsManager constantsManager

Fields
Modifier and Type	Field and Description
`protected ConstantsManager`	`constantsManager`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractConstantStatisticsMapper(ConstantsManager constantsManager)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractConstantStatisticsMapper(ConstantsManager constantsManager)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete 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.
`Comparator<IssueConstant>`	`getComparator()` A comparator that can be used to order objects returned by `LuceneFieldSorter.getValueFromLuceneField(String)`.
`protected abstract String`	`getConstantType()`
`abstract String`	`getDocumentConstant()` Get the constant that this field is indexed with.
`protected abstract String`	`getIssueFieldConstant()`
`SearchRequest`	`getSearchUrlSuffix(IssueConstant value, SearchRequest searchRequest)` Get a suffix for the issue navigator, which allows for filtering on this value.
`IssueConstant`	`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(IssueConstant 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

- Field Detail
  - constantsManager
```
protected final ConstantsManager constantsManager
```
- Constructor Detail
  - AbstractConstantStatisticsMapper
```
protected AbstractConstantStatisticsMapper(ConstantsManager constantsManager)
```
- Method Detail
  - getDocumentConstant
```
public abstract String getDocumentConstant()
```
    Description copied from interface: LuceneFieldSorter
    
    Get the constant that this field is indexed with.
    
    Specified by:
    
    getDocumentConstant in interface LuceneFieldSorter<IssueConstant>
    
    See Also:
    
    CustomFieldSearcher
  - getConstantType
```
protected abstract String getConstantType()
```
  - getIssueFieldConstant
```
protected abstract String getIssueFieldConstant()
```
  - getComparator
```
public Comparator<IssueConstant> 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<IssueConstant>
  - isValidValue
```
public boolean isValidValue(IssueConstant 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<IssueConstant>
    
    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
  - getValueFromLuceneField
```
public IssueConstant 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<IssueConstant>
    
    Parameters:
    
    documentValue - The value of the field in the lucene index
    
    Returns:
    
    The value that will be passed to the display
  - getSearchUrlSuffix
```
public SearchRequest getSearchUrlSuffix(IssueConstant value,
                                        SearchRequest searchRequest)
```
    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<IssueConstant>
    
    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)
  - 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<IssueConstant>
    
    Returns:
    
    true if this mapper will always be part of an issues data
  - 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<IssueConstant>
    
    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<IssueConstant>
    
    Overrides:
    
    hashCode in class Object

Class AbstractConstantStatisticsMapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

constantsManager

Constructor Detail

AbstractConstantStatisticsMapper

Method Detail

getDocumentConstant

getConstantType

getIssueFieldConstant

getComparator

isValidValue

getValueFromLuceneField

getSearchUrlSuffix

isFieldAlwaysPartOfAnIssue

equals

hashCode