|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.index.DefaultIndexManager
public class DefaultIndexManager
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.atlassian.jira.util.index.IndexLifecycleManager |
---|
IndexLifecycleManager.Composite |
Field Summary | |
---|---|
static org.apache.lucene.analysis.Analyzer |
ANALYZER_FOR_INDEXING
|
static org.apache.lucene.analysis.Analyzer |
ANALYZER_FOR_SEARCHING
|
static String |
COMMENTS_SUBDIR
|
static String |
ISSUES_SUBDIR
|
static String |
PLUGINS_SUBDIR
|
Constructor Summary | |
---|---|
DefaultIndexManager()
|
|
DefaultIndexManager(ApplicationProperties applicationProperties,
IssueIndexer issueIndexer)
|
Method Summary | |
---|---|
long |
activate(String indexPath,
Context context)
Activates search indexes. |
void |
deactivate()
De-activates indexing (as happens from the admin page) and removes index directories. |
void |
deactivate(String filePath)
Deactivate a specific search index and remove its directory. |
void |
deIndex(org.ofbiz.core.entity.GenericValue entity)
Remove an issue from the search index. |
Collection |
getAllIndexPaths()
|
org.apache.lucene.search.IndexSearcher |
getCommentSearcher()
Get an IndexSearcher that can be used to search the comment index. |
Collection |
getExistingPluginsPaths()
Returns a collection of Strings, each one representing the absolute path to the actual existing directory where a plugin keeps its indexes. |
protected String |
getFilePath()
Return the path beneath which the different index directories are stored, protected so the MemoryIndexManager can override for testing purposes. |
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. |
boolean |
isIndexingEnabled()
|
long |
optimize()
Optimize the underlying indexes. |
void |
reIndex(org.ofbiz.core.entity.GenericValue issueGV)
Reindex an issue (eg. |
void |
reIndex(Issue issue)
Reindex an issue (eg. |
long |
reIndexAll()
Reindex all issues. |
long |
reIndexAll(Context context)
Reindex everything. |
long |
reIndexIssueObjects(Collection issueObjects)
Reindex a set of issues. |
long |
reIndexIssues(Collection issues)
Reindex a set of issues (GenericValues). |
long |
reIndexIssues(IssuesIterable issuesIterable,
Context context)
Reindex a list of issues, passing an optional event that will be set progress |
void |
shutdown()
Shuts down the indexing manager and closes its resources (if any). |
int |
size()
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final org.apache.lucene.analysis.Analyzer ANALYZER_FOR_SEARCHING
public static final org.apache.lucene.analysis.Analyzer ANALYZER_FOR_INDEXING
public static final String COMMENTS_SUBDIR
public static final String ISSUES_SUBDIR
public static final String PLUGINS_SUBDIR
Constructor Detail |
---|
public DefaultIndexManager()
public DefaultIndexManager(ApplicationProperties applicationProperties, IssueIndexer issueIndexer)
Method Detail |
---|
public void deactivate(String filePath) throws Exception
IssueIndexManager
deactivate
in interface IssueIndexManager
Exception
public void deactivate() throws Exception
IndexLifecycleManager
deactivate
in interface IndexLifecycleManager
Exception
public long activate(String indexPath, Context context) throws Exception
IndexLifecycleManager
activate
in interface IndexLifecycleManager
indexPath
- Root path to the search index.context
- used to report progress back to the user or to the logs. Must not be null.
Exception
public boolean isIndexingEnabled()
isIndexingEnabled
in interface IndexLifecycleManager
public long reIndexAll() throws IndexException
IssueIndexManager
reIndexAll
in interface IssueIndexManager
IndexException
public long reIndexAll(Context context) throws IndexException
IndexLifecycleManager
reIndexAll
in interface IndexLifecycleManager
context
- used to report progress back to the user or to the logs. Must not be null.
IndexException
public long reIndexIssues(Collection issues) throws IndexException
IssueIndexManager
IssueIndexManager.reIndexIssueObjects(Collection)
instead when possible.
reIndexIssues
in interface IssueIndexManager
issues
- The Issue GenericValue
s to reindex.
IndexException
public long reIndexIssueObjects(Collection issueObjects) throws IndexException
IssueIndexManager
reIndexIssueObjects
in interface IssueIndexManager
issueObjects
- Set of Issue
s to reindex.
IndexException
public void reIndex(Issue issue) throws IndexException
IssueIndexManager
reIndex
in interface IssueIndexManager
IndexException
public void reIndex(org.ofbiz.core.entity.GenericValue issueGV) throws IndexException
IssueIndexManager
reIndex
in interface IssueIndexManager
IndexException
public long reIndexIssues(IssuesIterable issuesIterable, Context context) throws IndexException
IssueIndexManager
reIndexIssues
in interface IssueIndexManager
IndexException
public int size()
size
in interface Sized
size
in interface IndexLifecycleManager
IndexLifecycleManager.reIndexAll(Context)
public long optimize() throws IndexException
IndexLifecycleManager
optimize
in interface IndexLifecycleManager
IndexException
- if the indexes are seriously in troublepublic void deIndex(org.ofbiz.core.entity.GenericValue entity) throws IndexException
IssueIndexManager
deIndex
in interface IssueIndexManager
IndexException
public String getPluginsRootPath()
IssueIndexManager
getPluginsRootPath
in interface IssueIndexManager
public Collection getExistingPluginsPaths()
IssueIndexManager
IssueIndexManager.getPluginsRootPath()
.
If a plugin index root path does not exist, or is empty (no sub-directopries exist) then an empty collection will be returned.
getExistingPluginsPaths
in interface IssueIndexManager
public Collection getAllIndexPaths()
getAllIndexPaths
in interface IndexLifecycleManager
public org.apache.lucene.search.IndexSearcher getIssueSearcher()
IssueIndexManager
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.
getIssueSearcher
in interface IssueIndexManager
public org.apache.lucene.search.IndexSearcher getCommentSearcher()
IssueIndexManager
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.
getCommentSearcher
in interface IssueIndexManager
public void shutdown()
IndexLifecycleManager
shutdown
in interface IndexLifecycleManager
protected String getFilePath()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |