Class IndexService

Namespace

Dynamicweb.Indexing

Assembly

Dynamicweb.Indexing.dll

Represents index service

public class IndexService : IIndexService

Inheritance

object

IndexService

Implements

IIndexService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IndexHelper.LoadIndex(IIndexService, string, RepositoryFileFormat)

IndexHelper.SaveIndex(IIndexService, string, IIndex, RepositoryFileFormat)

Properties

BaseFolder

Gets or sets index service base folder

public static string BaseFolder { get; set; }

Property Value

string

Methods

BuildIndex(string, string, string)

Builds index

public void BuildIndex(string name, string instance, string build)

Parameters

name string

Item name

instance string

Instance name

build string

Build name

BuildIndex(string, string, string, IDictionary<string, string>)

Builds the index.

public void BuildIndex(string name, string instance, string build, IDictionary<string, string> meta)

Parameters

name string

The name.

instance string

The instance.

build string

The build.

meta IDictionary<string, string>

The meta.

BuildIndex(string, string, string, IDictionary<string, string>, bool)

Start index building task

public void BuildIndex(string name, string instance, string build, IDictionary<string, string> meta, bool isResume)

Parameters

name string

Index file name

instance string

Index instance name

build string

Build name

meta IDictionary<string, string>

Meta data

isResume bool

True if IsResume

BuildIndex(string, string, string, string)

Builds index

public void BuildIndex(string repository, string item, string instance, string build)

Parameters

repository string

Repository name

item string

Item name

instance string

Instance name

build string

Build name

BuildIndex(string, string, string, string, IDictionary<string, string>)

Builds index

public void BuildIndex(string repository, string item, string instance, string build, IDictionary<string, string> meta)

Parameters

repository string

Repository name

item string

Item name

instance string

Instance name

build string

Build name

meta IDictionary<string, string>

Meta data

BuildIndex(string, string, string, string, IDictionary<string, string>, bool)

Builds index

public void BuildIndex(string repository, string item, string instance, string build, IDictionary<string, string> meta, bool isResume)

Parameters

repository string

Repository name

item string

Item name

instance string

Instance name

build string

Build name

meta IDictionary<string, string>

Meta data

isResume bool

True if isResume

ClearCache(string, string)

Clear a cached index scheme

public void ClearCache(string repository, string item)

Parameters

repository string

Name of repository

item string

Name of item

ClearIndexCaches(Type)

Finds index schemes related to specific IndexSchemaExtenderType and calls ClearCache on those indexes.

public static void ClearIndexCaches(Type IndexSchemaExtenderType)

Parameters

IndexSchemaExtenderType Type

DeleteIndex(string)

Deletes repository index

public void DeleteIndex(string repository)

Parameters

repository string

Repository name

GetActiveBuildTasks(IIndex)

Gets list of active build tasks

public IEnumerable<TaskInfo> GetActiveBuildTasks(IIndex index)

Parameters

index IIndex

Index

Returns

IEnumerable<TaskInfo>

Enumeration of TaskInfo

GetQueries<TIndexBuilder>()

Gets repository service queries

public IEnumerable<IQuery> GetQueries<TIndexBuilder>()

Returns

IEnumerable<IQuery>

Enumeration of IQuery

Type Parameters

TIndexBuilder

Type of IndexBuilder

GetQueries<TIndexBuilder>(string)

Gets repository queries

public IEnumerable<IQuery> GetQueries<TIndexBuilder>(string repository)

Parameters

repository string

Repository file name

Returns

IEnumerable<IQuery>

IQuery objects enumeration

Type Parameters

TIndexBuilder

Type of index builder

LoadIndex(string)

Loads index

public IIndex LoadIndex(string name)

Parameters

name string

Index file name

Returns

IIndex

Object implementing IIndex interface

LoadIndex(string, string)

Loads index

public IIndex LoadIndex(string repository, string item)

Parameters

repository string

Name of repository

item string

Name of item

Returns

IIndex

Object implementing IIndex interface

SaveIndex(string, IIndex)

Saves index data to xml format

public void SaveIndex(string name, IIndex index)

Parameters

name string

Target file name

index IIndex

Index instance to be saved

SaveIndex(string, string, IIndex)

Saves index

public void SaveIndex(string repository, string item, IIndex index)

Parameters

repository string

Repository name

item string

Item name

index IIndex

Index object instance