SearchOptions Leave feedback

Inheritance: java.lang.Object

public class SearchOptions

Provides options for search operation.

Learn more

• Search options

public SearchOptions()

Initializes a new instance of the SearchOptions class.

public SearchOptions(Object data)

Initializes a new instance of the SearchOptions class.

Parameters:

public boolean getUseSynonymSearch()

Gets the flag of use synonyms in search. The default value is false .

Returns: boolean - The flag of use synonyms in search.

public void setUseSynonymSearch(boolean value)

Sets the flag of use synonyms in search. The default value is false .

Parameters:

public boolean getUseHomophoneSearch()

Gets the flag of use homophones in search. The default value is false .

Returns: boolean - The flag of use homophones in search.

public void setUseHomophoneSearch(boolean value)

Sets the flag of use homophones in search. The default value is false .

Parameters:

public boolean getUseWordFormsSearch()

Gets the flag of use different word forms in search. The default value is false .

Returns: boolean - The flag of use different word forms in search.

public void setUseWordFormsSearch(boolean value)

Sets the flag of use different word forms in search. The default value is false .

Parameters:

public boolean getRetrieveAttributes()

Gets the flag of retrieving attributes associated with found documents. The default value is false .

Returns: boolean - The flag of retrieving attributes associated with found documents.

public void setRetrieveAttributes(boolean value)

Sets the flag of retrieving attributes associated with found documents. The default value is false .

Parameters:

public FuzzySearchOptions getFuzzySearch()

Gets the fuzzy search options.

Returns: FuzzySearchOptions - The fuzzy search options.

public SpellingCorrectorOptions getSpellingCorrector()

Gets the spelling corrector options.

Returns: SpellingCorrectorOptions - The spelling corrector options.

public KeyboardLayoutCorrectorOptions getKeyboardLayoutCorrector()

Gets the keyboard layout corrector options.

Returns: KeyboardLayoutCorrectorOptions - The keyboard layout corrector options.

public boolean getUseCaseSensitiveSearch()

Gets the flag of case sensitive search. The default value is false .

Returns: boolean - The flag of case sensitive search.

public void setUseCaseSensitiveSearch(boolean value)

Sets the flag of case sensitive search. The default value is false .

Parameters:

public int getMaxTotalOccurrenceCount()

Gets the maximum total number of occurrences of all terms in a search query. The default value is 500000 .

Returns: int - The maximum total number of occurrences.

public void setMaxTotalOccurrenceCount(int value)

Sets the maximum total number of occurrences of all terms in a search query. The default value is 500000 .

Parameters:

public int getMaxOccurrenceCountPerTerm()

Gets the maximum number of occurrences of each term in a search query. The default value is 100000 .

Returns: int - The maximum number of occurrences of each term in a search query.

public void setMaxOccurrenceCountPerTerm(int value)

Sets the maximum number of occurrences of each term in a search query. The default value is 100000 .

Parameters:

public DateFormatCollection getDateFormats()

Gets the collection of date formats for date range search. The default date formats are ‘dd.MM.yyyy’, ‘MM/dd/yyyy’, and ‘yyyy-MM-dd’.

Returns: DateFormatCollection - The collection of date formats for date range search.

The example demonstrates how to set the date formats for the search.

 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 String query = "Einstein";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 SearchOptions options = new SearchOptions();
 options.getDateFormats().clear(); // Removing default date formats
 DateFormatElement[] elements = new DateFormatElement[] {
     DateFormatElement.getMonthTwoDigits(),
     DateFormatElement.getDayOfMonthTwoDigits(),
     DateFormatElement.getYearFourDigits(),
 };
 // Creating a date format pattern 'MM/dd/yyyy'
 com.groupdocs.search.DateFormat dateFormat = new com.groupdocs.search.DateFormat(elements, "/");
 options.getDateFormats().addItem(dateFormat);
 SearchResult result = index.search(query, options); // Search in index
 
```
 

public boolean isChunkSearch()

Gets the flag of search by chunks. The default value is false .

Returns: boolean - The flag of search by chunks.

public void setChunkSearch(boolean value)

Sets the flag of search by chunks. The default value is false .

Parameters:

public ISearchDocumentFilter getSearchDocumentFilter()

Gets the search document filter. SearchDocumentFilter works on the inclusion logic. Use SearchDocumentFilter class for creation of a search document filter instances. The default value is null , which means that all found documents will be returned.

Returns: ISearchDocumentFilter - The search document filter.

The example demonstrates how to set the document filter.

 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments1\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents
 index.add(documentsFolder);
 // Creating a search document filter that skips documents with extensions '.doc', '.docx', '.rtf'
 SearchOptions options = new SearchOptions();
 ISearchDocumentFilter fileExtensionFilter = SearchDocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 ISearchDocumentFilter invertedFilter = SearchDocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 options.setSearchDocumentFilter(invertedFilter);
 // Search in index
 SearchResult result = index.search("Einstein", options);
 
```
 

public void setSearchDocumentFilter(ISearchDocumentFilter value)

Sets the search document filter. SearchDocumentFilter works on the inclusion logic. Use SearchDocumentFilter class for creation of a search document filter instances. The default value is null , which means that all found documents will be returned.

Parameters:

The example demonstrates how to set the document filter.

 ```

 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments1\\";
 // Creating an index in the specified folder
 Index index = new Index(indexFolder);
 // Indexing documents
 index.add(documentsFolder);
 // Creating a search document filter that skips documents with extensions '.doc', '.docx', '.rtf'
 SearchOptions options = new SearchOptions();
 ISearchDocumentFilter fileExtensionFilter = SearchDocumentFilter.createFileExtension(".doc", ".docx", ".rtf"); // Creating file extension filter
 ISearchDocumentFilter invertedFilter = SearchDocumentFilter.createNot(fileExtensionFilter); // Inverting file extension filter
 options.setSearchDocumentFilter(invertedFilter);
 // Search in index
 SearchResult result = index.search("Einstein", options);
 
```
 

|

public Cancellation getCancellation()

Gets the operation cancellation object. The default value is null .

Returns: Cancellation - The operation cancellation object.

public void setCancellation(Cancellation value)

Sets the operation cancellation object. The default value is null .

Parameters:

public Object getCore()

Returns: java.lang.Object