com.atlassian.jira.issue.customfields.searchers

Class AbstractDateRangeSearcher

java.lang.Object

com.atlassian.jira.issue.customfields.searchers.AbstractInitializationCustomFieldSearcher

com.atlassian.jira.issue.customfields.searchers.AbstractDateRangeSearcher

All Implemented Interfaces:

CustomFieldSearcher, NaturallyOrderedCustomFieldSearcher, IssueSearcher<CustomField>

Direct Known Subclasses:

DateTimeRangeSearcher

public abstract class AbstractDateRangeSearcher
extends AbstractInitializationCustomFieldSearcher
implements NaturallyOrderedCustomFieldSearcher, CustomFieldSearcher

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description

AbstractDateRangeSearcher(JqlOperandResolver jqlOperandResolver, VelocityRequestContextFactory velocityRenderContext, ApplicationProperties applicationProperties, VelocityTemplatingEngine templatingEngine, CalendarLanguageUtil calendarUtils, DateConverter dateConverter, JqlDateSupport dateSupport, TimeZoneManager timeZoneManager, FieldVisibilityManager fieldVisibilityManager, IndexingFeatures indexingFeatures)

Method Summary

Modifier and Type	Method and Description
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.
String	getSortField(CustomField customField) Return the name of the Lucene field to use for ordering.
org.apache.lucene.search.SortField.Type	getSortFieldType() Returns the type to use when sorting on the values of this custom field.
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

AbstractDateRangeSearcher

public AbstractDateRangeSearcher(JqlOperandResolver jqlOperandResolver,
                                 VelocityRequestContextFactory velocityRenderContext,
                                 ApplicationProperties applicationProperties,
                                 VelocityTemplatingEngine templatingEngine,
                                 CalendarLanguageUtil calendarUtils,
                                 DateConverter dateConverter,
                                 JqlDateSupport dateSupport,
                                 TimeZoneManager timeZoneManager,
                                 FieldVisibilityManager fieldVisibilityManager,
                                 IndexingFeatures indexingFeatures)

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.

getSortField

public String getSortField(CustomField customField)

Description copied from interface: NaturallyOrderedCustomFieldSearcher

Return 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 ordering.

getSortFieldType

public org.apache.lucene.search.SortField.Type getSortFieldType()

Description copied from interface: NaturallyOrderedCustomFieldSearcher

Returns the type to use when sorting on the values of this custom field. This also necessitates adding NumericDocValues to documents for numeric and date data types, and SortedDocValues for string types at indexing time.

Specified by:

getSortFieldType in interface NaturallyOrderedCustomFieldSearcher

Returns:

type to expect when sorting values of this custom field.