Class IndexingProviderBase

A base class for search indexers.

Inheritance
System.Object
IndexingProviderBase
ModuleIndexer
TabIndexer
UserIndexer
Namespace: DotNetNuke.Services.Search
Assembly: DotNetNuke.dll
Syntax
public abstract class IndexingProviderBase : object

Methods

| Improve this Doc View Source

GetLastCheckpointData(Int32, Int32)

Retrieves free format data to help the indexer to perform its job.

Declaration
protected string GetLastCheckpointData(int portalId, int scheduleId)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
System.Int32 scheduleId

The schedule ID.
Returns
Type Description
System.String

The checkpoint data.
| Improve this Doc View Source

GetLocalTimeOfLastIndexedItem(Int32, Int32, DateTime)

Retrieves the date/time of the last item to be indexed.

Declaration
protected DateTime GetLocalTimeOfLastIndexedItem(int portalId, int scheduleId, DateTime localTime)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
System.Int32 scheduleId

The schedule ID.
DateTime localTime

The local time passed to IndexSearchDocuments(Int32, ScheduleHistoryItem, DateTime, Action<IEnumerable<SearchDocument>>).
Returns
Type Description
DateTime

Either localTime or the stored index time, whichever is earlier.
| Improve this Doc View Source

GetSearchDocuments(Int32, DateTime)

A base class for search indexers.

Declaration
public virtual IEnumerable<SearchDocument> GetSearchDocuments(int portalId, DateTime startDateLocal)
Parameters
Type Name Description
System.Int32 portalId
DateTime startDateLocal
Returns
Type Description
IEnumerable<SearchDocument>
| Improve this Doc View Source

GetSearchIndexItems(Int32)

A base class for search indexers.

Declaration
public virtual SearchItemInfoCollection GetSearchIndexItems(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Returns
Type Description
SearchItemInfoCollection
| Improve this Doc View Source

IndexSearchDocuments(Int32, ScheduleHistoryItem, DateTime, Action<IEnumerable<SearchDocument>>)

This method must save search documents in batches to minimize memory usage instead of returning all documents at once.

Declaration
public abstract int IndexSearchDocuments(int portalId, ScheduleHistoryItem schedule, DateTime startDateLocal, Action<IEnumerable<SearchDocument>> indexer)
Parameters
Type Name Description
System.Int32 portalId

ID of the portal for which to index items.
ScheduleHistoryItem schedule
DateTime startDateLocal

Minimum modification date of items that need to be indexed.
Action<IEnumerable<SearchDocument>> indexer

A delegate function to send the collection of documents to for saving/indexing.
Returns
Type Description
System.Int32

The number of documents indexed.
| Improve this Doc View Source

SetLastCheckpointData(Int32, Int32, String)

Stores free format data to help the indexer to perform its job.

Declaration
protected void SetLastCheckpointData(int portalId, int scheduleId, string data)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
System.Int32 scheduleId

The schedule ID.
System.String data

The data to store.
| Improve this Doc View Source

SetLocalTimeOfLastIndexedItem(Int32, Int32, DateTime)

Stores the date/time of the last item to be indexed.

Declaration
protected void SetLocalTimeOfLastIndexedItem(int portalId, int scheduleId, DateTime localTime)
Parameters
Type Name Description
System.Int32 portalId

The portal ID.
System.Int32 scheduleId

The schedule ID.
DateTime localTime

The local time to store.

Extension Methods