Class IndexBuilderBase

Namespace

Dynamicweb.Indexing

Assembly

Dynamicweb.Core.dll

Defines index builder base operations

public abstract class IndexBuilderBase : ConfigurableAddIn, IIndexBuilder

Inheritance

object

ConfigurableAddIn

IndexBuilderBase

Implements

IIndexBuilder

Derived

ContentIndexBuilder

FileIndexBuilder

ProductIndexBuilder

SqlIndexBuilder

UserIndexBuilder

Inherited Members

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

Index builder action

public string Action { get; set; }

Property Value

string

DefaultSettings

Default settings

public virtual IDictionary<string, object> DefaultSettings { get; }

Property Value

IDictionary<string, object>

Extenders

List of Index builder extenders

public IEnumerable<IIndexBuilderExtender<IIndexBuilder>> Extenders { get; set; }

Property Value

IEnumerable<IIndexBuilderExtender<IIndexBuilder>>

Meta

Meta information

public IDictionary<string, string> Meta { get; set; }

Property Value

IDictionary<string, string>

Name

Index builder name

public string Name { get; set; }

Property Value

string

Notification

Gets or sets notification

public IIndexBuilderNotification Notification { get; set; }

Property Value

IIndexBuilderNotification

Schema

Schema

public SchemaDefinition? Schema { get; set; }

Property Value

SchemaDefinition

Settings

Settings

public IDictionary<string, string> Settings { get; set; }

Property Value

IDictionary<string, string>

SupportedActions

List of supported actions

public abstract IEnumerable<string> SupportedActions { get; }

Property Value

IEnumerable<string>

Type

Index builder type

public string Type { get; set; }

Property Value

string

Methods

Build(IIndexWriter, Tracker)

Builds the index to the specified writer

public abstract void Build(IIndexWriter writer, Tracker tracker)

Parameters

writer IIndexWriter

The indexing writer

tracker Tracker

The tracker instance to log what happens

GetBoolean(string)

protected bool GetBoolean(string key)

Parameters

key string

Returns

bool

GetFields()

Defines GetFields required operation

public abstract IEnumerable<FieldDefinitionBase> GetFields()

Returns

IEnumerable<FieldDefinitionBase>

GetInt32(string)

protected int GetInt32(string key)

Parameters

key string

Returns

int

GetString(string)

protected string GetString(string key)

Parameters

key string

Returns

string

SetValue<T>(string, T)

protected void SetValue<T>(string key, T value)

Parameters

key string

value T

Type Parameters

T