Keyoti SearchUnit API Docs
IndexableSource Class
API DocumentationKeyoti.SearchEngine.Index.IndexableSourcesIndexableSource
Keyoti SearchUnit v6
Base abstract class for indexable source types.
Declaration Syntax
C#Visual Basic
public abstract class IndexableSource : IIndexableSource
Public MustInherit Class IndexableSource
	Implements IIndexableSource
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
IndexableSource()()()()
AddedDocument
Fired when a document has been added to the index.

AddingDocument
Fired when a document is about to be added

Cancel()()()()
Cancel the import

Cancelled
Whether the import was cancelled.

Close()()()()
Closes the data access

Configuration
The configuration.

DataAccess
The data-access layer.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetDocuments(DocumentIndex, IndexableSourceRecord, Configuration)
Gets a collection of Document objects belonging to an indexable source

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetImportSample(DataSet, Int32, LinkBasedImportSampler..::..InvokeMethod)
Gets a sample of the import data that Import will retrieve.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Import()()()()
Adds new files imported from the source

ImportSampleDataTableColumnsFinalized
Fired when the DataTable used for the import sample has it's columns finalized.

IndexableSourceRecord
The record representing this source, in the data-access

ItemsImported
The number of items that have been imported since the last call to Import.

ItemsToImportTotal
If available. The total number of items (documents, records, files, etc) that will be imported.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnAddedDocument(AddDocumentEventArgs)
Fires the AddedDocument event.

OnAddingDocument(AddDocumentEventArgs)
Fires the AddingDocument event.

OnImportSampleDataTableColumnsFinalized(EventArgs)
Raises ImportSampleDataTableColumnsFinalized

OnReaderExceptionOccurred(ReaderExceptionOccurredEventArgs)
Called whenever a readerException is caught

Open()()()()
Opens the data access

ReaderExceptionOccurred
Fired whenever the (web) reader encounters a network exception, eg. 404 (this can be useful for identifying dead links)

SetIndexableSourceRecord(IndexableSourceRecord)
Sets record representing this source, in the data-access

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy

Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2022.8.22.610