Groupdocs API References – GroupDocs.Search.Common

Net: AttributeChangeBatch

Mon, 01 Jan 0001 00:00:00 +0000

AttributeChangeBatch class

Represents a container for attribute changes.

public class AttributeChangeBatch

Constructors

Name	Description
AttributeChangeBatch()	Initializes a new instance of the `AttributeChangeBatch` class.

Methods

Name	Description
Add(string, params string[])	Adds the specified attributes to the specified indexed document.
Add(string[], params string[])	Adds the specified attributes to the specified indexed documents.
AddToAll(params string[])	Adds the specified attributes to all documents in the index.
Clear()	Removes all attributes from all documents in the index.
Remove(string, params string[])	Removes the specified attributes from the specified indexed document.
Remove(string[], params string[])	Removes the specified attributes from the specified indexed documents.
RemoveAll(string)	Removes all attributes from the specified indexed document.
RemoveAll(string[])	Removes all attributes from the specified indexed documents.
RemoveFromAll(params string[])	Removes the specified attributes from all documents in the index.

Remarks

Learn more

Net: Cancellation

Mon, 01 Jan 0001 00:00:00 +0000

Cancellation class

Represents an object for requesting cancellation of an operation.

public class Cancellation

Constructors

Name	Description
Cancellation()	Initializes a new instance of the `Cancellation` class.

Properties

Name	Description
IsCancelled { get; }	Gets a value indicating that cancellation has been requested.

Methods

Name	Description
Cancel()	Makes a request for cancellation.
CancelAfter(int)	Makes a request for cancellation after the expiration of specified number of milliseconds.

Remarks

Learn more

Net: ChunkSearchToken

Mon, 01 Jan 0001 00:00:00 +0000

ChunkSearchToken class

Represents a token for the continuation of the chunk search (search by pages).

public class ChunkSearchToken

Remarks

Learn more

Search by chunks

Net: CustomExtractorCollection

Mon, 01 Jan 0001 00:00:00 +0000

CustomExtractorCollection class

Contains a collection of custom extractors. If the collection contains an extractor for some file extension that is covered by build-in extractors, then this extractor will be used instead of built-in one.

public class CustomExtractorCollection : ICollection<IFieldExtractor>

Properties

Name	Description
Count { get; }	Gets the number of extractors contained in the collection.
IsReadOnly { get; }	Gets a value indicating whether the collection is read-only.

Methods

Name	Description
Add(IFieldExtractor)	Adds an extractor to the collection.
Clear()	Removes all extractors from the collection.
Contains(IFieldExtractor)	Determines whether the collection contains a specific extractor.
CopyTo(IFieldExtractor[], int)	Copies the elements of the collection to an array, starting at a particular array index.
GetEnumerator()	Returns an enumerator for this collection.
Remove(IFieldExtractor)	Removes an extractor from the collection.

Remarks

Learn more

Custom text extractors

Net: Document

Mon, 01 Jan 0001 00:00:00 +0000

Document class

Represents the base class for documents added to an index from file system, stream, or structure. Contains static methods for creating documents from different types of sources.

public abstract class Document

Properties

Name	Description
virtual AdditionalFields { get; set; }	Gets or sets the additional fields for the document.
virtual Attributes { get; set; }	Gets or sets the attributes of the document.
abstract DocumentKey { get; }	Gets the document key that is used to identify the document within an index.
abstract DocumentSourceKind { get; }	Gets the document source kind.
abstract Extension { get; }	Gets the extension used for this document type.
abstract IsLazy { get; }	Gets a value indicating whether the document is loaded as needed or not.
abstract ModificationDate { get; }	Gets the last modification date of the document.

Methods

Name	Description
static CreateFromFile(string)	Creates a document from a file.
static CreateFromStream(string, DateTime, string, Stream)	Creates a document from a stream.
static CreateFromStructure(string, DateTime, DocumentField[])	Creates a document from a structure that is an array of text fields.
static CreateLazy(DocumentSourceKind, string, IDocumentLoader)	Creates a lazy-loaded document.
override ToString()	Returns a String that represents the current `Document`.

