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

java.lang.Object
  extended by com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher
      extended by com.atlassian.jira.issue.customfields.searchers.AbstractCustomFieldSearcher
          extended by com.atlassian.jira.issue.customfields.searchers.AbstractSingleValueSearcher
              extended by com.atlassian.jira.issue.customfields.searchers.AbstractTextSearcher
                  extended by com.atlassian.jira.issue.customfields.searchers.TextSearcher
All Implemented Interfaces:
CustomFieldSearcher, SortableCustomFieldSearcher, Field, IssueSearcher, Comparable

public class TextSearcher
extends AbstractTextSearcher

A free-text searcher that uses the FreeTextParameter to search for a value. Note that values being searched for must parse as a legitimate lucene free text query.

TODO: rename this class to FreeTextSearcher with a deprecation plan


Field Summary
 
Fields inherited from class com.atlassian.jira.issue.customfields.searchers.AbstractTextSearcher
LUCENE_SORTFIELD_PREFIX, stringConverter
 
Fields inherited from class com.atlassian.jira.issue.customfields.searchers.BaseCustomFieldSearcher
authenticationContext, customField, descriptor
 
Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher
I18N_BUNDLE
 
Constructor Summary
TextSearcher(StringConverter stringConverter, FieldVisibilityBean fieldVisibilityBean)
           
 
Method Summary
 LuceneFieldSorter getSorter(CustomField customField)
           
 void index(org.apache.lucene.document.Document doc, CustomField field, Object value)
          Add index to the given Document object.
protected  SearchParameter makeSearchParameter(CustomField field, String paramValue, String paramPrefix)
           
 void validateParams(CustomField customField, SearchContext searchContext, FieldValuesHolder fieldValuesHolder, I18nHelper i18nHelper, ErrorCollection errors)
          Validates that the parameter is a well-formed query string for a FreeTextParameter.
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.AbstractTextSearcher
getValueFromSearchRequest
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.AbstractSingleValueSearcher
getParamsFromSearchRequest, getQuerySnippet, getViewObject, makeSearchParameters
 
Methods inherited from class com.atlassian.jira.issue.customfields.searchers.AbstractCustomFieldSearcher
getEditHtml, getI18n, getQuerySnippet, getRelatedIndexers, getViewHtml, isExistsInSeachRequest, isRevelentForSeachRequest, populateFromParams, populateFromParams, populateFromSearchRequest, populateSearchRequest, validateParams
 
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

TextSearcher

public TextSearcher(StringConverter stringConverter,
                    FieldVisibilityBean fieldVisibilityBean)
Method Detail

index

public void index(org.apache.lucene.document.Document doc,
                  CustomField field,
                  Object value)
Description copied from class: AbstractCustomFieldSearcher
Add index to the given Document object. The "value" is/are the value object (s) returned from the CustomFieldType.

Specified by:
index in class AbstractCustomFieldSearcher

makeSearchParameter

protected SearchParameter makeSearchParameter(CustomField field,
                                              String paramValue,
                                              String paramPrefix)
                                       throws FieldValidationException
Specified by:
makeSearchParameter in class AbstractSingleValueSearcher
Throws:
FieldValidationException

getSorter

public LuceneFieldSorter getSorter(CustomField customField)

validateParams

public void validateParams(CustomField customField,
                           SearchContext searchContext,
                           FieldValuesHolder fieldValuesHolder,
                           I18nHelper i18nHelper,
                           ErrorCollection errors)
Validates that the parameter is a well-formed query string for a FreeTextParameter.

Overrides:
validateParams in class AbstractCustomFieldSearcher
Parameters:
customField - the field being searched.
searchContext - the search context being used.
fieldValuesHolder - the values of the searched fields.
i18nHelper - helper for i18n.
errors - to be used to add any validation errors.


Copyright © 2002-2009 Atlassian. All Rights Reserved.