public class LabelsIndexer extends BaseFieldIndexer
Modifier and Type | Field and Description |
---|---|
static String |
NO_VALUE_INDEX_VALUE |
fieldVisibilityManager
LABELS_NO_VALUE_INDEX_VALUE
Constructor and Description |
---|
LabelsIndexer(FieldVisibilityManager fieldVisibilityManager) |
Modifier and Type | Method and Description |
---|---|
void |
addIndex(org.apache.lucene.document.Document doc,
Issue issue,
CustomFieldPrefetchedData prefetchedData)
This method allows an indexer the opportunity to modify the provided Lucene document (by reference) such
that it will contain fields that are relevant for searching and storage of the portion of the issue that
the FieldIndexer handles.
|
String |
getDocumentFieldId() |
String |
getId() |
compareTo, equals, hashCode, indexDateField, indexDependentEntities, indexFoldedKeyword, indexKeyword, indexKeywords, indexKeywordWithDefault, indexKeywordWithDefault, indexLocalDateField, indexLongAsKeyword, indexLongAsPaddedKeywordWithDefault, indexLongAsPaddedKeywordWithDefault, indexText, indexTextForSorting, isFieldVisibleAndInScope
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
addIndex, addIndex, skipsIndexingNull
public static final String NO_VALUE_INDEX_VALUE
public LabelsIndexer(FieldVisibilityManager fieldVisibilityManager)
public String getId()
public String getDocumentFieldId()
Document
as a result of a successful call to the
FieldIndexer.addIndex(Document, Issue, CustomFieldPrefetchedData)
method.public void addIndex(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData)
FieldIndexer
If calling FieldIndexer.isFieldVisibleAndInScope(com.atlassian.jira.issue.Issue)
returns false then
this method should create fields that have FieldType.stored()
} property set to true.
This allows us to store the value in the index but renders its value unsearchable.
If, for example, the indexer handles indexing an issues summary then this indexer will add a field to the document 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 StringFields or DocValues will result in them being removed to prevent the indexing operation from crashing. This is a limitation of how Lucene stores terms and DocValues.
doc
- the Lucene document that should be modified by adding relevant fields to.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>)
Copyright © 2002-2021 Atlassian. All Rights Reserved.