Remarks

Learn more

Indexing from different sources

Net: DocumentField

Mon, 01 Jan 0001 00:00:00 +0000

DocumentField class

Represents a document field data.

public class DocumentField

Constructors

Name	Description
DocumentField(string, string)	Initializes a new instance of the `DocumentField` class.

Properties

Name	Description
Name { get; }	Gets a field name.
Value { get; }	Gets a field value.

Remarks

Learn more

Net: DocumentImage

Mon, 01 Jan 0001 00:00:00 +0000

DocumentImage class

Represents a document image data.

public class DocumentImage

Properties

Name	Description
Fields { get; }	Gets the extracted fields.
Frames { get; }	Gets the image frames.
ImageIndex { get; }	Gets the ordinal number of the image in the document.

Net: DocumentSourceKind

Mon, 01 Jan 0001 00:00:00 +0000

DocumentSourceKind enumeration

Defines the kinds of document sources.

public enum DocumentSourceKind

Values

Name	Value	Description
File	`0`	The file document source.
Stream	`1`	The stream document source.
Structure	`2`	The structure document source.
ExtractedData	`3`	The document source of previously extracted data.
TempFile	`4`	The temp file document source.

Net: DocumentStatus

Mon, 01 Jan 0001 00:00:00 +0000

DocumentStatus enumeration

Represents a document processing status.

public enum DocumentStatus

Values

Name	Value	Description
SuccessfullyProcessed	`0`	Document successfully indexed.
Skipped	`1`	Document skipped.
ProcessedWithError	`2`	Error occurred during document indexing.

Net: Encodings

Mon, 01 Jan 0001 00:00:00 +0000

Encodings class

Contains names of possible encodings.

public static class Encodings

Fields

