com.atlassian.jira.index
Interface EntitySearchExtractor<T>

All Known Subinterfaces:
ChangeHistorySearchExtractor, CommentSearchExtractor, IssueSearchExtractor
All Known Implementing Classes:
IssuePropertySearchExtractor, IssueSearchExtractorImpl

@ExperimentalApi
public interface EntitySearchExtractor<T>

Provides ability to add fields to Document during indexing

Since:
6.2

Nested Class Summary
static interface EntitySearchExtractor.Context<T>
           
 
Method Summary
 Set<String> indexEntity(EntitySearchExtractor.Context<T> ctx, org.apache.lucene.document.Document doc)
          Extracts fields from document provided by EntitySearchExtractor.Context and adds them to document.
 

Method Detail

indexEntity

Set<String> indexEntity(EntitySearchExtractor.Context<T> ctx,
                        org.apache.lucene.document.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


Copyright © 2002-2014 Atlassian. All Rights Reserved.