SearchIndexer Class

Base class for search indexer

Inheritance Hierarchy

System.Object
  CMS.Search.SearchIndexer
    CMS.CustomTables.CustomTableSearchIndexer
    CMS.DocumentEngine.DocumentCategorySearchIndexer
    CMS.DocumentEngine.DocumentSearchIndexer
    CMS.Membership.UserSearchIndexer
    CMS.Search.CustomSearchIndexer

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 13.0.131

Syntax

public class SearchIndexer

The SearchIndexer type exposes the following members.

Constructors

	Name	Description
Public method	SearchIndexer()	Search indexer.
Protected method	SearchIndexer(SearchablesRetriever)	General search indexer.

Properties

	Name	Description
Protected property	Logger	Logs actions related to indexes and search tasks.
Protected property	SearchablesRetriever	Helps with retrievingISearchable objects and SearchIndexInfo s related to search tasks.

Methods

	Name	Description
Public method	CheckResultPermissions	Checks the permissions for the given result document
Protected method	DeleteItem	Deletes specific item from the index
Protected method	DocumentUpdate	Update specified document
Protected method	ExecuteDeleteTask	Executes the search index delete task
Protected method	ExecuteOptimizeTask	Executes the search optimize task.
Protected method	ExecuteProcessTask	Processes the search index task
Protected method	ExecuteRebuildTask	Executes the search index rebuild task
Public method	ExecuteTask	Executes the search index task
Protected method	ExecuteUpdateTask	Executes the search index update task
Public method	FillSearchResult	Fills the data to the search result data row. Returns true, if the data was correctly filled
Public method	GetDataClassInfo	Returns the data class info for the given search document
Public method	GetSearchFields	Gets the collection of search fields. When no SearchFields collection is provided, new is created.
Public method	GetSearchImageUrl	Returns URL to given search result item.
Public method	IsClassNameRelevantToIndex	Checks if given className is related to search index settings from indexSettings.
Protected method	IsTaskProcessingAllowed	Indicates if task processing is allowed for given task.
Public method	LoadResults	Loads the results to the given result collection
Public method	PartialRebuild	Rebuilds part of the index
Public method	Rebuild	Rebuilds the index
Public method	SelectSearchDocument	Selects the search document based on the given ID