com.atlassian.jira.issue.index
Class DefaultIssueIndexer

java.lang.Object
  com.atlassian.jira.issue.index.DefaultIssueIndexer

All Implemented Interfaces:

IssueIndexer

Direct Known Subclasses:

MemoryIssueIndexer

public class DefaultIssueIndexer
extends Object
implements IssueIndexer

Nested Class Summary

static interface	DefaultIssueIndexer.ChangeHistoryRetriever
static interface	DefaultIssueIndexer.CommentRetriever

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.index.IssueIndexer

IssueIndexer.Analyzers

Constructor Summary

DefaultIssueIndexer(IndexDirectoryFactory indexDirectoryFactory, DefaultIssueIndexer.CommentRetriever commentRetriever, DefaultIssueIndexer.ChangeHistoryRetriever changeHistoryRetriever, ApplicationProperties applicationProperties, IssueDocumentFactory issueDocumentFactory, CommentDocumentFactory commentDocumentFactory, ChangeHistoryDocumentFactory changeHistoryDocumentFactory)

Method Summary

Index.Result	deindexIssues(EnclosedIterable<Issue> issues, Context context) Delete any existing documents for the supplied issues.
void	deleteIndexes()
org.apache.lucene.search.IndexSearcher	getChangeHistorySearcher()
org.apache.lucene.search.IndexSearcher	getCommentSearcher()
List<String>	getIndexPaths()
String	getIndexRootPath()
org.apache.lucene.search.IndexSearcher	getIssueSearcher()
Index.Result	indexIssues(EnclosedIterable<Issue> issues, Context context) Add documents for the supplied issues.
Index.Result	indexIssuesBatchMode(EnclosedIterable<Issue> issues, Context context) No other index operations should be called while this method is being called
Index.Result	optimize()
Index.Result	reindexComments(Collection<Comment> comments, Context context) Reindex a collection of issue comments.
Index.Result	reindexIssues(EnclosedIterable<Issue> issues, Context context, boolean reIndexComments, boolean reIndexChangeHistory, boolean conditionalUpdate) Re-index the given issues, delete any existing documents and add new ones.
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIssueIndexer

public DefaultIssueIndexer(@Nonnull
                           IndexDirectoryFactory indexDirectoryFactory,
                           @Nonnull
                           DefaultIssueIndexer.CommentRetriever commentRetriever,
                           @Nonnull
                           DefaultIssueIndexer.ChangeHistoryRetriever changeHistoryRetriever,
                           @Nonnull
                           ApplicationProperties applicationProperties,
                           @Nonnull
                           IssueDocumentFactory issueDocumentFactory,
                           @Nonnull
                           CommentDocumentFactory commentDocumentFactory,
                           @Nonnull
                           ChangeHistoryDocumentFactory changeHistoryDocumentFactory)

Method Detail

deindexIssues

public Index.Result deindexIssues(@Nonnull
                                  EnclosedIterable<Issue> issues,
                                  @Nonnull
                                  Context context)

Description copied from interface: IssueIndexer

Delete any existing documents for the supplied issues.

Specified by:

deindexIssues in interface IssueIndexer

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

indexIssues

public Index.Result indexIssues(@Nonnull
                                EnclosedIterable<Issue> issues,
                                @Nonnull
                                Context context)

Description copied from interface: IssueIndexer

Add documents for the supplied issues.

Specified by:

indexIssues in interface IssueIndexer

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

indexIssuesBatchMode

public Index.Result indexIssuesBatchMode(@Nonnull
                                         EnclosedIterable<Issue> issues,
                                         @Nonnull
                                         Context context)

No other index operations should be called while this method is being called

Specified by:

indexIssuesBatchMode in interface IssueIndexer

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

reindexIssues

public Index.Result reindexIssues(@Nonnull
                                  EnclosedIterable<Issue> issues,
                                  @Nonnull
                                  Context context,
                                  boolean reIndexComments,
                                  boolean reIndexChangeHistory,
                                  boolean conditionalUpdate)

Description copied from interface: IssueIndexer

Re-index the given issues, delete any existing documents and add new ones.

Specified by:

reindexIssues in interface IssueIndexer

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

reIndexComments - Set to true if you require issue comments to also be reindexed.

reIndexChangeHistory - Set to true if you require issue change history to also be reindexed.

conditionalUpdate - set to true to use conditional updates when writing to the index

reindexComments

public Index.Result reindexComments(@Nonnull
                                    Collection<Comment> comments,
                                    @Nonnull
                                    Context context)

Description copied from interface: IssueIndexer

Reindex a collection of issue comments.

Specified by:

reindexComments in interface IssueIndexer

Parameters:

comments - Comments to be reindexed.

context - for showing the user the current status.

deleteIndexes

public void deleteIndexes()

Specified by:

deleteIndexes in interface IssueIndexer

getCommentSearcher

public org.apache.lucene.search.IndexSearcher getCommentSearcher()

Specified by:

getCommentSearcher in interface IssueIndexer

getIssueSearcher

public org.apache.lucene.search.IndexSearcher getIssueSearcher()

Specified by:

getIssueSearcher in interface IssueIndexer

getChangeHistorySearcher

public org.apache.lucene.search.IndexSearcher getChangeHistorySearcher()

Specified by:

getChangeHistorySearcher in interface IssueIndexer

optimize

public Index.Result optimize()

Specified by:

optimize in interface IssueIndexer

shutdown

public void shutdown()

Specified by:

shutdown in interface IssueIndexer

getIndexPaths

public List<String> getIndexPaths()

Specified by:

getIndexPaths in interface IssueIndexer

getIndexRootPath

public String getIndexRootPath()

Specified by:

getIndexRootPath in interface IssueIndexer