AI OnAI Off

Class BaseIndexBuilder

Base class for the indexer. Simplifies creating your own indexer.

Inheritance
System.Object
BaseIndexBuilder
BaseCatalogIndexBuilder
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Search.Extensions.Indexers
Assembly: Mediachase.Search.Extensions.dll
Version: 10.8.0
Syntax
public abstract class BaseIndexBuilder : ISearchIndexBuilder

Constructors

BaseIndexBuilder()

Declaration
protected BaseIndexBuilder()

Properties

Indexer

Gets or sets the build indexer.

Declaration
public IndexBuilder Indexer { get; set; }
Property Value
Type Description
IndexBuilder

The build indexer.

Manager

Gets or sets the manager.

Declaration
public SearchManager Manager { get; set; }
Property Value
Type Description
SearchManager

The manager.

Methods

AddMetaField(SearchDocument, MetaField, Hashtable)

Adds a metafield value to the search document.

Declaration
protected virtual void AddMetaField(SearchDocument doc, MetaField metaField, Hashtable metaObject)
Parameters
Type Name Description
SearchDocument doc

The doc.
MetaField metaField

The meta field.
System.Collections.Hashtable metaObject

The meta object.

BuildIndex(Boolean)

Builds the index.

Declaration
public abstract void BuildIndex(bool rebuild)
Parameters
Type Name Description
System.Boolean rebuild

if set to true the full rebuild will be done, if not. The last build date will be used.

OnEvent(String, Double)

Raises a SearchIndexMessage event.

Declaration
[Obsolete("Use OnProgressMessage, following standard C# event conventions. Will remain at least until November 2016.")]
protected virtual void OnEvent(string message, double percentage)
Parameters
Type Name Description
System.String message

The message for the event arguments.
System.Double percentage

The completion percentage for the event arguments (100% is represented by 100.00, not 1.00).

OnSearchIndexMessage(SearchIndexEventArgs)

Called to raise the SearchIndexMessage event.

Declaration
protected virtual void OnSearchIndexMessage(SearchIndexEventArgs e)
Parameters
Type Name Description
SearchIndexEventArgs e

The event arguments.

UpdateIndex(IEnumerable<Int32>)

Updates the specified items in the index.

Declaration
public abstract bool UpdateIndex(IEnumerable<int> itemIds)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Int32> itemIds

The ids of the items to update.
Returns
Type Description
System.Boolean

True if successful; otherwise, false.

Events

SearchIndexMessage

An event handler for progress message events.

Declaration
public event SearchIndexHandler SearchIndexMessage
Event Type
Type Description
SearchIndexHandler

Implements