Package com.intellij.find.ngrams

Class TrigramIndex

java.lang.Object

com.intellij.util.indexing.IndexExtension<K,V,FileContent>

com.intellij.util.indexing.FileBasedIndexExtension<K,java.lang.Void>

com.intellij.util.indexing.ScalarIndexExtension<java.lang.Integer>

com.intellij.find.ngrams.TrigramIndex

All Implemented Interfaces:

CustomInputsIndexFileBasedIndexExtension<java.lang.Integer>, DocumentChangeDependentIndex

public class TrigramIndex
extends ScalarIndexExtension<java.lang.Integer>
implements CustomInputsIndexFileBasedIndexExtension<java.lang.Integer>, DocumentChangeDependentIndex

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ENABLED Deprecated. not used anymore, always enabled
static ID<java.lang.Integer,java.lang.Void>	INDEX_ID

Fields inherited from class com.intellij.util.indexing.ScalarIndexExtension

VOID_DATA_EXTERNALIZER

Fields inherited from class com.intellij.util.indexing.FileBasedIndexExtension

EXTENSION_POINT_NAME

Constructor Summary

Constructors

Constructor and Description
TrigramIndex()

Method Summary

Modifier and Type	Method and Description
DataExternalizer<java.util.Collection<java.lang.Integer>>	createExternalizer()
boolean	dependsOnFileContent()
DataIndexer<java.lang.Integer,java.lang.Void,FileContent>	getIndexer()
FileBasedIndex.InputFilter	getInputFilter()
KeyDescriptor<java.lang.Integer>	getKeyDescriptor()
ID<java.lang.Integer,java.lang.Void>	getName()
int	getVersion()
boolean	hasSnapshotMapping()
static boolean	isIndexable(FileType fileType)
boolean	needsForwardIndexWhenSharing() Whether this index needs the forward mapping to be shared along with inverted index.

Methods inherited from class com.intellij.util.indexing.ScalarIndexExtension

getValueExternalizer

Methods inherited from class com.intellij.util.indexing.FileBasedIndexExtension

getCacheSize, getFileTypesWithSizeLimitNotApplicable, indexDirectories, keyIsUniqueForIndexedFile, traceKeyHashToVirtualFileMapping

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED

@Deprecated
public static final boolean ENABLED

Deprecated. not used anymore, always enabled

See Also:

Constant Field Values

INDEX_ID

public static final ID<java.lang.Integer,java.lang.Void> INDEX_ID

Constructor Detail

TrigramIndex

public TrigramIndex()

Method Detail

isIndexable

public static boolean isIndexable(FileType fileType)

getName

public ID<java.lang.Integer,java.lang.Void> getName()

Specified by:

getName in class FileBasedIndexExtension<java.lang.Integer,java.lang.Void>

getIndexer

public DataIndexer<java.lang.Integer,java.lang.Void,FileContent> getIndexer()

Specified by:

getIndexer in class IndexExtension<java.lang.Integer,java.lang.Void,FileContent>

getKeyDescriptor

public KeyDescriptor<java.lang.Integer> getKeyDescriptor()

Specified by:

getKeyDescriptor in class IndexExtension<java.lang.Integer,java.lang.Void,FileContent>

getInputFilter

public FileBasedIndex.InputFilter getInputFilter()

Specified by:

getInputFilter in class FileBasedIndexExtension<java.lang.Integer,java.lang.Void>

Returns:

filter for file are supposed being indexed by the IndexExtension.getIndexer(). Usually DefaultFileTypeSpecificInputFilter can be used here to index only files with given file-type. Note that check only file's extension is usually error-prone way and prefer to check VirtualFile.getFileType(): for example user can enforce language file as plain text one.

dependsOnFileContent

public boolean dependsOnFileContent()

Specified by:

dependsOnFileContent in class FileBasedIndexExtension<java.lang.Integer,java.lang.Void>

getVersion

public int getVersion()

Specified by:

getVersion in class IndexExtension<java.lang.Integer,java.lang.Void,FileContent>

hasSnapshotMapping

public boolean hasSnapshotMapping()

Overrides:

hasSnapshotMapping in class FileBasedIndexExtension<java.lang.Integer,java.lang.Void>

needsForwardIndexWhenSharing

public boolean needsForwardIndexWhenSharing()

Description copied from class: FileBasedIndexExtension

Whether this index needs the forward mapping to be shared along with inverted index. If this method returns false, it is an error to call FileBasedIndex.getFileData(ID, VirtualFile, Project) for this index.

Overrides:

needsForwardIndexWhenSharing in class FileBasedIndexExtension<java.lang.Integer,java.lang.Void>

createExternalizer

public DataExternalizer<java.util.Collection<java.lang.Integer>> createExternalizer()

Specified by:

createExternalizer in interface CustomInputsIndexFileBasedIndexExtension<java.lang.Integer>