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

Class WatcherIndexer

java.lang.Object

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

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

All Implemented Interfaces:

FieldIndexer

public class WatcherIndexer
extends VisibilityBaseFieldIndexer

Indexes the user keys of the users that are watching issues.

Since:

10.4

Field Summary

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

fieldVisibilityManager

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
WatcherIndexer(FieldVisibilityManager fieldVisibilityManager, IssueWatcherAccessor watcherAccessor)

Method Summary

Modifier and Type	Method	Description
Collection<Field>	getFields()	Declares the fields to be added to the index schema
String	getId()
protected void	indexVisibleFields(FieldValueCollector collector, Issue issue, CustomFieldPrefetchedData prefetchedData)
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 com.atlassian.jira.search.issue.index.indexers.impl.VisibilityBaseFieldIndexer

indexFields, indexFieldsWithVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WatcherIndexer

public WatcherIndexer(FieldVisibilityManager fieldVisibilityManager,
 IssueWatcherAccessor watcherAccessor)

Method Details

getId

public String getId()

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

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

Overrides:

isFieldVisibleAndInScope in class VisibilityBaseFieldIndexer

Parameters:

issue - that is having a document created from.

Returns:

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

indexVisibleFields

protected void indexVisibleFields(FieldValueCollector collector,
 Issue issue,
 CustomFieldPrefetchedData prefetchedData)

Specified by:

indexVisibleFields in class VisibilityBaseFieldIndexer

skipsIndexingNull

public boolean skipsIndexingNull()

Description copied from interface: FieldIndexer

Used to declare how the indexer handles nulls.

Returns:

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