Keyoti SearchUnit API Docs
FileSystemFolderBasedSource Class
API DocumentationKeyoti.SearchEngine.Index.IndexableSourcesFileSystemFolderBasedSource
Keyoti SearchUnit v6
Represents a file system directory as a source of documents.
Declaration Syntax
C#Visual Basic
public class FileSystemFolderBasedSource : IndexableSource
Public Class FileSystemFolderBasedSource
	Inherits IndexableSource
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
FileSystemFolderBasedSource(Configuration, FileSystemFolderBasedSourceRecord)
Instantiates a website based indexable source

AddedDocument
Fired when a document has been added to the index.
(Inherited from IndexableSource.)
AddingDocument
Fired when a document is about to be added
(Inherited from IndexableSource.)
Cancel()()()()
Cancel importing files
(Overrides IndexableSource.Cancel()()()().)
Cancelled
Whether the import was cancelled.
(Inherited from IndexableSource.)
Close()()()()
Closes the data access
(Inherited from IndexableSource.)
Configuration
The configuration.
(Inherited from IndexableSource.)
DataAccess
The data-access layer.
(Inherited from IndexableSource.)
DiscoverFiles(ArrayList)
Uses FileSysDocumentStore.DiscoverLinkURLs to find documents under the directory specified in IndexableSourceRecord.Location

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.)
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.
(Overrides IndexableSource.GetImportSample(DataSet, Int32, LinkBasedImportSampler..::..InvokeMethod).)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Import()()()()
Imports files from the specified source.
(Overrides IndexableSource.Import()()()().)
ImportSampleDataTableColumnsFinalized
Fired when the DataTable used for the import sample has it's columns finalized.
(Inherited from IndexableSource.)
IndexableSourceRecord
The record representing this source, in the data-access
(Inherited from IndexableSource.)
ItemsImported
Number of files that have been imported
(Overrides IndexableSource.ItemsImported.)
ItemsToImportTotal
If available, the total number of items (documents, records, files, etc) that will be imported, otherwise returns -1.
(Overrides IndexableSource.ItemsToImportTotal.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnAddedDocument(AddDocumentEventArgs)
Fires the AddedDocument event.
(Inherited from IndexableSource.)
OnAddingDocument(AddDocumentEventArgs)
Fires the AddingDocument event.
(Inherited from IndexableSource.)
OnImportSampleDataTableColumnsFinalized(EventArgs)
Raises ImportSampleDataTableColumnsFinalized
(Inherited from IndexableSource.)
OnReaderExceptionOccurred(ReaderExceptionOccurredEventArgs)
Called whenever a readerException is caught
(Inherited from IndexableSource.)
Open()()()()
Opens the data access
(Inherited from IndexableSource.)
ReaderExceptionOccurred
Fired whenever the (web) reader encounters a network exception, eg. 404 (this can be useful for identifying dead links)
(Inherited from IndexableSource.)
SetIndexableSourceRecord(IndexableSourceRecord)
Sets record representing this source, in the data-access
(Inherited from IndexableSource.)
ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy
Object
IndexableSource
 FileSystemFolderBasedSource

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