|
||||||||||
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
public abstract class BaseCustomFieldSearcher
This is the recommended extension point for CustomFieldSearcher
since JIRA 3.3. It offers basic functionality
typical to custom field searchers.
Field Summary | |
---|---|
protected JiraAuthenticationContext |
authenticationContext
|
protected CustomField |
customField
|
protected CustomFieldSearcherModuleDescriptor |
descriptor
|
protected static org.apache.log4j.Logger |
log
|
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher |
---|
I18N_BUNDLE |
Constructor Summary | |
---|---|
BaseCustomFieldSearcher(FieldVisibilityBean fieldVisibilityBean)
|
Method Summary | |
---|---|
int |
compareTo(Object o)
|
CustomFieldSearcherModuleDescriptor |
getDescriptor()
|
String |
getId()
The unique id of the field |
String |
getName()
Returns i18n'ed name of the field for system fields or the name of a custom field. |
String |
getNameKey()
The i18n key that is used to lookup the field's name when it is displayed |
Object |
getStringValue(CustomField customField,
FieldValuesHolder fieldValuesHolder)
|
Object |
getValue(CustomField customField,
FieldValuesHolder fieldValuesHolder)
|
void |
init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)
|
void |
init(SearchableField field)
Initialises the searcher with a given field. |
boolean |
isShown(SearchContext searchContext)
Checks if the searcher should be shown in this context |
void |
register(SearcherRegistry registry)
Registers the searcher in the registry. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher |
---|
getEditHtml, getQuerySnippet, getRelatedIndexers, getViewHtml, isRevelentForSeachRequest, populateFromParams, populateFromSearchRequest, populateSearchRequest, validateParams |
Field Detail |
---|
protected static final org.apache.log4j.Logger log
protected CustomFieldSearcherModuleDescriptor descriptor
protected CustomField customField
protected final JiraAuthenticationContext authenticationContext
Constructor Detail |
---|
public BaseCustomFieldSearcher(FieldVisibilityBean fieldVisibilityBean)
Method Detail |
---|
public void init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)
init
in interface CustomFieldSearcher
public CustomFieldSearcherModuleDescriptor getDescriptor()
getDescriptor
in interface CustomFieldSearcher
public Object getStringValue(CustomField customField, FieldValuesHolder fieldValuesHolder)
getStringValue
in interface CustomFieldSearcher
public Object getValue(CustomField customField, FieldValuesHolder fieldValuesHolder)
getValue
in interface CustomFieldSearcher
public String getId()
Field
getId
in interface Field
public String getNameKey()
Field
getNameKey
in interface Field
public String getName()
Field
getName
in interface Field
public void register(SearcherRegistry registry)
IssueSearcher
register
in interface IssueSearcher
registry
- The Searcher registrypublic void init(SearchableField field)
IssueSearcher
init
in interface IssueSearcher
field
- the field object. This may be null. (So you can have searchers on non-fields)public int compareTo(Object o)
compareTo
in interface Comparable
public boolean isShown(SearchContext searchContext)
IssueSearcher
isShown
in interface IssueSearcher
searchContext
- the context of the search (i.e. projects and issue types selected)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |