Indexing options Leave feedback

This page contains a description of all the properties of the IndexingOptions class.

The setCancellation method is used to specify an object of type Cancellation, used to cancel of an index operation. The default value is null. An operation can be canceled if necessary with a time delay. Note that after cancellation, an index may not immediately stop an operation, but with a some delay.

The following example demonstrates cancelling of an indexing operation.

const indexFolder = 'c:/MyIndex/';
const documentFolder = 'c:/MyDocuments/';

// Creating an index in the specified folder
const index = new groupdocs.search.Index(indexFolder);

// Creating an instance of indexing options
const options = new groupdocs.search.IndexingOptions();
options.setCancellation(new groupdocs.search.Cancellation()); // Setting a cancellation object
options.getCancellation().cancelAfter(3000); // Setting a time period of 3 seconds after which the indexing operation will be cancelled

// Indexing documents from the specified folder
index.add(documentFolder, options);

The setAsync method is used to specify whether to perform indexing operation asynchronously or synchronously. The default value is false, meaning synchronous execution. The example below demonstrates the performing of an asynchronous indexing.

const indexFolder = 'c:/MyIndex/';
const documentFolder = 'c:/MyDocuments/';

// Creating index in the specified folder
const index = new groupdocs.search.Index(indexFolder);

// Subscribing to the event
index.getEvents().StatusChanged.add(
  java.newProxy('com.groupdocs.search.events.EventHandler', {
    invoke: function (sender, args) {
      if (
        String(args.getStatus()) == String(groupdocs.search.IndexStatus.Ready) ||
        String(args.getStatus()) == String(groupdocs.search.IndexStatus.Failed)
      ) {
        // A notification of the operation completion should be here
        console.log('Status: ' + args.getStatus());
      }
    },
  }),
);

// Creating an instance of indexing options
const options = new groupdocs.search.IndexingOptions();
options.setAsync(true); // Specifying the asynchronous performing of the operation

// Indexing documents from the specified folder
// The method will return control before the indexing operation is completed
index.add(documentFolder, options);

The setThreads method is used to set the number of threads used for indexing. The default value is 1. The number of indexing threads cannot be less than 1 or more than 4.

A larger number of threads accelerates the indexing process. However, be careful when specifying the number of indexing threads more than 1, because the amount of memory used during indexing is directly proportional to the number of threads involved. If there is 4 GB of RAM or less in the system, using more than 1 thread may result in out of memory error. In addition, the hard disk where the files for indexing are located may be the bottleneck and performance will not increase.

The following example demonstrates how to perform indexing in 2 threads.

const indexFolder = 'c:/MyIndex/';
const documentFolder = 'c:/MyDocuments/';

// Creating an index in the specified folder
const index = new groupdocs.search.Index(indexFolder);

// Creating an instance of indexing options
const options = new groupdocs.search.IndexingOptions();
options.setThreads(2); // Setting the number of indexing threads

// Indexing documents from the specified folder
index.add(documentFolder, options);

The getMetadataIndexingOptions method returns an instance of the MetadataIndexingOptions class. This class contains methods for setting metadata indexing options:

• The setIndexingEmptyValues method sets a value indicating whether to index empty field values or not. The default value is true.
• The setIndexingEmptyNames method sets a value indicating whether to index empty field names or not. The default value is true.
• The setDefaultFieldName method sets the default field name used to index empty field names. The default value is “unknown”.
• The setSeparatorInCompoundName method sets the separator in the compound name of a field. The default value is “.” (period character).
• The setMaxBytesToIndexField method sets the maximum number of values indexed from an array of byte values. The default value is Integer.MAX_VALUE.
• The setMaxIntsToIndexField method sets the maximum number of values indexed from an array of int values. The default value is Integer.MAX_VALUE.
• The setMaxLongsToIndexField method sets the maximum number of values indexed from an array of long values. The default value is Integer.MAX_VALUE.
• The setMaxDoublesToIndexField method sets the maximum number of values indexed from an array of double values. The default value is Integer.MAX_VALUE.
• The setSeparatorBetweenValues method sets the separator between values in a field of type array. The default value is " " (space character).

The following example demonstrates how to set the metadata indexing options.

const indexFolder = 'c:/MyIndex/';
const documentFolder = 'c:/MyDocuments/';

// Creating an index
const index = new groupdocs.search.Index(indexFolder);

// Setting the metadata indexing options
const options = new groupdocs.search.IndexingOptions();
options.getMetadataIndexingOptions().setDefaultFieldName('default');
options.getMetadataIndexingOptions().setSeparatorInCompoundName('\\');
options.getMetadataIndexingOptions().setMaxBytesToIndexField(10);
options.getMetadataIndexingOptions().setMaxIntsToIndexField(10);
options.getMetadataIndexingOptions().setMaxLongsToIndexField(10);
options.getMetadataIndexingOptions().setMaxDoublesToIndexField(10);

// Starting indexing operation
index.add(documentFolder, options);

The getOcrIndexingOptions method returns an instance of the OcrIndexingOptions class. This class contains properties for setting OCR processing options:

• The setEnabledForSeparateImages method sets a value indicating whether to recognize text in separate image files. The default value is false.
• The setEnabledForEmbeddedImages method sets a value indicating whether to recognize text in embedded images. The default value is false.
• The setEnabledForContainerItemImages method sets a value indicating whether to recognize text in images that are items in a container (ZIP archive, OST/PST storage). The default value is false.
• The setOcrConnector method sets an OCR connector that is used for OCR processing. The default value is null, which means no OCR is used.

The getImageIndexingOptions method returns an instance of the ImageIndexingOptions class. This class provides image indexing options for reverse image search:

• The setEnabledForSeparateImages method sets a value indicating whether to index separate image files. The default value is false.
• The setEnabledForEmbeddedImages method sets a value indicating whether to index embedded images (for example, images in a DOCX document). The default value is false.
• The setEnabledForContainerItemImages method sets a value indicating whether to index images that are items in a container (ZIP archive, OST/PST storage). The default value is false.

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

• GroupDocs.Search for .NET examples

• GroupDocs.Search for Java examples

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.