|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Indexer
Implemented by classes that need to participate in indexing. Each Indexer
is instantiated once per IndexingContext
. Before the indexing
operation begins, startIndexing(oracle.ide.index.IndexingContext)
is called. Then, for each file
that is indexed, index(oracle.ide.index.IndexingContext, oracle.ide.index.DataCollector)
is called. Finally, after the indexing
is complete, endIndexing(oracle.ide.index.IndexingContext)
is called.
Note that because there is a separate Indexer instance for each IndexingContext, and because each indexing operation runs on a single thread, Indexer implementations do not need to be thread safe.
IndexManager.addIndexer(java.lang.Class extends oracle.ide.index.Indexer>)
Method Summary | |
---|---|
void |
endIndexing(IndexingContext context)
Indexing has finished on the given context. |
void |
index(IndexingContext context,
DataCollector data)
Index the current file in the context. |
void |
startIndexing(IndexingContext context)
Indexing is about to start on the given context. |
Method Detail |
---|
void startIndexing(IndexingContext context)
context
- the indexing contextvoid endIndexing(IndexingContext context)
context
- the indexing contextvoid index(IndexingContext context, DataCollector data)
IndexingContext.getTextBuffer()
is read locked at the time this
method is called. Note that any Throwable thrown by
implementations of this method is considered a bug and will be reported
to the user.
context
- the contextdata
- the data collector where the Indexer should store its
data
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |