Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.34 KB

examine-manager.md

File metadata and controls

56 lines (34 loc) · 2.34 KB

Examine Manager

The Examine.ExamineManager is a singleton object which exposes all of the index and search providers which are registered in the configuration of the application

Accessing the singleton can be done easily like:

ExamineManager.Instance

This returns an active instance of the ExamineManager which exposes operations such as:

  • Default index & search providers
  • Full collection of index & search providers
  • All indexing and searching methods

Searching

Important to note that the Search methods on the ExamineManager will call the Search methods of the default search provider specified in config. If you want to search using a specified provider, you can retreive it from the SearchProviderCollection (see example below).

You can access any of the searchers by their name, for example:

var externalSearcher = ExamineManager.Instance.SearchProviderCollection["ExternalSearcher"];

For simple searching the method to use is:

ISearchResults Search(string searchText, bool useWildcards);

To create custom search criteria for advanced searching for use with the Fluent API there are 4 methods available:

ISearchCriteria CreateSearchCriteria();
ISearchCriteria CreateSearchCriteria(BooleanOperation defaultOperation);
ISearchCriteria CreateSearchCriteria(string type);
ISearchCriteria CreateSearchCriteria(string type, BooleanOperation defaultOperation);

Once you've customized the criteria with the Fluent API you can pass that criteria in to this method to get results:

ISearchResults Search(ISearchCriteria searchParameters);

Fluent API documentation coming soon!

Indexing

When calling the index methods on the ExamineManager it will call the same methods on every Indexer that is registered. If for some reason you require to only call the index methods on a particular provider then you can access the provider by name, for example:

var externalIndexer = ExamineManager.Instance.IndexProviderCollection["ExternalIndexer"];

The indexing methds available are:

void DeleteFromIndex(string nodeId);
void DeleteFromIndex(string nodeId, IEnumerable<BaseIndexProvider> providers);
void IndexAll(string type);
bool IndexExists();
void RebuildIndex();
void ReIndexNode(XElement node, string type);
void ReIndexNode(XElement node, string type, IEnumerable<BaseIndexProvider> providers);

Indexing documentation coming soon!