|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi public interface IssueIndexManager
Manages Lucene search indexes.
Field Summary | |
---|---|
static org.apache.lucene.util.Version |
LUCENE_VERSION
|
Method Summary | |
---|---|
void |
deIndex(org.ofbiz.core.entity.GenericValue issue)
Deprecated. Use deIndex(com.atlassian.jira.issue.Issue) instead. Since v5.0. |
void |
deIndex(Issue issue)
Remove an issue from the search index. |
org.apache.lucene.analysis.Analyzer |
getAnalyzerForIndexing()
Returns an Analyzer for indexing. |
org.apache.lucene.analysis.Analyzer |
getAnalyzerForSearching()
Returns an Analyzer for searching. |
org.apache.lucene.search.IndexSearcher |
getChangeHistorySearcher()
Get an IndexSearcher that can be used to search the change history index. |
org.apache.lucene.search.IndexSearcher |
getCommentSearcher()
Get an IndexSearcher that can be used to search the comment index. |
Collection<String> |
getExistingPluginsPaths()
Returns a collection of Strings, each one representing the absolute path to the actual existing directory where a plugin keeps its indexes. |
org.apache.lucene.search.IndexSearcher |
getIssueSearcher()
Get an IndexSearcher that can be used to search the issue index. |
String |
getPluginsRootPath()
Get the root path of the index directory for plugins. |
void |
hold()
Temporarily suspend indexing on this thread. |
boolean |
isHeld()
Return true if the index is held. |
void |
reIndex(org.ofbiz.core.entity.GenericValue issue)
Deprecated. Use reIndex(com.atlassian.jira.issue.Issue) instead. Since v5.0. |
void |
reIndex(Issue issue)
Reindex an issue (eg. |
void |
reIndex(Issue issue,
boolean reIndexComments,
boolean reIndexChangeHistory)
Reindex an issue (eg. |
long |
reIndexAll()
Reindex all issues. |
long |
reIndexComments(Collection<Comment> comments)
Reindexes a collection of comments. |
long |
reIndexComments(Collection<Comment> comments,
Context context)
Reindexes a collection of comments. |
long |
reIndexIssueObjects(Collection<? extends Issue> issueObjects)
Reindex a set of issues. |
long |
reIndexIssueObjects(Collection<? extends Issue> issueObjects,
boolean reIndexComments,
boolean reIndexChangeHistory)
Reindex a set of issues. |
long |
reIndexIssues(Collection<org.ofbiz.core.entity.GenericValue> issues)
Deprecated. Use reIndexIssueObjects(java.util.Collection) instead. Since v5.0. |
long |
reIndexIssues(IssuesIterable issuesIterable,
Context context)
Reindex a list of issues, passing an optional event that will be set progress |
long |
reIndexIssues(IssuesIterable issuesIterable,
Context context,
boolean reIndexComments,
boolean reIndexChangeHistory)
Reindex a list of issues, passing an optional event that will be set progress. |
long |
release()
Release indexing on this thread. |
Methods inherited from interface com.atlassian.jira.util.index.IndexLifecycleManager |
---|
activate, deactivate, getAllIndexPaths, isIndexConsistent, isIndexingEnabled, optimize, reIndexAll, reIndexAllIssuesInBackground, shutdown, size |
Methods inherited from interface com.atlassian.jira.util.collect.Sized |
---|
isEmpty |
Field Detail |
---|
static final org.apache.lucene.util.Version LUCENE_VERSION
Method Detail |
---|
long reIndexAll() throws IndexException
IndexException
void reIndex(org.ofbiz.core.entity.GenericValue issue) throws IndexException
reIndex(com.atlassian.jira.issue.Issue)
instead. Since v5.0.
IndexException
long reIndexIssues(IssuesIterable issuesIterable, Context context) throws IndexException
issuesIterable
- IssuesIterablecontext
- used to report progress back to the user or to the logs. Must not be null.
IndexException
long reIndexIssues(IssuesIterable issuesIterable, Context context, boolean reIndexComments, boolean reIndexChangeHistory) throws IndexException
issuesIterable
- IssuesIterablecontext
- used to report progress back to the user or to the logs. Must not be null.reIndexComments
- a boolean indicating whether to index issue commentsreIndexChangeHistory
- a boolean indicating whether to index issue change history
IndexException
void reIndex(Issue issue) throws IndexException
IndexException
void reIndex(Issue issue, boolean reIndexComments, boolean reIndexChangeHistory) throws IndexException
IndexException
long reIndexComments(Collection<Comment> comments) throws IndexException
comments
- a collection of Comment
IndexException
long reIndexComments(Collection<Comment> comments, Context context) throws IndexException
comments
- a collection of Commentcontext
- used to report progress back to the user or to the logs. Must not be null.
IndexException
void deIndex(org.ofbiz.core.entity.GenericValue issue) throws IndexException
deIndex(com.atlassian.jira.issue.Issue)
instead. Since v5.0.
IndexException
void deIndex(Issue issue) throws IndexException
IndexException
long reIndexIssues(Collection<org.ofbiz.core.entity.GenericValue> issues) throws IndexException
reIndexIssueObjects(java.util.Collection)
instead. Since v5.0.
reIndexIssueObjects(Collection)
instead when possible.
issues
- The Issue GenericValue
s to reindex.
IndexException
long reIndexIssueObjects(Collection<? extends Issue> issueObjects) throws IndexException
issueObjects
- Set of Issue
s to reindex.
IndexException
long reIndexIssueObjects(Collection<? extends Issue> issueObjects, boolean reIndexComments, boolean reIndexChangeHistory) throws IndexException
issueObjects
- Set of Issue
s to reindex.
IndexException
void hold()
boolean isHeld()
long release() throws IndexException
IndexException
- if an error occursString getPluginsRootPath()
Collection<String> getExistingPluginsPaths()
getPluginsRootPath()
.
If a plugin index root path does not exist, or is empty (no sub-directopries exist) then an empty collection will be returned.
org.apache.lucene.search.IndexSearcher getIssueSearcher()
IndexSearcher
that can be used to search the issue index.
Note: This is an unmanaged IndexSearcher. You MUST call IndexSearcher.close()
when you are done with it. Alternatively you should
really call SearchProviderFactory#getSearcher(String))
passing in SearchProviderFactory.ISSUE_INDEX
as it is a managed searcher
and all the closing semantics are handled for you.
org.apache.lucene.search.IndexSearcher getCommentSearcher()
IndexSearcher
that can be used to search the comment index.
Note: This is an unmanaged IndexSearcher. You MUST call IndexSearcher.close()
when you are done with it. Alternatively you should
really call SearchProviderFactory#getSearcher(String))
passing in SearchProviderFactory.COMMENT_INDEX
as it is a managed
searcher and all the closing semantics are handled for you.
org.apache.lucene.search.IndexSearcher getChangeHistorySearcher()
IndexSearcher
that can be used to search the change history index.
Note: This is an unmanaged IndexSearcher. You MUST call IndexSearcher.close()
when you are done with it. Alternatively you should
really call SearchProviderFactory#getSearcher(String))
passing in SearchProviderFactory.CHANGE_HISTORY_INDEX
as it is a managed
searcher and all the closing semantics are handled for you.
org.apache.lucene.analysis.Analyzer getAnalyzerForSearching()
Analyzer
for searching.
org.apache.lucene.analysis.Analyzer getAnalyzerForIndexing()
Analyzer
for indexing.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |