Interface IIndex

Namespace

Dynamicweb.Indexing

Assembly

Dynamicweb.Indexing.dll

Defines properties and methods for Indexing data domain specific objects

[JsonConverter(typeof(IndexJsonConverter))]
public interface IIndex

Properties

Balancer

Gets or sets load balancer index

IIndexBalancer Balancer { get; set; }

Property Value

IIndexBalancer

Builds

Gets or sets dictionary of IndexBuilder object instances

IDictionary<string, IIndexBuilder> Builds { get; set; }

Property Value

IDictionary<string, IIndexBuilder>

Description

Gets or sets index description text

string Description { get; set; }

Property Value

string

FileName

Gets or sets index file name

string FileName { get; set; }

Property Value

string

Instances

Gets or sets dictionary of IndexProvider object instances

IDictionary<string, IIndexProvider> Instances { get; set; }

Property Value

IDictionary<string, IIndexProvider>

Meta

Gets or sets index meta information

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

Property Value

IDictionary<string, string>

Name

Gets or sets index instance name

string Name { get; set; }

Property Value

string

Schema

Gets or sets schema definition

SchemaDefinition Schema { get; set; }

Property Value

SchemaDefinition

Settings

Gets or sets index settings

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

Property Value

IDictionary<string, string>

SubType

Gets or sets index sub type

string SubType { get; set; }

Property Value

string

Type

Gets or sets index type

string Type { get; set; }

Property Value

string

Methods

Build(string, string, Tracker)

Defines build operation

void Build(string instance, string name, Tracker tracker = null)

Parameters

instance string

Index instance to be builed

name string

Index name

tracker Tracker

Diagnostic tracker objet instance

GetInstance()

Defines operation for getting IndexProvider instance

IIndexProvider GetInstance()

Returns

IIndexProvider

SetInstance(string)

Defines operation for setting Index instance name

void SetInstance(string name)

Parameters

name string