Interface ITextSearchIndex
-
public interface ITextSearchIndex
Text search index interface
-
-
Field Summary
Fields Modifier and Type Field Description static String
INDEX_PATH_PREFIX
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clean()
Clean indexvoid
indexFile(Collection<org.eclipse.core.resources.IFile> files)
Add or update given files in indexvoid
removeFile(Collection<org.eclipse.core.resources.IFile> files)
Remove given files from indexvoid
search(ITextSearchQuery query, ITextSearchResultCollector resultCollector, org.eclipse.core.runtime.IProgressMonitor monitor)
Search specified query in indexvoid
shutdown()
Shutdown indexvoid
start()
Start index
-
-
-
Field Detail
-
INDEX_PATH_PREFIX
static final String INDEX_PATH_PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
start
void start() throws IOException
Start index- Throws:
IOException
- if the directory cannot be read/written to, or if there is any other low-level IO error
-
shutdown
void shutdown()
Shutdown index
-
clean
void clean()
Clean index
-
indexFile
void indexFile(Collection<org.eclipse.core.resources.IFile> files) throws IOException
Add or update given files in index- Parameters:
files
- collection of files- Throws:
IOException
- if the directory cannot be read/written to, or if there is any other low-level IO error
-
removeFile
void removeFile(Collection<org.eclipse.core.resources.IFile> files) throws IOException
Remove given files from index- Parameters:
files
- collection of files for- Throws:
IOException
- if the directory cannot be read/written to, or if there is any other low-level IO error
-
search
void search(ITextSearchQuery query, ITextSearchResultCollector resultCollector, org.eclipse.core.runtime.IProgressMonitor monitor) throws IOException
Search specified query in index- Parameters:
query
- for searching in index, cannot benull
resultCollector
- the callback that will be invoked each time a match is found, cannot benull
monitor
- the progress monitor, can benull
- Throws:
IOException
- if the directory cannot be read/written to, or if there is any other low-level IO error
-
-