Class WatchesStatisticsMapper
java.lang.Object
com.atlassian.jira.issue.statistics.WatchesStatisticsMapper
- All Implemented Interfaces:
LuceneFieldSorter,StatisticsMapper,FieldValueLoader
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanAs this object is used as a key in a cache, this method must be provided and respect all internal state.A comparator that can be used to order objects returned byLuceneFieldSorter.getValueFromLuceneField(String).Default implementation which will be removed in Jira 11 callingFieldValueLoader.field().getSearchUrlSuffix(Object value, SearchRequest searchRequest) Get a suffix for the issue navigator, which allows for filtering on this value.getValueFromLuceneField(String documentValue) Default implementation which will be removed in Jira 11 callingFieldValueLoader.loadValue(String).inthashCode()As this object is used as a key in a cache, this method must be provided and respect all internal state.booleanCheck if the field is always part of an issues data.booleanisValidValue(Object 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, waitMethods inherited from interface com.atlassian.jira.issue.search.LuceneFieldSorter
field, loadValue
-
Field Details
-
MAPPER
-
-
Constructor Details
-
WatchesStatisticsMapper
public WatchesStatisticsMapper()
-
-
Method Details
-
getDocumentConstant
Description copied from interface:StatisticsMapperDefault implementation which will be removed in Jira 11 callingFieldValueLoader.field(). Implement theFieldValueLoader.field()method instead.- Specified by:
getDocumentConstantin interfaceLuceneFieldSorter- Specified by:
getDocumentConstantin interfaceStatisticsMapper- Returns:
- the field name that this field is indexed with.
- See Also:
-
getValueFromLuceneField
Description copied from interface:StatisticsMapperDefault implementation which will be removed in Jira 11 callingFieldValueLoader.loadValue(String). Implement theFieldValueLoader.loadValue(String)method instead.- Specified by:
getValueFromLuceneFieldin interfaceLuceneFieldSorter- Specified by:
getValueFromLuceneFieldin interfaceStatisticsMapper- Parameters:
documentValue- The value of the field in the lucene index- Returns:
- The value that will be passed to the display
-
getComparator
Description copied from interface:LuceneFieldSorterA comparator that can be used to order objects returned byLuceneFieldSorter.getValueFromLuceneField(String).The Comparator must be reentrant as it could be used by Lucene from multiple threads at once.
- Specified by:
getComparatorin interfaceFieldValueLoader- Specified by:
getComparatorin interfaceLuceneFieldSorter
-
isValidValue
Description copied from interface:StatisticsMapperCheck 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:
isValidValuein interfaceStatisticsMapper- Parameters:
value- This is the same value that will be returned fromStatisticsMapper.getValueFromLuceneField(String)- Returns:
- true if this value is valid for this particular search
-
isFieldAlwaysPartOfAnIssue
public boolean isFieldAlwaysPartOfAnIssue()Description copied from interface:StatisticsMapperCheck 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:
isFieldAlwaysPartOfAnIssuein interfaceStatisticsMapper- Returns:
- true if this mapper will always be part of an issues data
-
getSearchUrlSuffix
Description copied from interface:StatisticsMapperGet 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=10240Note that values returned from implementations should return values that are URLEncoded.
- Specified by:
getSearchUrlSuffixin interfaceStatisticsMapper- Parameters:
value- This is the same value that will be returned fromStatisticsMapper.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:
-
equals
Description copied from interface:LuceneFieldSorterAs 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:
equalsin interfaceLuceneFieldSorter- Overrides:
equalsin classObject
-
hashCode
public int hashCode()Description copied from interface:LuceneFieldSorterAs 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:
hashCodein interfaceLuceneFieldSorter- Overrides:
hashCodein classObject
-