com.atlassian.jira.issue.index.indexers

Interface FieldIndexer

All Known Subinterfaces:

CustomFieldIndexer

All Known Implementing Classes:

AbstractCustomFieldIndexer, AffectedVersionsIndexer, AssigneeIndexer, AttachmentIndexer, BaseFieldIndexer, CascadingSelectCustomFieldIndexer, ComponentsIndexer, CreatedDateIndexer, CreatorIndexer, CurrentEstimateIndexer, CustomFieldIndexerWithStats, CustomFieldLabelsIndexer, DateCustomFieldIndexer, DescriptionIndexer, DueDateIndexer, EnvironmentIndexer, ExactTextCustomFieldIndexer, FieldIndexerWithStats, FixForVersionsIndexer, GroupCustomFieldIndexer, IssueIdIndexer, IssueKeyIndexer, IssueLinkIndexer, IssueTypeIndexer, LabelsCustomFieldIndexer, LabelsIndexer, LocalDateIndexer, NumberCustomFieldIndexer, OriginalEstimateIndexer, ParentIssueIndexer, PriorityIndexer, ProgressIndexer, ProjectCustomFieldIndexer, ProjectIdIndexer, ReporterIndexer, ResolutionDateIndexer, ResolutionIndexer, SecurityIndexer, SelectCustomFieldIndexer, SlowFieldIndexer, SortableTextCustomFieldIndexer, StatusIndexer, SubTaskIndexer, SummaryIndexer, TimeSpentIndexer, UpdatedDateIndexer, UserCustomFieldIndexer, UserFieldIndexer, VersionCustomFieldIndexer, VoterIndexer, VotesIndexer, WatcherIndexer, WatchesIndexer, WorkRatioIndexer

@PublicSpi
public interface FieldIndexer

This is meant to create a portion of a Document that is relevant for a JIRA field.

The portion that is added to the Document will be the indexed value that is represented by the value contained in the Issue object when the addIndex(Document, Issue, CustomFieldPrefetchedData) method is called.

There is a strong relationship between a FieldIndexer and a ClauseQueryFactory as the indexer creates a portion of the lucene Document and the query factory assumes it knows what this looks like and can generate a Lucene query that will find relevant issues based on the values that were indexed.

If you are writing a CustomFieldSearcher then the glue that binds the FieldIndexer and the ClauseQueryFactory together is the CustomFieldSearcher since it provides both the ClauseHandler and the FieldIndexer. Keep in mind that if you are creating one of these that the Indexer must add fields to the document that the ClauseQueryFactory knows how to search.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LABELS_NO_VALUE_INDEX_VALUE Empty token specific to LabelsIndexer
static String	NO_VALUE_INDEX_VALUE General empty token

Method Summary

Modifier and Type	Method and Description
default void	addIndex(org.apache.lucene.document.Document doc, Issue issue) Deprecated. since 8.10 use addIndex(Document, Issue, CustomFieldPrefetchedData) instead
default void	addIndex(org.apache.lucene.document.Document doc, Issue issue, CustomFieldPrefetchedData prefetchedData) Deprecated. since 8.12 use addIndex(Document, Issue, CustomFieldPrefetchedData) instead
default 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()
boolean	isFieldVisibleAndInScope(Issue issue) This method is used to determine if the indexer is relevant for the provided issue.
default Boolean	skipsIndexingNull() Used to declare how the indexer handles nulls.

Field Detail

NO_VALUE_INDEX_VALUE

static final String NO_VALUE_INDEX_VALUE

General empty token

See Also:

Constant Field Values

LABELS_NO_VALUE_INDEX_VALUE

static final String LABELS_NO_VALUE_INDEX_VALUE

Empty token specific to LabelsIndexer

See Also:

Constant Field Values

Method Detail

getId

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.

getDocumentFieldId

String getDocumentFieldId()

Returns:

the String representation of the primary field id that will be added to the Document as a result of a successful call to the addIndex(Document, Issue, CustomFieldPrefetchedData) method.

addIndex

@Deprecated
default void addIndex(org.apache.lucene.document.Document doc,
                                  Issue issue)

Deprecated. since 8.10 use addIndex(Document, Issue, CustomFieldPrefetchedData) instead

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.

If calling isFieldVisibleAndInScope(com.atlassian.jira.issue.Issue) returns false then this method should create fields that have an Indexed type of org.apache.lucene.document.Field.Index#NO. 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.

Parameters:

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.

addIndex

@Deprecated
default void addIndex(org.apache.lucene.document.Document doc,
                                  Issue issue,
                                  CustomFieldPrefetchedData prefetchedData)

Deprecated. since 8.12 use addIndex(Document, Issue, CustomFieldPrefetchedData) instead

addIndex

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

If calling 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.

Parameters:

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

isFieldVisibleAndInScope

boolean isFieldVisibleAndInScope(Issue issue)

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.

If this method returns false then the FieldIndexer, when performing addIndex, should make sure to make the indexed values have an Indexed type of org.apache.lucene.document.Field.Index#NO.

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

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

@ExperimentalApi
default Boolean skipsIndexingNull()

Used to declare how the indexer handles nulls.

Returns:

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

Since:

8.10