com.atlassian.jira.dev.reference.plugin.searchers
Class LabelSearcher

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
      extended by com.atlassian.jira.dev.reference.plugin.searchers.LabelSearcher
All Implemented Interfaces:
CustomFieldSearcher, SortableCustomFieldSearcher, CustomFieldStattable, IssueSearcher<CustomField>

public class LabelSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, SortableCustomFieldSearcher, CustomFieldStattable

Referemce class that implements a custom field searcher - in this case for labels.

Since:
v4.3

Field Summary
 
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher
log
 
Constructor Summary
LabelSearcher(JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper, JiraAuthenticationContext authenticationContext)
           
 
Method Summary
 CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()
          Provides an object that can be used to handle the clauses that this searcher generates.
 SearcherInformation<CustomField> getSearchInformation()
          Provides an object that contains information about the Searcher.
 SearchInputTransformer getSearchInputTransformer()
          Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.
 SearchRenderer getSearchRenderer()
          Provides an object that will allow you to render the edit and view html for a searcher.
 LuceneFieldSorter getSorter(CustomField customField)
           
 StatisticsMapper getStatisticsMapper(CustomField customField)
           
 void init(CustomField field)
          Initialises the searcher with a given field.
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
getDescriptor, init
 
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.customfields.CustomFieldSearcher
getDescriptor, init
 

Constructor Detail

LabelSearcher

public LabelSearcher(JqlOperandResolver jqlOperandResolver,
                     CustomFieldInputHelper customFieldInputHelper,
                     JiraAuthenticationContext authenticationContext)
Method Detail

init

public void init(CustomField field)
Description copied from interface: IssueSearcher
Initialises the searcher with a given field.

Specified by:
init in interface IssueSearcher<CustomField>
Parameters:
field - the field object. This may be null. (So you can have searchers on non-fields)

getSearchInformation

public SearcherInformation<CustomField> getSearchInformation()
Description copied from interface: IssueSearcher
Provides an object that contains information about the Searcher.

Specified by:
getSearchInformation in interface IssueSearcher<CustomField>
Returns:
the search information provider for this searcher.

getSearchInputTransformer

public SearchInputTransformer getSearchInputTransformer()
Description copied from interface: IssueSearcher
Provides an object that will allow you to transform raw request parameters to field holder values and field holder values to Clause search representations.

Specified by:
getSearchInputTransformer in interface IssueSearcher<CustomField>
Returns:
the search input handler for this searcher.

getSearchRenderer

public SearchRenderer getSearchRenderer()
Description copied from interface: IssueSearcher
Provides an object that will allow you to render the edit and view html for a searcher. This also provides methods that indicate if the view and edit methods should be invoked.

Specified by:
getSearchRenderer in interface IssueSearcher<CustomField>
Returns:
the search renderer for this searcher.

getCustomFieldSearcherClauseHandler

public CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()
Description copied from interface: CustomFieldSearcher
Provides an object that can be used to handle the clauses that this searcher generates.

Specified by:
getCustomFieldSearcherClauseHandler in interface CustomFieldSearcher
Returns:
an object that can be used to handle the clauses that this searcher generates, can be null.

getSorter

public LuceneFieldSorter getSorter(CustomField customField)
Specified by:
getSorter in interface SortableCustomFieldSearcher

getStatisticsMapper

public StatisticsMapper getStatisticsMapper(CustomField customField)
Specified by:
getStatisticsMapper in interface CustomFieldStattable


Copyright © 2002-2012 Atlassian. All Rights Reserved.