Interface IIndex

Namespace

Examine

Assembly

Examine.Core.dll

Interface to represent an Examine Indexer

public interface IIndex

Extension Methods

ExamineExtensions.DeleteFromIndex(IIndex, string)

ExamineExtensions.IndexItem(IIndex, ValueSet)

Properties

FieldDefinitions

Returns the field definitions for the index

ReadOnlyFieldDefinitionCollection FieldDefinitions { get; }

Property Value

ReadOnlyFieldDefinitionCollection

Name

The index name

string Name { get; }

Property Value

string

Searcher

Returns a searcher for the index

ISearcher Searcher { get; }

Property Value

ISearcher

Methods

CreateIndex()

Creates a new index, any existing index will be deleted

void CreateIndex()

DeleteFromIndex(IEnumerable<string>)

Deletes a node from the index

void DeleteFromIndex(IEnumerable<string> itemIds)

Parameters

itemIds IEnumerable<string>

Node to delete

IndexExists()

determines whether the index exsists or not

bool IndexExists()

Returns

bool

IndexItems(IEnumerable<ValueSet>)

Method to index data

void IndexItems(IEnumerable<ValueSet> values)

Parameters

values IEnumerable<ValueSet>

Events

IndexOperationComplete

Raised once an index operation is completed

event EventHandler<IndexOperationEventArgs> IndexOperationComplete

Event Type

EventHandler<IndexOperationEventArgs>

IndexingError

Occurs for an Indexing Error

event EventHandler<IndexingErrorEventArgs> IndexingError

Event Type

EventHandler<IndexingErrorEventArgs>

TransformingIndexValues

Raised before the item is indexed allowing developers to customize the data that get's stored in the index

event EventHandler<IndexingItemEventArgs> TransformingIndexValues

Event Type

EventHandler<IndexingItemEventArgs>