Name	Description
const ASMO_708	The ASMO-708 encoding.
const big5	The big5 encoding.
const cp1025	The cp1025 encoding.
const cp866	The cp866 encoding.
const cp875	The cp875 encoding.
const csISO2022JP	The csISO2022JP encoding.
const DOS_720	The DOS-720 encoding.
const DOS_862	The DOS-862 encoding.
const EUC_CN	The EUC-CN encoding.
const EUC_JP	The EUC-JP encoding.
const euc_jp	The euc-jp encoding.
const euc_kr	The euc-kr encoding.
const GB18030	The GB18030 encoding.
const gb2312	The gb2312 encoding.
const hz_gb_2312	The hz-gb-2312 encoding.
const IBM00858	The IBM00858 encoding.
const IBM00924	The IBM00924 encoding.
const IBM01047	The IBM01047 encoding.
const IBM01140	The IBM01140 encoding.
const IBM01141	The IBM01141 encoding.
const IBM01142	The IBM01142 encoding.
const IBM01143	The IBM01143 encoding.
const IBM01144	The IBM01144 encoding.
const IBM01145	The IBM01145 encoding.
const IBM01146	The IBM01146 encoding.
const IBM01147	The IBM01147 encoding.
const IBM01148	The IBM01148 encoding.
const IBM01149	The IBM01149 encoding.
const IBM037	The IBM037 encoding.
const IBM1026	The IBM1026 encoding.
const IBM273	The IBM273 encoding.
const IBM277	The IBM277 encoding.
const IBM278	The IBM278 encoding.
const IBM280	The IBM280 encoding.
const IBM284	The IBM284 encoding.
const IBM285	The IBM285 encoding.
const IBM290	The IBM290 encoding.
const IBM297	The IBM297 encoding.
const IBM420	The IBM420 encoding.
const IBM423	The IBM423 encoding.
const IBM424	The IBM424 encoding.
const IBM437	The IBM437 encoding.
const IBM500	The IBM500 encoding.
const ibm737	The ibm737 encoding.
const ibm775	The ibm775 encoding.
const ibm850	The ibm850 encoding.
const ibm852	The ibm852 encoding.
const IBM855	The IBM855 encoding.
const ibm857	The ibm857 encoding.
const IBM860	The IBM860 encoding.
const ibm861	The ibm861 encoding.
const IBM863	The IBM863 encoding.
const IBM864	The IBM864 encoding.
const IBM865	The IBM865 encoding.
const ibm869	The ibm869 encoding.
const IBM870	The IBM870 encoding.
const IBM871	The IBM871 encoding.
const IBM880	The IBM880 encoding.
const IBM905	The IBM905 encoding.
const IBM_Thai	The IBM-Thai encoding.
const iso_2022_jp	The iso-2022-jp encoding.
const iso_2022_kr	The iso-2022-kr encoding.
const iso_8859_1	The iso-8859-1 encoding.
const iso_8859_13	The iso-8859-13 encoding.
const iso_8859_15	The iso-8859-15 encoding.
const iso_8859_2	The iso-8859-2 encoding.
const iso_8859_3	The iso-8859-3 encoding.
const iso_8859_4	The iso-8859-4 encoding.
const iso_8859_5	The iso-8859-5 encoding.
const iso_8859_6	The iso-8859-6 encoding.
const iso_8859_7	The iso-8859-7 encoding.
const iso_8859_8	The iso-8859-8 encoding.
const iso_8859_8_i	The iso-8859-8-i encoding.
const iso_8859_9	The iso-8859-9 encoding.
const Johab	The Johab encoding.
const koi8_r	The koi8-r encoding.
const koi8_u	The koi8-u encoding.
const ks_c_5601_1987	The ks_c_5601-1987 encoding.
const macintosh	The macintosh encoding.
const shift_jis	The shift_jis encoding.
const us_ascii	The us-ascii encoding.
const utf_16	The utf-16 encoding.
const utf_16BE	The utf-16BE encoding.
const utf_32	The utf-32 encoding.
const utf_32BE	The utf-32BE encoding.
const utf_7	The utf-7 encoding.
const utf_8	The utf-8 encoding.
const Windows_1250	The Windows-1250 encoding.
const Windows_1251	The Windows-1251 encoding.
const Windows_1252	The Windows-1252 encoding.
const Windows_1253	The Windows-1253 encoding.
const Windows_1254	The Windows-1254 encoding.
const Windows_1255	The Windows-1255 encoding.
const Windows_1256	The Windows-1256 encoding.
const Windows_1257	The Windows-1257 encoding.
const Windows_1258	The Windows-1258 encoding.
const windows_874	The windows-874 encoding.
const x_Chinese_CNS	The x-Chinese-CNS encoding.
const x_Chinese_Eten	The x-Chinese-Eten encoding.
const x_cp20001	The x-cp20001 encoding.
const x_cp20003	The x-cp20003 encoding.
const x_cp20004	The x-cp20004 encoding.
const x_cp20005	The x-cp20005 encoding.
const x_cp20261	The x-cp20261 encoding.
const x_cp20269	The x-cp20269 encoding.
const x_cp20936	The x-cp20936 encoding.
const x_cp20949	The x-cp20949 encoding.
const x_cp50227	The x-cp50227 encoding.
const x_EBCDIC_KoreanExtended	The x-EBCDIC-KoreanExtended encoding.
const x_Europa	The x-Europa encoding.
const x_IA5	The x-IA5 encoding.
const x_IA5_German	The x-IA5-German encoding.
const x_IA5_Norwegian	The x-IA5-Norwegian encoding.
const x_IA5_Swedish	The x-IA5-Swedish encoding.
const x_iscii_as	The x-iscii-as encoding.
const x_iscii_be	The x-iscii-be encoding.
const x_iscii_de	The x-iscii-de encoding.
const x_iscii_gu	The x-iscii-gu encoding.
const x_iscii_ka	The x-iscii-ka encoding.
const x_iscii_ma	The x-iscii-ma encoding.
const x_iscii_or	The x-iscii-or encoding.
const x_iscii_pa	The x-iscii-pa encoding.
const x_iscii_ta	The x-iscii-ta encoding.
const x_iscii_te	The x-iscii-te encoding.
const x_mac_arabic	The x-mac-arabic encoding.
const x_mac_ce	The x-mac-ce encoding.
const x_mac_chinesesimp	The x-mac-chinesesimp encoding.
const x_mac_chinesetrad	The x-mac-chinesetrad encoding.
const x_mac_croatian	The x-mac-croatian encoding.
const x_mac_cyrillic	The x-mac-cyrillic encoding.
const x_mac_greek	The x-mac-greek encoding.
const x_mac_hebrew	The x-mac-hebrew encoding.
const x_mac_icelandic	The x-mac-icelandic encoding.
const x_mac_japanese	The x-mac-japanese encoding.
const x_mac_korean	The x-mac-korean encoding.
const x_mac_romanian	The x-mac-romanian encoding.
const x_mac_thai	The x-mac-thai encoding.
const x_mac_turkish	The x-mac-turkish encoding.
const x_mac_ukrainian	The x-mac-ukrainian encoding.

Remarks

Learn more

Text file encoding detection

Net: ExtractedData

Mon, 01 Jan 0001 00:00:00 +0000

ExtractedData class

Represents data retrieved from a document and prepared for indexing.

public class ExtractedData

Properties

Name	Description
IsExtractionSuccessful { get; }	Gets a value indicating whether the data extraction process completed successfully.

Methods

Name	Description
static Deserialize(byte[])	Deserializes an instance from a byte array.
Serialize()	Serializes the current instance to a byte array.

Net: ExtractedItemInfo

Mon, 01 Jan 0001 00:00:00 +0000

ExtractedItemInfo class

Represents a container item information.

public class ExtractedItemInfo

Constructors

Name	Description
ExtractedItemInfo(FormatFamily, DocumentField[], string, string)	Initializes a new instance of the `ExtractedItemInfo` class.

Properties

Name	Description
Fields { get; }	Gets an extracted fields.
FormatFamily { get; }	Gets a document type.
InnerPath { get; }	Gets an inner path.
ItemInfo { get; }	Gets an item information.

Remarks

Learn more

Custom text extractors

Net: ExtractorSettings

Mon, 01 Jan 0001 00:00:00 +0000

ExtractorSettings class

Contains settings for the document data extractor.

public class ExtractorSettings

Properties

Name	Description
IndexType { get; set; }	Gets or sets the index type the extractor is used for. The default value is NormalIndex.

Net: FileLogger

Mon, 01 Jan 0001 00:00:00 +0000

FileLogger class

Represents a logger that logs events and errors to a local file.

public class FileLogger : ILogger

Constructors

Name	Description
FileLogger(string, double)	Initializes a new instance of the `FileLogger` class.

Properties

Name	Description
FilePath { get; }	Gets the log file path.
MaxSize { get; }	Gets the maximum size of log file in megabytes.

Methods

Name	Description
Error(string)	Logs an error that occurred in the index.
Trace(string)	Logs an event that occurred in the index.

Remarks

Learn more

Logging

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";
string query = "Einstein";
string logPath = @"c:\Log.txt";

IndexSettings settings = new IndexSettings();
settings.Logger = new FileLogger(logPath, 4.0); // Specifying the path to the log file and a maximum length of 4 MB

Index index = new Index(indexFolder, settings); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

SearchResult result = index.Search(query); // Search in index

Net: FileOutputAdapter

Mon, 01 Jan 0001 00:00:00 +0000

FileOutputAdapter class

Represents an output adapter that collects output into a file.

public class FileOutputAdapter : OutputAdapter

Constructors

Name	Description
FileOutputAdapter(OutputFormat, string)	Initializes a new instance of the `FileOutputAdapter` class.

Properties

Name	Description
FilePath { get; }	Gets an output file path.
OutputFormat { get; }	Gets the output format.

Remarks

