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

Class GroupCustomFieldIndexer

java.lang.Object

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

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

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

All Implemented Interfaces:

CustomFieldIndexer, FieldIndexer

public class GroupCustomFieldIndexer
extends BaseCustomFieldIndexer

A simple custom field indexer for group custom fields

Replaces GroupCustomFieldIndexer.

This indexer is not utilized within Jira, as both single and multiple group picker custom fields rely on the MultiGroupCustomFieldIndexer. However, it is still in use by ScriptRunner, so it should not be removed.

Since:

10.6

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.search.issue.index.indexers.impl.VisibilityBaseFieldIndexer

VisibilityBaseFieldIndexer.UnsearchableFieldBuilder

Field Summary

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

customField

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

fieldVisibilityManager, invisibleField, visibleField

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

NO_VALUE_INDEX_VALUE

Constructor Summary

Constructors

Constructor	Description
GroupCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager, CustomField customField, GroupConverter groupConverter)

Method Summary

Modifier and Type	Method	Description
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.

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

getCustomField, getId, isFieldVisibleAndInScope

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

getField, getFields, indexField, indexField, indexField, indexField, indexFieldsForSorting

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

getFields, skipsIndexingNull

Constructor Details

GroupCustomFieldIndexer

public GroupCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager,
 CustomField customField,
 GroupConverter groupConverter)

Method Details

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.

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>)