com.atlassian.jira.issue.customfields.searchers
Class ExactTextSearcher

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher
      extended by com.atlassian.jira.issue.customfields.searchers.ExactTextSearcher
All Implemented Interfaces:
CustomFieldSearcher, NaturallyOrderedCustomFieldSearcher, IssueSearcher<CustomField>

@PublicSpi
@PublicApi
public class ExactTextSearcher
extends AbstractInitializationCustomFieldSearcher
implements CustomFieldSearcher, NaturallyOrderedCustomFieldSearcher

A searcher for custom fields that contain exact text (e.g. url)


Field Summary
 
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher
log
 
Constructor Summary
ExactTextSearcher(JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper)
          Deprecated. Use ExactTextSearcher(JqlOperandResolver, CustomFieldInputHelper, FieldVisibilityManager) instead. Since v4.4.
ExactTextSearcher(JqlOperandResolver jqlOperandResolver, CustomFieldInputHelper customFieldInputHelper, FieldVisibilityManager fieldVisibilityManager)
           
 
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)
           
 String getSortField(CustomField customField)
          Retrun the name of the Lucene field to use for ordering.
 void init(CustomField field)
          This is the first time the searcher knows what its ID and names are
 
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

ExactTextSearcher

public ExactTextSearcher(JqlOperandResolver jqlOperandResolver,
                         CustomFieldInputHelper customFieldInputHelper)
Deprecated. Use ExactTextSearcher(JqlOperandResolver, CustomFieldInputHelper, FieldVisibilityManager) instead. Since v4.4.

Old Constructor - deprecated.

Parameters:
jqlOperandResolver -
customFieldInputHelper -

ExactTextSearcher

public ExactTextSearcher(JqlOperandResolver jqlOperandResolver,
                         CustomFieldInputHelper customFieldInputHelper,
                         FieldVisibilityManager fieldVisibilityManager)
Method Detail

init

public void init(CustomField field)
This is the first time the searcher knows what its ID and names are

Specified by:
init in interface IssueSearcher<CustomField>
Parameters:
field - the Custom Field for this searcher

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)

getSortField

public String getSortField(CustomField customField)
Description copied from interface: NaturallyOrderedCustomFieldSearcher
Retrun the name of the Lucene field to use for ordering. This will normally be just the field, .i.e customField.getId() but some searchers, e.g. TextSearcher, store additional fields to support sorting.

Specified by:
getSortField in interface NaturallyOrderedCustomFieldSearcher
Parameters:
customField - The custom field to be searched
Returns:
The Lucene field name to use for orderring.


Copyright © 2002-2014 Atlassian. All Rights Reserved.