Learn more

Output adapters

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

DocumentInfo[] documents = index.GetIndexedDocuments(); // Getting information on indexed documents

FileOutputAdapter adapter = new FileOutputAdapter(@"c:\DocumentText.htm"); // Creating a file output adapter
index.GetDocumentText(documents[0], adapter); // Generating a document text into the output file

Net: FragmentContainer

Mon, 01 Jan 0001 00:00:00 +0000

FragmentContainer class

Represents a container for text fragments with highlighted found terms of one document field.

public class FragmentContainer

Properties

Name	Description
Count { get; }	Gets the number of contained text fragments.
FieldName { get; }	Gets the document field name.

Methods

Name	Description
GetFragments()	Gets an array of contained text fragments.

Remarks

Learn more

Highlighting search results

Net: IContainerItemExtractor

Mon, 01 Jan 0001 00:00:00 +0000

IContainerItemExtractor interface

Provides methods for extracting items from container documents.

public interface IContainerItemExtractor : IFieldExtractor

Properties

Name	Description
FormatFamily { get; }	Gets the document format family.

Methods

Name	Description
GetContainerItems(Stream)	Extracts items from container document.
GetContainerItems(string)	Extracts items from container document.

Remarks

Learn more

Custom text extractors

Net: IDocumentLoader

Mon, 01 Jan 0001 00:00:00 +0000

IDocumentLoader interface

Defines the document loader interface that is used to load lazy documents.

public interface IDocumentLoader

Methods

Name	Description
CloseDocument()	Closes the loaded document. This method is called by the index when it has finished processing the document.
LoadDocument()	Loads a document. This method is called by the index when it is ready for processing the document.

Net: IFieldExtractor

Mon, 01 Jan 0001 00:00:00 +0000

IFieldExtractor interface

Provides methods for extracting fields from a document.

public interface IFieldExtractor

Properties

Name	Description
Extensions { get; }	Gets the supported extensions.

Methods

Name	Description
GetFields(Stream)	Extracts all fields from the specified document.
GetFields(string)	Extracts all fields from the specified document.

Remarks

Learn more

Custom text extractors

Examples

The example demonstrates how to implement the interface IFieldExtractor.

public class LogExtractor : IFieldExtractor
{
    private readonly string[] extensions = new string[] { ".log" };

    public string[] Extensions
    {
        get { return extensions; }
    }

    public DocumentField[] GetFields(string filePath)
    {
        FileInfo fileInfo = new FileInfo(filePath);
        DocumentField[] fields = new DocumentField[]
        {
            new DocumentField("FileName", fileInfo.FullName),
            new DocumentField("CreationDate", fileInfo.CreationTime.ToString(CultureInfo.InvariantCulture)),
            new DocumentField("Content", ExtractContent(filePath)),
        };
        return fields;
    }

    private string ExtractContent(string filePath)
    {
        StringBuilder result = new StringBuilder();
        using (StreamReader streamReader = File.OpenText(filePath))
        {
            string line = streamReader.ReadLine();
            string processedLine = line.Remove(0, 12);
            result.AppendLine(processedLine);
        }
        return result.ToString();
    }
}

The example demonstrates how to use the custorm extractor for indexing.

string indexFolder = @"c:\MyIndex\"; // Specify path to the index folder
string documentsFolder = @"c:\MyDocuments\"; // Specify path to a folder containing documents to search

Index index = new Index(indexFolder); // Creating or loading an index

index.IndexSettings.CustomExtractors.Add(new LogExtractor()); // Adding custom text extractor to index settings

index.Add(documentsFolder); // Indexing documents from the specified folder

Net: ILogger

Mon, 01 Jan 0001 00:00:00 +0000

ILogger interface

Defines interface of a logger that is used for logging events and errors in an index.

public interface ILogger

Methods

Name	Description
Error(string)	Logs an error that occurred in the index.
Trace(string)	Logs an event that occurred in the index.

Remarks

Learn more

Logging

Net: IWordSplitter

Mon, 01 Jan 0001 00:00:00 +0000

IWordSplitter interface

Defines a method for splitting text into individual words.

public interface IWordSplitter

Methods

Name	Description
Split(string)	Splits the input string into individual words.

Net: ImageFrame

Mon, 01 Jan 0001 00:00:00 +0000

ImageFrame class

Represents an image frame.

public class ImageFrame

Properties

Name	Description
Index { get; }	Gets the index of the frame in the image.

Net: IndexInfo

Mon, 01 Jan 0001 00:00:00 +0000

IndexInfo class

Contains basic information on an Index.

public class IndexInfo

Properties

Name	Description
IndexFolder { get; }	Gets the full folder name where index is located.
IndexId { get; }	Gets the index unique identifier.
IndexStatus { get; }	Gets the index status.
SegmentCount { get; }	Gets the number of index segments.
TermCount { get; }	Gets the number of words in the index.
Version { get; }	Gets the index version.

Net: IndexStatus

Mon, 01 Jan 0001 00:00:00 +0000

IndexStatus enumeration

Specifies an index status.

public enum IndexStatus

Values

Name	Value	Description
Ready	`0`	The index is free and ready for changes.
Failed	`1`	The index needs to be reloaded due to an error.
Indexing	`2`	The index performs an indexing operation.
Updating	`3`	The index performs an updating operation.
Merging	`4`	The index performs a merging operation.
Optimizing	`5`	The index performs an optimizing operation.
Deleting	`6`	The index performs a deleting operation.
Renaming	`7`	The index performs a renaming operation.
ChangingAttributes	`8`	The index changes attributes.
CheckingSegments	`9`	The index checks segments.
SavingTheIndex	`10`	The index is saved to another folder.

Net: IndexingReport

Mon, 01 Jan 0001 00:00:00 +0000

IndexingReport class

Represents a detailed information on an indexing operation.

public class IndexingReport

Properties

Name	Description
EndTime { get; }	Gets the indexing end time.
Errors { get; }	Gets the list of errors.
IndexedDocuments { get; }	Gets the list of indexed documents.
IndexedDocumentsSize { get; }	Gets the total length of indexed documents in MB.
IndexingTime { get; }	Gets the indexing duration.
RemovedDocuments { get; }	Gets the list of removed from index documents.
SegmentCount { get; }	Gets the number of index segments.
StartTime { get; }	Gets the indexing start time.
TotalDocumentsInIndex { get; }	Gets the total number of documents in the index.
TotalIndexSize { get; }	Gets the total index size in bytes.
TotalTermCount { get; }	Gets the total number of terms in index.
UpdatedDocuments { get; }	Gets the list of updated documents.

Remarks

Learn more

Indexing reports

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder1 = @"c:\MyDocuments1\";
string documentsFolder2 = @"c:\MyDocuments2\";

// Creating an index in the specified folder
Index index = new Index(indexFolder);

// Indexing documents
index.Add(documentsFolder1);
index.Add(documentsFolder2);

// Getting indexing reports
IndexingReport[] reports = index.GetIndexingReports();

// Printing reports to the console
foreach (IndexingReport report in reports)
{
    Console.WriteLine("Time: " + report.StartTime);
    Console.WriteLine("Duration: " + report.IndexingTime);
    Console.WriteLine("Documents total: " + report.TotalDocumentsInIndex);
    Console.WriteLine("Terms total: " + report.TotalTermCount);
    Console.WriteLine("Indexed documents size (MB): " + report.IndexedDocumentsSize);
    Console.WriteLine("Index size (MB): " + (report.TotalIndexSize / 1024.0 / 1024.0));
    Console.WriteLine();
}

Net: Notification

Mon, 01 Jan 0001 00:00:00 +0000

Notification class

The base class for all notifications to the index. This class also contains methods for creating notification objects.

public abstract class Notification

Methods

