Package com.atlassian.jira.search.issue.index.indexers.impl

Class LocalDateIndexer

java.lang.Object

com.atlassian.jira.search.issue.index.indexers.impl.BaseCustomFieldIndexer

com.atlassian.jira.search.issue.index.indexers.impl.LocalDateIndexer

All Implemented Interfaces:

CustomFieldIndexer, FieldIndexer

@PublicApi
public class LocalDateIndexer
extends BaseCustomFieldIndexer
implements FieldIndexer

A custom field indexer for date fields that can be sorted.

Since:

10.6

Field Summary

Fields inherited from class com.atlassian.jira.search.issue.index.indexers.impl.BaseCustomFieldIndexer

customField, field

Fields inherited from interface com.atlassian.jira.search.issue.index.indexers.FieldIndexer

LABELS_NO_VALUE_INDEX_VALUE, NO_VALUE_INDEX_VALUE

Constructor Summary

Constructors

Constructor	Description
LocalDateIndexer(FieldVisibilityManager fieldVisibilityManager, CustomField customField, boolean skipIndexingNull)

Method Summary

Modifier and Type	Method	Description
Collection<Field>	getFields()	Declares the fields to be added to the index schema
String	getId()
void	indexFields(FieldValueCollector collector, Issue issue, CustomFieldPrefetchedData prefetchedData)	This method allows an indexer the opportunity to add values to the provided collector that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.
void	indexFieldsWithVisibility(FieldValueCollector collector, Issue issue, CustomFieldPrefetchedData prefetchedData, boolean visible)	The same as indexField but accepts an additional parameter to indicate if the field is visible and in scope.
boolean	skipsIndexingNull()	Used to declare how the indexer handles nulls.

Methods inherited from class com.atlassian.jira.search.issue.index.indexers.impl.BaseCustomFieldIndexer

getCustomField, indexField, isFieldVisibleAndInScope

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.search.issue.index.indexers.FieldIndexer

isFieldVisibleAndInScope

Constructor Details

LocalDateIndexer

public LocalDateIndexer(FieldVisibilityManager fieldVisibilityManager,
 CustomField customField,
 boolean skipIndexingNull)

Method Details

getId

public String getId()

Specified by:

getId in interface FieldIndexer

Overrides:

getId in class BaseCustomFieldIndexer

Returns:

the String representation of the field id that this indexer is indexing, this must be unique for each independent FieldIndexer. If the Indexer does not represent a System or Custom field in Jira this should still return a unique string that describes the indexer.

getFields

public Collection<Field> getFields()

Description copied from interface: FieldIndexer

Declares the fields to be added to the index schema

Specified by:

getFields in interface FieldIndexer

Overrides:

getFields in class BaseCustomFieldIndexer

indexFields

public void indexFields(FieldValueCollector collector,
 Issue issue,
 CustomFieldPrefetchedData prefetchedData)

Description copied from interface: FieldIndexer

This method allows an indexer the opportunity to add values to the provided collector that are relevant for searching and storage of the portion of the issue that the FieldIndexer handles.

If, for example, the indexer handles indexing an issues summary then this indexer will add a field value to the collector that represents the stored and searchable summary of the issue.

Note that trying to index very large (i.e. larger than ~32 kB) fields as KeywordField will result in them being removed to prevent the indexing operation from crashing. This is a limitation of how OpenSearch and Lucene store terms.

Specified by:

indexFields in interface FieldIndexer

Parameters:

collector - the collector for collecting indexed values

issue - the issue that contains the data that will be indexed and which can be used to determine the project/issue type context that will allow you to determine if we should add the value as searchable or unsearchable.

prefetchedData - if the custom field type implemented CustomFieldType.getNonNullCustomFieldProvider() this reference will hold the matching value returned from NonNullCustomFieldProvider.getCustomFieldInfo(List <Issue>)

indexFieldsWithVisibility

public void indexFieldsWithVisibility(FieldValueCollector collector,
 Issue issue,
 CustomFieldPrefetchedData prefetchedData,
 boolean visible)

Description copied from interface: FieldIndexer

The same as indexField but accepts an additional parameter to indicate if the field is visible and in scope. Thanks to that there is no need to call FieldIndexer.isFieldVisibleAndInScope(Issue) method inside. The default implementation is for backward compatibility. An indexer that wants to take advantage of performance gain should implement FieldWithVisibilityIndexer interface

Specified by:

indexFieldsWithVisibility in interface FieldIndexer

Parameters:

collector - the collector for collecting indexed values

issue - that is having a document created from.

prefetchedData - if the custom field type implemented CustomFieldType.getNonNullCustomFieldProvider() this reference will hold the matching value returned from NonNullCustomFieldProvider.getCustomFieldInfo(List <Issue>)*

skipsIndexingNull

public boolean skipsIndexingNull()

Description copied from interface: FieldIndexer

Used to declare how the indexer handles nulls.

Specified by:

skipsIndexingNull in interface FieldIndexer

Returns:

true if the indexer doesn't do anything when the field value is null