@ExperimentalApi public interface

EntitySearchExtractor

com.atlassian.jira.index.EntitySearchExtractor<T>
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Provides ability to add fields to Document during indexing

Summary

Nested Classes
interface EntitySearchExtractor.Context<T>  
Public Methods
Set<String> indexEntity(Context<T> ctx, Document doc)
Extracts fields from document provided by EntitySearchExtractor.Context and adds them to document.

Public Methods

public Set<String> indexEntity (Context<T> ctx, Document doc)

Extracts fields from document provided by EntitySearchExtractor.Context and adds them to document. All the filed names that were added to documents as indexed to document must be returned as output of this method

Parameters
ctx context for this operation
doc lucene document to which values should be added
Returns
  • ids of the document fields that were added by call of this method