|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher com.atlassian.jira.issue.search.searchers.impl.SearchContextSearcher
Field Summary | |
protected ConstantsManager |
constantsManager
|
static String |
ID
|
static String |
ISSUE_TYPES_KEY
|
protected IssueTypeSchemeManager |
issueTypeSchemeManager
|
static String |
NAME_KEY
|
protected OptionSetManager |
optionSetManager
|
protected PermissionManager |
permissionManager
|
static String |
PROJECT_KEY
|
protected ProjectManager |
projectManager
|
protected SubTaskManager |
subTaskManager
|
Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher |
authenticationContext, EDIT_TEMPLATE_SUFFIX, field, VIEW_TEMPLATE_SUFFIX |
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher |
I18N_BUNDLE, log |
Constructor Summary | |
SearchContextSearcher(JiraAuthenticationContext authenticationContext,
PermissionManager permissionManager,
SubTaskManager subTaskManager,
ConstantsManager constantsManager,
ProjectManager projectManager,
IssueTypeSchemeManager issueTypeSchemeManager,
OptionSetManager optionSetManager)
|
Method Summary | |
String |
getCssClassForOption(Option option)
|
String |
getEditHtml(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map displayParameters,
webwork.action.Action action)
|
org.ofbiz.core.entity.GenericValue |
getFirstProject()
|
String |
getId()
The unique id of the field |
String |
getIssueTypeFieldId()
|
String |
getNameKey()
The i18n key that is used to lookup the field's name when it is displayed |
String |
getProjectFieldId()
|
String |
getQuerySnippet(SearchRequest searchRequest)
Returns a JiraUrlCodec.encode(String) encoded string representing the relevent SearchParameter
in the searchRequest. |
List |
getRelatedIndexers()
Returns a list of FieldIndexer objects. |
static SearchContext |
getSearchContext(FieldValuesHolder fieldValuesHolder)
|
String |
getViewHtml(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map displayParameters,
webwork.action.Action action)
|
Collection |
getVisibleProjects()
|
boolean |
isRevelentForSeachRequest(SearchRequest searchRequest)
Checks if the searchRequest object has SearchParameter objects that was created by the searcher |
void |
populateFromParams(FieldValuesHolder fieldValuesHolder,
ActionParams actionParams)
Populate FieldValuesHolder object with whatever values the searcher is interested in from the ActionParams |
void |
populateFromSearchRequest(FieldValuesHolder fieldValuesHolder,
SearchRequest searchRequest)
Populate FieldValuesHolder from the SearchRequest object. |
void |
populateSearchRequest(SearchRequest searchRequest,
Collection projectIds,
Collection issueTypeIds)
Populates the searchRequest given the list of project ids and issue type ids |
void |
populateSearchRequest(SearchRequest searchRequest,
FieldValuesHolder fieldValuesHolder)
Populate the SearchRequest with SearchParameter objects from the FieldValuesHolder |
static SearchContextSearcher |
retrieveSearcher(SearcherRegistry searcherRegistry)
|
void |
validateParams(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
I18nHelper i18nHelper,
ErrorCollection errors)
Adds error meessages to the errors object if values in the fieldValuesHolder fails validation. |
Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher |
compareTo, equals, getI18n, getName, getVelocityParams, hashCode, hasPermission, init, isShown, register, renderEditTemplate, renderViewTemplate, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String ID
public static final String NAME_KEY
public static final String ISSUE_TYPES_KEY
public static final String PROJECT_KEY
protected final PermissionManager permissionManager
protected final SubTaskManager subTaskManager
protected final ConstantsManager constantsManager
protected final ProjectManager projectManager
protected final IssueTypeSchemeManager issueTypeSchemeManager
protected final OptionSetManager optionSetManager
Constructor Detail |
public SearchContextSearcher(JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, SubTaskManager subTaskManager, ConstantsManager constantsManager, ProjectManager projectManager, IssueTypeSchemeManager issueTypeSchemeManager, OptionSetManager optionSetManager)
Method Detail |
public String getId()
Field
public String getNameKey()
Field
public List getRelatedIndexers()
IssueSearcher
FieldIndexer
objects. The objects should be initialised and ready for action
List
of FieldIndexer
objects. Must not be null. Return Collections.EMPTY_LIST
if not availablepublic void validateParams(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
IssueSearcher
searchContext
- the context of the search (i.e. projects and issue types selected)fieldValuesHolder
- contains values populated by the searchersi18nHelper
- errors
- public void populateFromParams(FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
IssueSearcher
FieldValuesHolder
object with whatever values the searcher is interested in from the ActionParams
fieldValuesHolder
- contains values populated by the searchersactionParams
- params from the webwork front endpublic void populateFromSearchRequest(FieldValuesHolder fieldValuesHolder, SearchRequest searchRequest)
IssueSearcher
FieldValuesHolder
from the SearchRequest
object. Which SearchParameter
really
to take from the SR should match with the method IssueSearcher.populateSearchRequest(SearchRequest, FieldValuesHolder)
fieldValuesHolder
- contains values populated by the searcherssearchRequest
- relevent search requestIssueSearcher.populateSearchRequest(SearchRequest, FieldValuesHolder)
public void populateSearchRequest(SearchRequest searchRequest, FieldValuesHolder fieldValuesHolder)
IssueSearcher
SearchRequest
with SearchParameter
objects from the FieldValuesHolder
searchRequest
- relevent search requestfieldValuesHolder
- contains values populated by the searcherspublic String getEditHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
getEditHtml
in interface IssueSearcher
getEditHtml
in class AbstractIssueSearcher
public String getViewHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
getViewHtml
in interface IssueSearcher
getViewHtml
in class AbstractIssueSearcher
public String getQuerySnippet(SearchRequest searchRequest)
IssueSearcher
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequest. The queryString should be able to be converted back to the original SearchRequest. i.e.
getQuerySnippet -> String -> populateFromParams -> FieldValuesHolder -> populateSearchRequest -> SearchRequest ->
getQuerySnippet should return the same original string.
searchRequest
- relevent search request
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequestpublic boolean isRevelentForSeachRequest(SearchRequest searchRequest)
IssueSearcher
SearchParameter
objects that was created by the searcher
searchRequest
- relevent search request
public String getProjectFieldId()
public String getIssueTypeFieldId()
public Collection getVisibleProjects()
public org.ofbiz.core.entity.GenericValue getFirstProject()
public String getCssClassForOption(Option option)
public void populateSearchRequest(SearchRequest searchRequest, Collection projectIds, Collection issueTypeIds)
searchRequest
- projectIds
- Collection
of Long
Null safeissueTypeIds
- Collection
of String
Null safe. Issue Type ids may contain special issue type ids.ConstantsManager.ALL_ISSUE_TYPES
,
ConstantsManager.ALL_STANDARD_ISSUE_TYPES
,
ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES
public static SearchContext getSearchContext(FieldValuesHolder fieldValuesHolder)
public static SearchContextSearcher retrieveSearcher(SearcherRegistry searcherRegistry)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |