oracle.ide.index

Interface Indexer

All Known Implementing Classes:

DependencyIndexer, JavaIndexer, KeywordIndexer

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.

See Also:

IndexManager.addIndexer(java.lang.Class<? extends oracle.ide.index.Indexer>)

Method Summary

Modifier and Type	Method and Description
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

startIndexing

void startIndexing(IndexingContext context)

Indexing is about to start on the given context.

Parameters:

context - the indexing context

endIndexing

void endIndexing(IndexingContext context)

Indexing has finished on the given context.

Parameters:

context - the indexing context

index

void index(IndexingContext context,
           DataCollector data)

Index the current file in the context. The text buffer returned by 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.

Parameters:

context - the context

data - the data collector where the Indexer should store its data