oracle.ide.dependency.index

Class DependencyIndexer

java.lang.Object

oracle.ide.dependency.index.DependencyIndexer

All Implemented Interfaces:

Indexer

public abstract class DependencyIndexer
extends java.lang.Object
implements Indexer

Base class for Indexer implementations that provide dependency information.

Constructor Summary

Constructors

Constructor and Description
DependencyIndexer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDeclaration(IndexDeclaration declaration) Add a declaration to the index.
protected void	addReference(IndexReference reference) Add a reference to the index.
void	endIndexing(IndexingContext context) Indexing has finished on the given context.
void	index(IndexingContext context, DataCollector data) Index the current file in the context.
protected abstract void	indexDependencies(IndexingContext context) Implemented by subclasses to index the dependencies.
void	startIndexing(IndexingContext context) Indexing is about to start on the given context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DependencyIndexer

public DependencyIndexer()

Method Detail

startIndexing

public void startIndexing(IndexingContext context)

Description copied from interface: Indexer

Indexing is about to start on the given context.

Specified by:

startIndexing in interface Indexer

Parameters:

context - the indexing context

endIndexing

public void endIndexing(IndexingContext context)

Description copied from interface: Indexer

Indexing has finished on the given context.

Specified by:

endIndexing in interface Indexer

Parameters:

context - the indexing context

index

public void index(IndexingContext context,
         DataCollector data)

Description copied from interface: Indexer

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.

Specified by:

index in interface Indexer

Parameters:

context - the context

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

indexDependencies

protected abstract void indexDependencies(IndexingContext context)

Implemented by subclasses to index the dependencies. The implementation should use the addDeclaration(oracle.ide.dependency.index.IndexDeclaration) and addReference(oracle.ide.dependency.index.IndexReference) methods to add their declarations and references to the index.

Parameters:

context - the indexing context

addDeclaration

protected void addDeclaration(IndexDeclaration declaration)

Add a declaration to the index.

Parameters:

declaration - the declaration

addReference

protected void addReference(IndexReference reference)

Add a reference to the index.

Parameters:

reference - the reference