com.atlassian.jira.issue.index
Interface IssueIndexer

All Known Implementing Classes:
DefaultIssueIndexer, MemoryIssueIndexer, MockIssueIndexer

public interface IssueIndexer


Nested Class Summary
static class IssueIndexer.Analyzers
           
 
Method Summary
 Index.Result deindexIssues(EnclosedIterable<Issue> issues, Context context)
          Delete any existing documents for the supplied issues.
 void deleteIndexes()
           
 List<String> getIndexPaths()
           
 String getIndexRootPath()
           
 Index.Result indexIssues(EnclosedIterable<Issue> issues, Context context)
          Add documents for the supplied issues.
 Index.Result indexIssuesBatchMode(EnclosedIterable<Issue> issues, Context context)
          Index the given issues, use whatever is in your arsenal to do it as FAST as possible.
 org.apache.lucene.search.IndexSearcher openChangeHistorySearcher()
          Issue searcher has to be closed after doing stuff.
 org.apache.lucene.search.IndexSearcher openCommentSearcher()
           
 org.apache.lucene.search.IndexSearcher openIssueSearcher()
          Issue searcher has to be closed after doing stuff.
 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()
           
 

Method Detail

indexIssues

Index.Result indexIssues(@Nonnull
                         EnclosedIterable<Issue> issues,
                         @Nonnull
                         Context context)
Add documents for the supplied issues.

Parameters:
issues - An iterable of issues to index.
context - for showing the user the current status.

deindexIssues

Index.Result deindexIssues(@Nonnull
                           EnclosedIterable<Issue> issues,
                           @Nonnull
                           Context context)
Delete any existing documents for the supplied issues.

Parameters:
issues - An iterable of issues to index.
context - for showing the user the current status.

reindexIssues

Index.Result reindexIssues(@Nonnull
                           EnclosedIterable<Issue> issues,
                           @Nonnull
                           Context context,
                           boolean reIndexComments,
                           boolean reIndexChangeHistory,
                           boolean conditionalUpdate)
Re-index the given issues, delete any existing documents and add new ones.

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

Index.Result reindexComments(@Nonnull
                             Collection<Comment> comments,
                             @Nonnull
                             Context context)
Reindex a collection of issue comments.

Parameters:
comments - Comments to be reindexed.
context - for showing the user the current status.

indexIssuesBatchMode

Index.Result indexIssuesBatchMode(@Nonnull
                                  EnclosedIterable<Issue> issues,
                                  @Nonnull
                                  Context context)
Index the given issues, use whatever is in your arsenal to do it as FAST as possible.

Parameters:
issues - An iterable of issues to index.
context - for showing the user the current status.

optimize

Index.Result optimize()

deleteIndexes

void deleteIndexes()

shutdown

void shutdown()

openIssueSearcher

org.apache.lucene.search.IndexSearcher openIssueSearcher()
Issue searcher has to be closed after doing stuff.


openCommentSearcher

org.apache.lucene.search.IndexSearcher openCommentSearcher()

openChangeHistorySearcher

org.apache.lucene.search.IndexSearcher openChangeHistorySearcher()
Issue searcher has to be closed after doing stuff.


getIndexPaths

List<String> getIndexPaths()

getIndexRootPath

String getIndexRootPath()


Copyright © 2002-2014 Atlassian. All Rights Reserved.