|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher com.atlassian.jira.issue.customfields.searchers.AbstractCustomFieldSearcher
This class was the preferred extension point for CustomFieldSearcher
in JIRA 3.0 - 3.2. Since 3.3 this class
is maintained only for backwards compatibility with all legacy searchers. All older searchers should still work but any
new searchers should extend BaseCustomFieldSearcher
instead.
Field Summary |
Fields inherited from class com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher |
authenticationContext, customField, descriptor, log |
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher |
I18N_BUNDLE |
Constructor Summary | |
AbstractCustomFieldSearcher(FieldVisibilityBean fieldVisibilityBean)
|
Method Summary | |
String |
getEditHtml(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map displayParameters,
webwork.action.Action action)
|
protected I18nHelper |
getI18n()
|
abstract CustomFieldParams |
getParamsFromSearchRequest(CustomField customField,
SearchRequest searchRequest)
|
abstract String |
getQuerySnippet(CustomField customField,
SearchRequest searchRequest)
Returns a query string that can be interpreted by the IssueNavigator action to execute this as a search
request. |
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. |
String |
getViewHtml(SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
Map displayParameters,
webwork.action.Action action)
|
abstract void |
index(org.apache.lucene.document.Document doc,
CustomField field,
Object value)
Add index to the given Document object. |
boolean |
isExistsInSeachRequest(CustomField customField,
SearchRequest searchRequest)
|
boolean |
isRevelentForSeachRequest(SearchRequest searchRequest)
Checks if the searchRequest object has SearchParameter objects that was created by the searcher |
abstract List |
makeSearchParameters(CustomField field,
CustomFieldParams params)
|
void |
populateFromParams(CustomField customField,
FieldValuesHolder fieldValuesHolder,
ActionParams actionParams)
|
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 |
validateParams(CustomField customField,
SearchContext searchContext,
FieldValuesHolder fieldValuesHolder,
I18nHelper i18nHelper,
ErrorCollection errors)
|
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.customfields.searchers.BaseCustomFieldSearcher |
compareTo, getDescriptor, getId, getName, getNameKey, getStringValue, getValue, init, init, isShown, register |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractCustomFieldSearcher(FieldVisibilityBean fieldVisibilityBean)
Method Detail |
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 boolean isRevelentForSeachRequest(SearchRequest searchRequest)
IssueSearcher
SearchParameter
objects that was created by the searcher
searchRequest
- relevent search request
public String getEditHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
public String getViewHtml(SearchContext searchContext, FieldValuesHolder fieldValuesHolder, Map displayParameters, webwork.action.Action action)
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 searchRequestprotected I18nHelper getI18n()
public void validateParams(CustomField customField, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
public boolean isExistsInSeachRequest(CustomField customField, SearchRequest searchRequest)
public void populateFromParams(CustomField customField, FieldValuesHolder fieldValuesHolder, ActionParams actionParams)
public abstract List makeSearchParameters(CustomField field, CustomFieldParams params)
field
- params
- must never be null
SearchParameter
s.public abstract CustomFieldParams getParamsFromSearchRequest(CustomField customField, SearchRequest searchRequest)
public abstract void index(org.apache.lucene.document.Document doc, CustomField field, Object value)
doc
- field
- value
- public abstract String getQuerySnippet(CustomField customField, SearchRequest searchRequest)
IssueNavigator
action to execute this as a search
request. The query string can then be used to partially reconstruct the searchRequest being passed i. The
returned query string should be encoded using JiraUrlCodec.encode(java.lang.String)
and begin with an &.
customField
- - custom field call this methodsearchRequest
- - the search request to get the url parameters from
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |