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

java.lang.Object
  com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher
      com.atlassian.jira.issue.search.searchers.impl.GenericDateSearcher
          com.atlassian.jira.issue.customfields.searchers.DateRangeSearcher

All Implemented Interfaces:

CustomFieldSearcher, SortableCustomFieldSearcher, Field, IssueSearcher, Comparable

Direct Known Subclasses:

DateTimeRangeSearcher

public class DateRangeSearcher
extends GenericDateSearcher
implements SortableCustomFieldSearcher, CustomFieldSearcher

Field Summary

Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.GenericDateSearcher

ABSOLUTE_SUFFIX, AFTER_KEY, AFTER_SUFFIX, BEFORE_KEY, BEFORE_SUFFIX, dateConverter, fieldVisibilityBean, NEXT_KEY, NEXT_SUFFIX, PREVIOUS_KEY, PREVIOUS_SUFFIX, RELATIVE_SUFFIX

Fields inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher

authenticationContext, EDIT_TEMPLATE_SUFFIX, field, VIEW_TEMPLATE_SUFFIX

Fields inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher

I18N_BUNDLE

Constructor Summary

DateRangeSearcher(JiraAuthenticationContext authenticationContext, FieldVisibilityBean fieldVisibilityBean, DateConverter dateConverter)

Method Summary

String	getAfterFieldLabel()
String	getBeforeFieldLabel()
String	getDescription()
CustomFieldSearcherModuleDescriptor	getDescriptor()
String	getPeriodLabel()
List	getRelatedIndexers() Returns a list of FieldIndexer objects.
LuceneFieldSorter	getSorter(CustomField customField)
Object	getStringValue(CustomField customField, FieldValuesHolder fieldValuesHolder)
Object	getValue(CustomField customField, FieldValuesHolder fieldValuesHolder)
void	index(org.apache.lucene.document.Document doc, CustomField field, Object value)
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

Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.GenericDateSearcher

getAfterField, getBeforeField, getEditHtml, getId, getNameKey, getNextField, getPeriodOffset, getPrettyField, getPrettyNextField, getPrettyPreviousField, getPreviousField, getQuerySnippet, getSnippetFromFieldValuesHolder, getVelocityParams, getViewHtml, isRevelentForSeachRequest, populateFromParams, populateFromSearchRequest, populateSearchRequest, prettyPrintPeriodOffset, validateParams

Methods inherited from class com.atlassian.jira.issue.search.searchers.impl.AbstractIssueSearcher

compareTo, equals, getI18n, getName, hashCode, hasPermission, register, renderEditTemplate, renderViewTemplate, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.jira.issue.search.searchers.IssueSearcher

getEditHtml, getQuerySnippet, getViewHtml, isRevelentForSeachRequest, populateFromParams, populateFromSearchRequest, populateSearchRequest, register, validateParams

Methods inherited from interface com.atlassian.jira.issue.fields.Field

getId, getName, getNameKey

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

DateRangeSearcher

public DateRangeSearcher(JiraAuthenticationContext authenticationContext,
                         FieldVisibilityBean fieldVisibilityBean,
                         DateConverter dateConverter)

Method Detail

getBeforeFieldLabel

public String getBeforeFieldLabel()

Overrides:

getBeforeFieldLabel in class GenericDateSearcher

getAfterFieldLabel

public String getAfterFieldLabel()

Overrides:

getAfterFieldLabel in class GenericDateSearcher

getPeriodLabel

public String getPeriodLabel()

Overrides:

getPeriodLabel in class GenericDateSearcher

getDescription

public String getDescription()

Overrides:

getDescription in class GenericDateSearcher

init

public void init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)

Specified by:

init in interface CustomFieldSearcher

init

public void init(SearchableField field)

Description copied from interface: IssueSearcher

Initialises the searcher with a given field.

Specified by:

init in interface IssueSearcher

Overrides:

init in class AbstractIssueSearcher

Parameters:

field - the field object. This may be null. (So you can have searchers on non-fields)

getDescriptor

public CustomFieldSearcherModuleDescriptor getDescriptor()

Specified by:

getDescriptor in interface CustomFieldSearcher

getRelatedIndexers

public List getRelatedIndexers()

Description copied from interface: IssueSearcher

Returns a list of FieldIndexer objects. The objects should be initialised and ready for action

Specified by:

getRelatedIndexers in interface IssueSearcher

Overrides:

getRelatedIndexers in class GenericDateSearcher

Returns:

List of FieldIndexer objects. Must not be null. Return Collections.EMPTY_LIST if not available

getStringValue

public Object getStringValue(CustomField customField,
                             FieldValuesHolder fieldValuesHolder)

Specified by:

getStringValue in interface CustomFieldSearcher

getValue

public Object getValue(CustomField customField,
                       FieldValuesHolder fieldValuesHolder)

Specified by:

getValue in interface CustomFieldSearcher

isShown

public boolean isShown(SearchContext searchContext)

Description copied from interface: IssueSearcher

Checks if the searcher should be shown in this context

Specified by:

isShown in interface IssueSearcher

Overrides:

isShown in class AbstractIssueSearcher

Parameters:

searchContext - the context of the search (i.e. projects and issue types selected)

Returns:

true if the searcher will appear in the issue navigator

index

public void index(org.apache.lucene.document.Document doc,
                  CustomField field,
                  Object value)

getSorter

public LuceneFieldSorter getSorter(CustomField customField)

Specified by:

getSorter in interface SortableCustomFieldSearcher