public class VotesStatisticsMapper extends Object implements StatisticsMapper
Modifier and Type | Field and Description |
---|---|
static StatisticsMapper |
MAPPER |
Constructor and Description |
---|
VotesStatisticsMapper() |
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 |
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.
|
SearchRequest |
getSearchUrlSuffix(Object value,
SearchRequest searchRequest)
Get a suffix for the issue navigator, which allows for filtering on this value.
|
Object |
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(Object value)
Check whether this value is valid for this particular search.
|
public static final StatisticsMapper MAPPER
public String getDocumentConstant()
LuceneFieldSorter
getDocumentConstant
in interface LuceneFieldSorter
CustomFieldSearcher
public Object getValueFromLuceneField(String documentValue)
LuceneFieldSorter
eg. '1000' -> Version 1.
For custom fields, the return value will be passed to
CustomFieldSearcherModuleDescriptor.getStatHtml(com.atlassian.jira.issue.fields.CustomField, Object, String)
getValueFromLuceneField
in interface LuceneFieldSorter
documentValue
- The value of the field in the lucene indexpublic Comparator getComparator()
LuceneFieldSorter
LuceneFieldSorter.getValueFromLuceneField(String)
.
The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.
getComparator
in interface LuceneFieldSorter
public boolean isValidValue(Object value)
StatisticsMapper
isValidValue
in interface StatisticsMapper
value
- This is the same value that will be returned from LuceneFieldSorter.getValueFromLuceneField(String)
public boolean isFieldAlwaysPartOfAnIssue()
StatisticsMapper
isFieldAlwaysPartOfAnIssue
in interface StatisticsMapper
public SearchRequest getSearchUrlSuffix(Object value, SearchRequest searchRequest)
StatisticsMapper
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.
getSearchUrlSuffix
in interface StatisticsMapper
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.URLEncoder.encode(String)
public boolean equals(Object o)
LuceneFieldSorter
See the class javadoc entry for more details.
equals
in interface LuceneFieldSorter
equals
in class Object
public int hashCode()
LuceneFieldSorter
See the class javadoc entry for more details.
hashCode
in interface LuceneFieldSorter
hashCode
in class Object
Copyright © 2002-2017 Atlassian. All Rights Reserved.