com.atlassian.jira.issue.index

Interface IssueIndexer

All Known Implementing Classes:

DefaultIssueIndexer, MemoryIssueIndexer, MockIssueIndexer

public interface IssueIndexer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IssueIndexer.Analyzers

Method Summary

Modifier and Type	Method and Description
Index.Result	deindexIssues(EnclosedIterable<Issue> issues, Context context) Delete any existing documents for the supplied issues.
void	deleteIndexes() Delete all indexes.
void	deleteIndexes(IssueIndexingParams issueIndexingParams) Delete selected indexes.
List<String>	getIndexPaths()
String	getIndexRootPath()
Index.Result	indexIssues(EnclosedIterable<Issue> issues, Context context) Deprecated. since 6.4 use indexIssues(com.atlassian.jira.util.collect.EnclosedIterable, com.atlassian.jira.task.context.Context, IssueIndexingParams) instead
Index.Result	indexIssues(EnclosedIterable<Issue> issues, Context context, IssueIndexingParams issueIndexingParams) Add documents for the supplied issues.
Index.Result	indexIssuesBatchMode(EnclosedIterable<Issue> issues, Context context) Deprecated. since 6.4 use indexIssuesBatchMode(com.atlassian.jira.util.collect.EnclosedIterable, com.atlassian.jira.task.context.Context, IssueIndexingParams) instead
Index.Result	indexIssuesBatchMode(EnclosedIterable<Issue> issues, Context context, IssueIndexingParams issueIndexingParams) Index the given issues, use whatever is in your arsenal to do it as FAST as possible.
org.apache.lucene.search.IndexSearcher	openEntitySearcher(IndexDirectoryFactory.Name index) 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) Deprecated. since 6.4 use reindexIssues(com.atlassian.jira.util.collect.EnclosedIterable, com.atlassian.jira.task.context.Context, IssueIndexingParams, boolean) instead
Index.Result	reindexIssues(EnclosedIterable<Issue> issues, Context context, IssueIndexingParams issueIndexingParams, boolean conditionalUpdate) Re-index the given issues, delete any existing documents and add new ones.
Index.Result	reindexWorklogs(Collection<Worklog> worklogs, Context context)
void	shutdown()

Method Detail

indexIssues

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

Deprecated. since 6.4 use indexIssues(com.atlassian.jira.util.collect.EnclosedIterable, com.atlassian.jira.task.context.Context, IssueIndexingParams) instead

Add documents for the supplied issues.

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

indexIssues

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

Add documents for the supplied issues.

Parameters:

issues - An iterable of issues to index.

context - for showing the user the current status.

issueIndexingParams - parameters describing what should be reindexed

Since:

6.4

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

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

Deprecated. since 6.4 use reindexIssues(com.atlassian.jira.util.collect.EnclosedIterable, com.atlassian.jira.task.context.Context, IssueIndexingParams, boolean) instead

Re-index the given issues, delete any existing documents and add new ones. This method defaults the value of reIndexWorklogs to false

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

reindexIssues

Index.Result reindexIssues(@Nonnull
                           EnclosedIterable<Issue> issues,
                           @Nonnull
                           Context context,
                           @Nonnull
                           IssueIndexingParams issueIndexingParams,
                           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.

issueIndexingParams - parameters describing what should be reindexed

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

Since:

6.4

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.

reindexWorklogs

Index.Result reindexWorklogs(@Nonnull
                             Collection<Worklog> worklogs,
                             @Nonnull
                             Context context)

indexIssuesBatchMode

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

Deprecated. since 6.4 use indexIssuesBatchMode(com.atlassian.jira.util.collect.EnclosedIterable, com.atlassian.jira.task.context.Context, IssueIndexingParams) instead

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.

indexIssuesBatchMode

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

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.

issueIndexingParams - parameters describing what should be reindexed

Since:

6.4

optimize

Index.Result optimize()

deleteIndexes

void deleteIndexes()

Delete all indexes.

deleteIndexes

void deleteIndexes(@Nonnull
                   IssueIndexingParams issueIndexingParams)

Delete selected indexes.

Parameters:

issueIndexingParams - parameters describing which indexes should be deleted.

shutdown

void shutdown()

openEntitySearcher

org.apache.lucene.search.IndexSearcher openEntitySearcher(IndexDirectoryFactory.Name index)

Issue searcher has to be closed after doing stuff.

getIndexPaths

List<String> getIndexPaths()

getIndexRootPath

String getIndexRootPath()