|
||||||||||
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.QuerySearcher
public class QuerySearcher
Field Summary | |
---|---|
static String |
COMMENT_FIELD
|
static String |
DESCRIPTION_FIELD
|
static String |
ENVIRONMENT_FIELDS
|
static String |
ID
|
static List |
INVALID_FIRST_CHAR_LIST
|
static String |
LUCENE_PARAM_NAME
|
static String |
NAME_KEY
|
static List |
QUERY_FIELDS_DEFAULT
|
static String |
QUERY_FIELDS_ID
|
static List |
QUERY_FIELDS_LIST
|
static String |
SUMMARY_FIELD
|
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 | |
---|---|
QuerySearcher(JiraAuthenticationContext authenticationContext,
FieldVisibilityBean fieldVisibilityBean)
|
Method Summary | |
---|---|
String |
getId()
The unique id of the field |
String |
getNameKey()
The i18n key that is used to lookup the field's name when it is displayed |
Collection |
getQueryFieldNames(FieldValuesHolder fieldValuesHolder)
|
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. |
boolean |
isFieldSelected(String fieldId,
FieldValuesHolder fieldValuesHolder)
|
boolean |
isFieldVisible(String fieldId,
FieldValuesHolder fieldValuesHolder,
SearchContext searchContext)
|
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,
FieldValuesHolder fieldValuesHolder)
Populate the SearchRequest with SearchParameter objects from the FieldValuesHolder |
void |
updateSearchRequestParams(SearchRequest searchRequest,
Collection fields,
String query)
A simple method to update a search request. |
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, getEditHtml, getI18n, getName, getVelocityParams, getViewHtml, hashCode, hasPermission, init, isShown, register, renderEditTemplate, renderViewTemplate, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher |
---|
getEditHtml, getViewHtml, init, isShown, register |
Methods inherited from interface com.atlassian.jira.issue.fields.Field |
---|
getName |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
public static final List INVALID_FIRST_CHAR_LIST
public static final String ID
public static final String NAME_KEY
public static final String SUMMARY_FIELD
public static final String DESCRIPTION_FIELD
public static final String ENVIRONMENT_FIELDS
public static final String COMMENT_FIELD
public static final String QUERY_FIELDS_ID
public static final List QUERY_FIELDS_LIST
public static final List QUERY_FIELDS_DEFAULT
public static final String LUCENE_PARAM_NAME
Constructor Detail |
---|
public QuerySearcher(JiraAuthenticationContext authenticationContext, FieldVisibilityBean fieldVisibilityBean)
Method Detail |
---|
public String getId()
Field
getId
in interface Field
public String getNameKey()
Field
getNameKey
in interface Field
public List getRelatedIndexers()
IssueSearcher
FieldIndexer
objects. The objects should be initialised and ready for action
getRelatedIndexers
in interface IssueSearcher
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
validateParams
in interface IssueSearcher
searchContext
- the context of the search (i.e. projects and issue types selected)fieldValuesHolder
- contains values populated by the searcherspublic void updateSearchRequestParams(SearchRequest searchRequest, Collection fields, String query) throws IllegalArgumentException
IllegalArgumentException
- If the query passed is not a valid querypublic void populateFromParams(FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
IssueSearcher
FieldValuesHolder
object with whatever values the searcher is interested in from the ActionParams
populateFromParams
in interface IssueSearcher
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)
populateFromSearchRequest
in interface IssueSearcher
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
populateSearchRequest
in interface IssueSearcher
searchRequest
- relevent search requestfieldValuesHolder
- contains values populated by the searcherspublic boolean isRevelentForSeachRequest(SearchRequest searchRequest)
IssueSearcher
SearchParameter
objects that was created by the searcher
isRevelentForSeachRequest
in interface IssueSearcher
searchRequest
- relevent search request
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.
getQuerySnippet
in interface IssueSearcher
searchRequest
- relevent search request
JiraUrlCodec.encode(String)
encoded string representing the relevent SearchParameter
in the searchRequestpublic boolean isFieldSelected(String fieldId, FieldValuesHolder fieldValuesHolder)
public boolean isFieldVisible(String fieldId, FieldValuesHolder fieldValuesHolder, SearchContext searchContext)
public Collection getQueryFieldNames(FieldValuesHolder fieldValuesHolder)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |