public class ProjectStatisticsMapper extends Object implements StatisticsMapper<Project>, SearchRequestAppender.Factory<Project>
Constructor and Description |
---|
ProjectStatisticsMapper(ProjectManager projectManager) |
ProjectStatisticsMapper(ProjectManager projectManager,
SimpleFieldSearchConstants searchConstants) |
ProjectStatisticsMapper(ProjectManager projectManager,
String clauseName,
String documentConstant) |
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.
|
public ProjectStatisticsMapper(ProjectManager projectManager)
public ProjectStatisticsMapper(ProjectManager projectManager, SimpleFieldSearchConstants searchConstants)
public ProjectStatisticsMapper(ProjectManager projectManager, String clauseName, String documentConstant)
public String getDocumentConstant()
LuceneFieldSorter
getDocumentConstant
in interface LuceneFieldSorter<Project>
CustomFieldSearcher
public Project 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<Project>
documentValue
- The value of the field in the lucene indexpublic Comparator<Project> 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<Project>
public boolean isValidValue(Project value)
StatisticsMapper
isValidValue
in interface StatisticsMapper<Project>
value
- This is the same value that will be returned from LuceneFieldSorter.getValueFromLuceneField(String)
public boolean isFieldAlwaysPartOfAnIssue()
StatisticsMapper
isFieldAlwaysPartOfAnIssue
in interface StatisticsMapper<Project>
@Deprecated public SearchRequest getSearchUrlSuffix(Project 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<Project>
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 SearchRequestAppender<Project> getSearchRequestAppender()
getSearchRequestAppender
in interface SearchRequestAppender.Factory<Project>
protected String getClauseName()
public boolean equals(Object o)
LuceneFieldSorter
See the class javadoc entry for more details.
equals
in interface LuceneFieldSorter<Project>
equals
in class Object
public int hashCode()
LuceneFieldSorter
See the class javadoc entry for more details.
hashCode
in interface LuceneFieldSorter<Project>
hashCode
in class Object
Copyright © 2002-2019 Atlassian. All Rights Reserved.