Name	Description
static CreateRenameNotification(string, string)	Creates a notification object to rename an indexed document that has been renamed and does not need to be reindexed. The renamed document will not be reindexed during the next update operation, even if its contents have been changed.

Remarks

Learn more

Document renaming

Net: OutputAdapter

Mon, 01 Jan 0001 00:00:00 +0000

OutputAdapter class

Represents the base class of an output adapter that is used to collect an output in a generalized form. The currently available adapters are FileOutputAdapter, StreamOutputAdapter, StructureOutputAdapter, and StringOutputAdapter.

public abstract class OutputAdapter : ResultBuilderFactory

Properties

Name	Description
OutputFormat { get; }	Gets the output format.

Remarks

Learn more

Output adapters

Net: ResultBuilderFactory

Mon, 01 Jan 0001 00:00:00 +0000

ResultBuilderFactory class

Represents the base class of a result builder factory.

public abstract class ResultBuilderFactory

Properties

Name	Description
OutputFormat { get; }	Gets the output format.

Net: SearchImage

Mon, 01 Jan 0001 00:00:00 +0000

SearchImage class

Represents an image to search.

public class SearchImage

Methods

Name	Description
static Create(Stream)	Creates an image from a stream to search.
static Create(string)	Creates an image from a file to search.
static Create(Stream, int)	Creates an image from a stream to search.
static Create(string, int)	Creates an image from a file to search.

Net: SearchReport

Mon, 01 Jan 0001 00:00:00 +0000

SearchReport class

Represents a detailed information on a search operation.

public class SearchReport

Properties

Name	Description
DocumentCount { get; }	Gets the number of documents found.
EndTime { get; }	Gets the end time of the search.
ObjectQuery { get; }	Gets the search query in object form.
OccurrenceCount { get; }	Gets the total number of occurrences found.
SearchDuration { get; }	Gets the search duration.
SearchOptions { get; }	Gets the search options.
StartTime { get; }	Gets the start time of the search.
TextQuery { get; }	Gets the search query in text form.

Methods

Name	Description
override ToString()	Returns a String that represents the current `SearchReport`.

Remarks

Learn more

Search reports

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index in the specified folder
Index index = new Index(indexFolder);

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Searching in index
SearchResult result1 = index.Search("Einstein");
SearchResult result2 = index.Search("\"Theory of Relativity\"");

// Getting search reports
SearchReport[] reports = index.GetSearchReports();

// Printing reports to the console
foreach (SearchReport report in reports)
{
    Console.WriteLine("Query: " + report.TextQuery);
    Console.WriteLine("Time: " + report.StartTime);
    Console.WriteLine("Duration: " + report.SearchDuration);
    Console.WriteLine("Documents: " + report.DocumentCount);
    Console.WriteLine("Occurrences: " + report.OccurrenceCount);
    Console.WriteLine();
}

Net: StreamOutputAdapter

Mon, 01 Jan 0001 00:00:00 +0000

StreamOutputAdapter class

Represents an output adapter that collects output into a Stream.

public class StreamOutputAdapter : OutputAdapter

Constructors

Name	Description
StreamOutputAdapter(OutputFormat, Stream)	Initializes a new instance of the `StreamOutputAdapter` class.

Properties

Name	Description
OutputFormat { get; }	Gets the output format.
Stream { get; }	Gets an output stream.

Remarks

Learn more

Output adapters

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

DocumentInfo[] documents = index.GetIndexedDocuments(); // Getting information on indexed documents

using (Stream stream = new MemoryStream()) // Creating a stream
{
    StreamOutputAdapter adapter = new StreamOutputAdapter(stream); // Creating a stream output adapter
    index.GetDocumentText(documents[0], adapter); // Generating a document text into the stream
}

Net: StringOutputAdapter

Mon, 01 Jan 0001 00:00:00 +0000

StringOutputAdapter class

Represents an output adapter that collects output as a String.

public class StringOutputAdapter : OutputAdapter

Constructors

Name	Description
StringOutputAdapter(OutputFormat)	Initializes a new instance of the `StringOutputAdapter` class.

