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

Class ReporterIndexer

java.lang.Object

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

All Implemented Interfaces:

FieldIndexer, FieldWithVisibilityIndexer

public class ReporterIndexer
extends Object
implements FieldWithVisibilityIndexer

Since:

10.4

Field Summary

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
ReporterIndexer(FieldVisibilityManager fieldVisibilityManager)

Method Summary

Modifier and Type	Method	Description
Collection<Field>	getFields()	Declares the fields to be added to the index schema
String	getId()
void	indexFieldsWithVisibility(FieldValueCollector collector, Issue issue, CustomFieldPrefetchedData prefetchedData, boolean visible)	Enforce implementing indexFieldWithVisibility instead of indexFields.
boolean	isFieldVisibleAndInScope(Issue issue)	This method is used to determine if the indexer is relevant for the provided issue.
boolean	skipsIndexingNull()	Used to declare how the indexer handles nulls.

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.FieldWithVisibilityIndexer

indexFields

Constructor Details

ReporterIndexer

public ReporterIndexer(FieldVisibilityManager fieldVisibilityManager)

Method Details

getId

public String getId()

Specified by:

getId in interface FieldIndexer

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

indexFieldsWithVisibility

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

Description copied from interface: FieldWithVisibilityIndexer

Enforce implementing indexFieldWithVisibility instead of indexFields.

Specified by:

indexFieldsWithVisibility in interface FieldIndexer

Specified by:

indexFieldsWithVisibility in interface FieldWithVisibilityIndexer

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

isFieldVisibleAndInScope

public boolean isFieldVisibleAndInScope(Issue issue)

Description copied from interface: FieldIndexer

This method is used to determine if the indexer is relevant for the provided issue. This method must check the fields visibility, in relation to the field configuration scheme, must check any global flags that would enable or disable a field (such as enable votes flag), and must check, if the field is a custom field, if the custom field is relevant for this issue.

All these checks should take into account the IssueContext as defined by the passed in issue.

The result of this method is used to determine the correct values that should be returned when performing an empty search.

Specified by:

isFieldVisibleAndInScope in interface FieldIndexer

Parameters:

issue - that is having a document created from.

Returns:

if true then this field is relevant for the issue, otherwise it is not.

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