com.adobe.flexbuilder.codemodel.indices
Interface ISearchIndex

All Superinterfaces:

IIndex, IIndexableFileListener, IProjectListener

public interface ISearchIndex

extends IIndex, IIndexableFileListener

the index that handles searches across the code model for multiple languages and file types

Author:

david

Field Summary

static java.lang.String

ID

Method Summary

int	getIndexedFileCount(ISearchProgressListener listener) Returns the number of documents contained with this index
IOccurrence[]	getOccurrences(IDefinitionProvider provider, SearchScope scope, SearchFilter filter) Finds all occurrences of the given definition provided by the IDefinitionProvider based on the passed in parameters
void	getOccurrences(IDefinitionProvider provider, SearchScope scope, SearchFilter filter, ISearchCollector collector) Finds all occurrences of the given definition provided by the IDefinitionProvider based on the passed in parameters

Methods inherited from interface com.adobe.flexbuilder.codemodel.indices.IIndex

getIndexID

Methods inherited from interface com.adobe.flexbuilder.codemodel.project.IIndexableFileListener

fileAdded, fileChanged, fileDeleted

Methods inherited from interface com.adobe.flexbuilder.codemodel.project.IProjectListener

afterBlockOperation, afterProjectLoad, beforeBlockOperation, beforeClose, beforeProjectLoad, beforeReset

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Method Detail

getOccurrences

public IOccurrence[] getOccurrences(IDefinitionProvider provider,
                                    SearchScope scope,
                                    SearchFilter filter)

Finds all occurrences of the given definition provided by the IDefinitionProvider based on the passed in parameters

Parameters:

provider - The IDefinitionProvider responsible for providing the IDefinition to compare against

scope - the SearchScope that details where we search for matches

filter - the SearchFilter that tells us what to find

Returns:

an array of IOccurrence objects

getOccurrences

public void getOccurrences(IDefinitionProvider provider,
                           SearchScope scope,
                           SearchFilter filter,
                           ISearchCollector collector)

Finds all occurrences of the given definition provided by the IDefinitionProvider based on the passed in parameters

Parameters:

provider - The IDefinitionProvider responsible for providing the IDefinition to compare against

scope - the SearchScope that details where we search for matches

filter - the SearchFilter that tells us what to find

collector - the ISearchCollector that manages the results returned back

getIndexedFileCount

public int getIndexedFileCount(ISearchProgressListener listener)

Returns the number of documents contained with this index

Parameters:

listener -

Returns:

the number of files contained in this index