Class IndexHelper

Namespace

Dynamicweb.Indexing

Assembly

Dynamicweb.Indexing.dll

Class provides auxiliary methods

public static class IndexHelper

Inheritance

object

IndexHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

BuildIndexInstances(string, string, string)

public static void BuildIndexInstances(string repository, string indexName, string buildName)

Parameters

repository string

indexName string

buildName string

ConvertToIndex(JObject)

Converts json object to index

public static IIndex ConvertToIndex(JObject obj)

Parameters

obj JObject

Json data

Returns

IIndex

IIndex based object instance

ConvertToIndex(XElement)

Converts json object to index

public static IIndex ConvertToIndex(XElement obj)

Parameters

obj XElement

Xml data

Returns

IIndex

IIndex based object instance

ConvertToJson(IIndex)

Converts index to json format

public static JObject ConvertToJson(IIndex index)

Parameters

index IIndex

Index object instance

Returns

JObject

Json data of object instance

ConvertToXml(IIndex)

Converts index instance data to xml element

public static XElement ConvertToXml(IIndex index)

Parameters

index IIndex

Index instance

Returns

XElement

XElement instance

GetIndexesStatusInformation()

Gets all indexes status

public static IEnumerable<IndexStatusInformation> GetIndexesStatusInformation()

Returns

IEnumerable<IndexStatusInformation>

GetIndexesStatusInformation(string)

Gets repository indexes status

public static IEnumerable<IndexStatusInformation> GetIndexesStatusInformation(string repositoryName)

Parameters

repositoryName string

Returns

IEnumerable<IndexStatusInformation>

GetIndexStatusInformation(string, string)

Gets index status

public static IndexStatusInformation GetIndexStatusInformation(string repositoryName, string indexName)

Parameters

repositoryName string

Repository name

indexName string

Index name

Returns

IndexStatusInformation

GetIndexWithSchemaExtender(string)

public static IEnumerable<IIndex> GetIndexWithSchemaExtender(string schemaExtenderName)

Parameters

schemaExtenderName string

Returns

IEnumerable<IIndex>

GetInstanceLatestStatus(string, string, string)

Gets instance last build status

public static Status GetInstanceLatestStatus(string repository, string index, string instance)

Parameters

repository string

Repository name

index string

Index name

instance string

Instance name

Returns

Status

Last build status. Null if build was not ever made

GetTaskName(string, string, string)

public static string GetTaskName(string folderName, string fileName, string instance)

Parameters

folderName string

fileName string

instance string

Returns

string

IsInstanceAvailable(IIndexProvider)

Shows if instance available

public static bool IsInstanceAvailable(IIndexProvider instance)

Parameters

instance IIndexProvider

IndexProvider Instance

Returns

bool

True if instance is available

IsInstanceAvailable(string, string, string)

Shows if instance available

public static bool IsInstanceAvailable(string repository, string index, string instance)

Parameters

repository string

Repository name

index string

Index name

instance string

Instance name

Returns

bool

True if instance is available

LoadIndex(IIndexService, string, RepositoryFileFormat)

Loads index

public static IIndex LoadIndex(this IIndexService indexService, string filename, RepositoryFileFormat fileFormat)

Parameters

indexService IIndexService

Index service instance

filename string

Index file name

fileFormat RepositoryFileFormat

Index file format

Returns

IIndex

Index object instance

Merge(JObject, IIndex)

Merges json data to index

public static void Merge(JObject json, IIndex index)

Parameters

json JObject

Json data

index IIndex

Index instance

Merge(XElement, IIndex)

Merges XElement data to index

public static void Merge(XElement element, IIndex index)

Parameters

element XElement

XElement instance

index IIndex

Index instance

SaveIndex(IIndexService, string, IIndex, RepositoryFileFormat)

Saves index

public static void SaveIndex(this IIndexService indexService, string fileName, IIndex index, RepositoryFileFormat fileFormat)

Parameters

indexService IIndexService

Index service instance

fileName string

Index file name

index IIndex

Index instance

fileFormat RepositoryFileFormat

Index file format

SendIndexBuildFinishedNotification(Tracker, IIndexBuilderNotification)

Sends index build finished notification

public static void SendIndexBuildFinishedNotification(Tracker tracker, IIndexBuilderNotification notificationSettings)

Parameters

tracker Tracker

The tracker

notificationSettings IIndexBuilderNotification

The notification settings