Properties

Name	Description
OutputFormat { get; }	Gets the output format.

Methods

Name	Description
GetResult()	Gets the resulting string.

Remarks

Learn more

Output adapters

Examples

The example demonstrates a typical usage of the class.

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

Index index = new Index(indexFolder); // Creating an index in the specified folder

index.Add(documentsFolder); // Indexing documents from the specified folder

DocumentInfo[] documents = index.GetIndexedDocuments(); // Getting information on indexed documents

StringOutputAdapter adapter = new StringOutputAdapter(OutputFormat.Html); // Creating a string output adapter
index.GetDocumentText(documents[0], adapter); // Generating a document text into the adapter
String result = adapter.GetResult(); // Getting a result

Net: StructureOutputAdapter

Mon, 01 Jan 0001 00:00:00 +0000

StructureOutputAdapter class

Represents an output adapter that collects output as a structure containing each field separately.

public class StructureOutputAdapter : OutputAdapter

Constructors

Name	Description
StructureOutputAdapter(OutputFormat)	Initializes a new instance of the `StructureOutputAdapter` class.

Properties

Name	Description
OutputFormat { get; }	Gets the output format.

Methods

Name	Description
GetResult()	Gets the resulting array of fields.

Net: VersionUpdateResult

Mon, 01 Jan 0001 00:00:00 +0000

VersionUpdateResult enumeration

Represents the result of an index version update operation.

public enum VersionUpdateResult

Values

Name	Value	Description
Updated	`0`	Index version updated.
AlreadyUpToDate	`1`	Index version is already up-to-date.
Unsupported	`2`	Index version is not supported or directory does not contain valid index data.

Net: WordPattern

Mon, 01 Jan 0001 00:00:00 +0000

WordPattern class

Represents a word pattern to use in word wildcard search.

public class WordPattern

Constructors

Name	Description
WordPattern()	Initializes a new instance of the `WordPattern` class.

Methods

Name	Description
AppendCharacter(char)	Appends a character to the word pattern.
AppendOneCharacterWildcard()	Appends one character wildcard to the word pattern.
AppendOneOrMoreCharactersWildcard()	Appends one or more characters wildcard to the word pattern.
AppendString(string)	Appends a string to the word pattern.
AppendWildcard(int, int)	Appends a wildcard to the word pattern.
AppendZeroOrMoreCharactersWildcard()	Appends zero or more characters wildcard to the word pattern.
AppendZeroOrOneCharacterWildcard()	Appends zero or one character wildcard to the word pattern.
override ToString()	Returns a String that represents the current `WordPattern`.

Remarks

Learn more

Groupdocs API References – GroupDocs.Search.Common

Net: AttributeChangeBatch

AttributeChangeBatch class

Constructors

Methods

Remarks

See Also

Net: Cancellation

Cancellation class

Constructors

Properties

Methods

Remarks

See Also

Net: ChunkSearchToken

ChunkSearchToken class

Remarks

See Also

Net: CustomExtractorCollection

CustomExtractorCollection class

Properties

Methods

Remarks

See Also

Net: Document

Document class

Properties

Methods

Remarks

See Also

Net: DocumentField

DocumentField class

Constructors

Properties

Remarks

See Also

Net: DocumentImage

DocumentImage class

Properties

See Also

Net: DocumentSourceKind

DocumentSourceKind enumeration

Values

See Also

Net: DocumentStatus

DocumentStatus enumeration

Values

See Also

Net: Encodings

Encodings class

Fields

Remarks

See Also

Net: ExtractedData

ExtractedData class

Properties

Methods

See Also

Net: ExtractedItemInfo

ExtractedItemInfo class

Constructors

Properties

Remarks

See Also

Net: ExtractorSettings

ExtractorSettings class

Properties

See Also

Net: FileLogger

FileLogger class

Constructors

Properties

Methods

Remarks

Examples

See Also

Net: FileOutputAdapter

FileOutputAdapter class

Constructors

Properties