DocumentSearchIndexer Class

Indexer for documents

Inheritance Hierarchy

System.Object
  CMS.Search.SearchIndexer
    CMS.DocumentEngine.DocumentSearchIndexer

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

Syntax

public class DocumentSearchIndexer : SearchIndexer

The DocumentSearchIndexer type exposes the following members.

Constructors

	Name	Description
Public method	DocumentSearchIndexer()	Document search indexer.
Protected method	DocumentSearchIndexer(DocumentSearchablesRetriever)	Document search indexer.

Fields

	Name	Description
Public field Static member	FIELD_DOCUMENTCATEGORYIDS	Document category IDs field name

Properties

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

Methods

	Name	Description
Public method	CheckResultPermissions	Checks the permissions for the given result document (Overrides SearchIndexer.CheckResultPermissions(SearchResults, ILuceneSearchDocument, Int32).)
Protected method	DeleteItem	Deletes specific item from the index (Overrides SearchIndexer.DeleteItem(SearchTaskInfo, SearchIndexInfo).)
Protected method	DocumentUpdate	Update specified document (Inherited from SearchIndexer.)
Protected method	ExecuteDeleteTask	Executes the search index delete task (Inherited from SearchIndexer.)
Protected method	ExecuteOptimizeTask	Executes the search optimize task. (Inherited from SearchIndexer.)
Protected method	ExecuteProcessTask	Processes the search index task (Inherited from SearchIndexer.)
Protected method	ExecuteRebuildTask	Executes the search index rebuild task (Inherited from SearchIndexer.)
Public method	ExecuteTask	Executes the search index task (Inherited from SearchIndexer.)
Protected method	ExecuteUpdateTask	Executes the search index update task (Overrides SearchIndexer.ExecuteUpdateTask(SearchTaskInfo).)
Public method	FillSearchResult	Fills the data to the search result data row (Overrides SearchIndexer.FillSearchResult(SearchResultItem, DataRow, ILuceneSearchDocument).)
Public method	GetDataClassInfo	Returns the data class info for the given search document (Overrides SearchIndexer.GetDataClassInfo(ILuceneSearchDocument).)
Public method	GetSearchFields	Gets the collection of search fields. When no SearchFields colection is provided, new is created. (Overrides SearchIndexer.GetSearchFields(SearchIndexInfo, ISearchFields).)
Public method	GetSearchImageUrl	Returns URL to given search result item. (Overrides SearchIndexer.GetSearchImageUrl(SearchResultItem).)
Public method	IsClassNameRelevantToIndex	Checks if given className is related to search index settings from indexSettings. (Overrides SearchIndexer.IsClassNameRelevantToIndex(String, SearchIndexSettings).)
Protected method	IsTaskProcessingAllowed	Indicates if task processing is allowed for given task. (Overrides SearchIndexer.IsTaskProcessingAllowed(SearchTaskInfo).)
Public method	LoadResults	Loads the results to the given result collection (Overrides SearchIndexer.LoadResults(IEnumerable<ILuceneSearchDocument>, SafeDictionary<String, DataRow>).)
Public method	PartialRebuild	Rebuilds part of the index (Overrides SearchIndexer.PartialRebuild(SearchTaskInfo).)
Public method	Rebuild	Rebuilds the document index (Overrides SearchIndexer.Rebuild(SearchIndexInfo).)
Public method	SelectSearchDocument	Selects the search document based on the given ID (Overrides SearchIndexer.SelectSearchDocument(Int32).)