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: 8.2.23

Syntax

public class DocumentSearchIndexer : SearchIndexer

The DocumentSearchIndexer type exposes the following members.

Constructors

	Name	Description
Public method	DocumentSearchIndexer

Methods

	Name	Description
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(DataRow, DataRow, ISearchDocument).)
Public method	GetDataClassInfo	Returns the data class info for the given search document (Overrides SearchIndexer.GetDataClassInfo(ISearchDocument).)
Public method	GetRelevantIndexes	Gets the list of indexes relevant to the given object (Overrides SearchIndexer.GetRelevantIndexes(ISearchable).)
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 current search result item. (Overrides SearchIndexer.GetSearchImageUrl(String, String, String).)
Protected method	GetSearchIndexes	Returns dataset of index IDs for specific type (Overrides SearchIndexer.GetSearchIndexes(String).)
Public method	CheckResultPermissions	Checks the permissions for the given result document (Overrides SearchIndexer.CheckResultPermissions(SearchResults, ISearchDocument, Int32).)
Public method	LoadResults	Loads the results to the given result collection (Overrides SearchIndexer.LoadResults(IEnumerable<ISearchDocument>, SafeDictionary<String, DataRow>).)
Protected method	LogBatchEnd	Logs the end of the batch processing. (Inherited from SearchIndexer.)
Protected method	LogBatchStart(Int32, Int32)	Logs the start of batch processing. (Inherited from SearchIndexer.)
Protected method	LogBatchStart(Int32, Int32, String)	Logs start of batch processeing. (Inherited from SearchIndexer.)
Protected method	LogBatchStart(Int32, Int32, String, String, Boolean)	Logs the start of batch processing.
Protected method	LogMessage	Appends line to the log context. (Inherited from SearchIndexer.)
Protected method	LogTaskStart	Logs task started message to the log context. (Inherited from SearchIndexer.)
Public method	PartialRebuild	Rebuilds part of the index (Overrides SearchIndexer.PartialRebuild(SearchTaskInfo).)
Public method Static member	PrepareBuildingValues	Prepares sites, cultures, allowed and excluded collections for partial or full rebuild.
Public method	Rebuild	Rebuilds the document index (Overrides SearchIndexer.Rebuild(SearchIndexInfo).)
Protected method	SelectSearchDocument	Selects the search document based on the given ID (Overrides SearchIndexer.SelectSearchDocument(Int32).)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

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