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

Class CustomFieldLabelsIndexer

java.lang.Object

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

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

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

All Implemented Interfaces:

CustomFieldIndexer, FieldIndexer

@Internal
public class CustomFieldLabelsIndexer
extends BaseLabelsIndexer
implements CustomFieldIndexer

Labels indexer for custom fields.

Since:

10.4

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FOLDED_EXT

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

NO_VALUE_INDEX_VALUE

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
CustomFieldLabelsIndexer(FieldVisibilityManager fieldVisibilityManager, CustomField customField)

Method Summary

Modifier and Type	Method	Description
CustomField	getCustomField()	Returns the custom field associated with this indexer
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.

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

getFields, indexLabels

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

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

getFields, indexFields, indexFieldsWithVisibility, skipsIndexingNull

Field Details

FOLDED_EXT

public static final String FOLDED_EXT

See Also:

• Constant Field Values

Constructor Details

CustomFieldLabelsIndexer

public CustomFieldLabelsIndexer(FieldVisibilityManager fieldVisibilityManager,
 CustomField customField)

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.

indexVisibleFields

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

Overrides:

indexVisibleFields in class BaseLabelsIndexer

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.

getCustomField

public CustomField getCustomField()

Description copied from interface: CustomFieldIndexer

Returns the custom field associated with this indexer

Specified by:

getCustomField in interface CustomFieldIndexer

Returns:

CustomField