com.atlassian.jira.dev.reference.plugin.searchers

Class LabelsCustomFieldIndexer

java.lang.Object

com.atlassian.jira.issue.index.indexers.impl.AbstractCustomFieldIndexer

com.atlassian.jira.dev.reference.plugin.searchers.LabelsCustomFieldIndexer

All Implemented Interfaces:

FieldIndexer

public class LabelsCustomFieldIndexer
extends AbstractCustomFieldIndexer

A reference class that implements a custom field indexer

Since:

v4.3

Field Summary

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

customField

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

LABELS_NO_VALUE_INDEX_VALUE, NO_VALUE_INDEX_VALUE

Constructor Summary

Constructors

Constructor and Description
LabelsCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager, CustomField field)

Method Summary

Modifier and Type	Method and Description
void	addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData)
void	addDocumentFieldsSearchable(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData)
Boolean	skipsIndexingNull() Used to declare how the indexer handles nulls.

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

addDocumentFieldsNotSearchable, addDocumentFieldsNotSearchable, addDocumentFieldsSearchable, addDocumentFieldsSearchable, addIndex, addIndex, addIndex, getDocumentFieldId, getId, isFieldVisibleAndInScope, isRelevantForIssue

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelsCustomFieldIndexer

public LabelsCustomFieldIndexer(FieldVisibilityManager fieldVisibilityManager,
                                CustomField field)

Method Detail

addDocumentFieldsSearchable

public void addDocumentFieldsSearchable(org.apache.lucene.document.Document doc,
                                        Issue issue,
                                        CustomFieldPrefetchedData prefetchedData)

Overrides:

addDocumentFieldsSearchable in class AbstractCustomFieldIndexer

addDocumentFieldsNotSearchable

public void addDocumentFieldsNotSearchable(org.apache.lucene.document.Document doc,
                                           Issue issue,
                                           CustomFieldPrefetchedData prefetchedData)

Overrides:

addDocumentFieldsNotSearchable in class AbstractCustomFieldIndexer

skipsIndexingNull

public Boolean skipsIndexingNull()

Description copied from interface: FieldIndexer

Used to declare how the indexer handles nulls.

Returns:

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