Package com.intellij.util.indexing

Interface CompositeDataIndexer<K,V,SubIndexerType,SubIndexerVersion>

All Superinterfaces:

DataIndexer<K,V,FileContent>

All Known Implementing Classes:

SingleEntryCompositeIndexer

public interface CompositeDataIndexer<K,V,SubIndexerType,SubIndexerVersion>
extends DataIndexer<K,V,FileContent>

Represents DataIndexer which behaviour can be extended by some kind of extension points.

See Also:

IdIndex, StubUpdatingIndex as an examples

Method Summary

Modifier and Type	Method and Description
SubIndexerType	calculateSubIndexer(IndexedFile file) Calculates sub-indexer type which will be used by indexing algorithm.
SubIndexerVersion	getSubIndexerVersion(SubIndexerType subIndexerType) SubIndexerVersion reflects StubIndexerType persistent version.
KeyDescriptor<SubIndexerVersion>	getSubIndexerVersionDescriptor() SubIndexerVersion descriptor must depend only on corresponding index version, should be available to read even corresponding SubIndexerType is not exist anymore.
default java.util.Map<K,V>	map(FileContent inputData)
java.util.Map<K,V>	map(FileContent inputData, SubIndexerType indexerType)
default boolean	requiresContentForSubIndexerEvaluation(IndexedFile file) Determine should we load content to provide sub-indexer.

Method Detail

calculateSubIndexer

SubIndexerType calculateSubIndexer(IndexedFile file)

Calculates sub-indexer type which will be used by indexing algorithm. Usually SubIndexerType it's some extension which build index for a given file.

Returns:

null if file is not acceptable for indexing

See Also:

map(FileContent, Object)

requiresContentForSubIndexerEvaluation

default boolean requiresContentForSubIndexerEvaluation(IndexedFile file)

Determine should we load content to provide sub-indexer.

getSubIndexerVersion

SubIndexerVersion getSubIndexerVersion(SubIndexerType subIndexerType)

SubIndexerVersion reflects StubIndexerType persistent version. It should depend only on it and must not use any additional information about IDE setup.

getSubIndexerVersionDescriptor

KeyDescriptor<SubIndexerVersion> getSubIndexerVersionDescriptor()

SubIndexerVersion descriptor must depend only on corresponding index version, should be available to read even corresponding SubIndexerType is not exist anymore.

map

default java.util.Map<K,V> map(FileContent inputData)

Specified by:

map in interface DataIndexer<K,V,FileContent>

map

java.util.Map<K,V> map(FileContent inputData,
                       SubIndexerType indexerType)

Returns:

indexed data for an input provided by indexerType argument