SearchOptions
Inheritance: java.lang.Object
public class SearchOptions
Provides options for search operation.
Learn more
Constructors
| Constructor | Description |
|---|---|
| SearchOptions() | Initializes a new instance of the SearchOptions class. |
| SearchOptions(Object data) | Initializes a new instance of the SearchOptions class. |
Methods
| Method | Description |
|---|---|
| getUseSynonymSearch() | Gets the flag of use synonyms in search. |
| setUseSynonymSearch(boolean value) | Sets the flag of use synonyms in search. |
| getUseHomophoneSearch() | Gets the flag of use homophones in search. |
| setUseHomophoneSearch(boolean value) | Sets the flag of use homophones in search. |
| getUseWordFormsSearch() | Gets the flag of use different word forms in search. |
| setUseWordFormsSearch(boolean value) | Sets the flag of use different word forms in search. |
| getRetrieveAttributes() | Gets the flag of retrieving attributes associated with found documents. |
| setRetrieveAttributes(boolean value) | Sets the flag of retrieving attributes associated with found documents. |
| getFuzzySearch() | Gets the fuzzy search options. |
| getSpellingCorrector() | Gets the spelling corrector options. |
| getKeyboardLayoutCorrector() | Gets the keyboard layout corrector options. |
| getUseCaseSensitiveSearch() | Gets the flag of case sensitive search. |
| setUseCaseSensitiveSearch(boolean value) | Sets the flag of case sensitive search. |
| getMaxTotalOccurrenceCount() | Gets the maximum total number of occurrences of all terms in a search query. |
| setMaxTotalOccurrenceCount(int value) | Sets the maximum total number of occurrences of all terms in a search query. |
| getMaxOccurrenceCountPerTerm() | Gets the maximum number of occurrences of each term in a search query. |
| setMaxOccurrenceCountPerTerm(int value) | Sets the maximum number of occurrences of each term in a search query. |
| getDateFormats() | Gets the collection of date formats for date range search. |
| isChunkSearch() | Gets the flag of search by chunks. |
| setChunkSearch(boolean value) | Sets the flag of search by chunks. |
| getSearchDocumentFilter() | Gets the search document filter. |
| setSearchDocumentFilter(ISearchDocumentFilter value) | Sets the search document filter. |
| getCancellation() | Gets the operation cancellation object. |
| setCancellation(Cancellation value) | Sets the operation cancellation object. |
| getCore() |
SearchOptions()
public SearchOptions()
Initializes a new instance of the SearchOptions class.
SearchOptions(Object data)
public SearchOptions(Object data)
Initializes a new instance of the SearchOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| data | java.lang.Object | The serialized data. |
getUseSynonymSearch()
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.
setUseSynonymSearch(boolean value)
public void setUseSynonymSearch(boolean value)
Sets the flag of use synonyms in search. The default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag of use synonyms in search. |
getUseHomophoneSearch()
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.
setUseHomophoneSearch(boolean value)
public void setUseHomophoneSearch(boolean value)
Sets the flag of use homophones in search. The default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag of use homophones in search. |
getUseWordFormsSearch()
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.
setUseWordFormsSearch(boolean value)
public void setUseWordFormsSearch(boolean value)
Sets the flag of use different word forms in search. The default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag of use different word forms in search. |
getRetrieveAttributes()
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.
setRetrieveAttributes(boolean value)
public void setRetrieveAttributes(boolean value)
Sets the flag of retrieving attributes associated with found documents. The default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag of retrieving attributes associated with found documents. |
getFuzzySearch()
public FuzzySearchOptions getFuzzySearch()
Gets the fuzzy search options.
Returns: FuzzySearchOptions - The fuzzy search options.
getSpellingCorrector()
public SpellingCorrectorOptions getSpellingCorrector()
Gets the spelling corrector options.
Returns: SpellingCorrectorOptions - The spelling corrector options.
getKeyboardLayoutCorrector()
public KeyboardLayoutCorrectorOptions getKeyboardLayoutCorrector()
Gets the keyboard layout corrector options.
Returns: KeyboardLayoutCorrectorOptions - The keyboard layout corrector options.
getUseCaseSensitiveSearch()
public boolean getUseCaseSensitiveSearch()
Gets the flag of case sensitive search. The default value is false .
Returns: boolean - The flag of case sensitive search.
setUseCaseSensitiveSearch(boolean value)
public void setUseCaseSensitiveSearch(boolean value)
Sets the flag of case sensitive search. The default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag of case sensitive search. |
getMaxTotalOccurrenceCount()
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.
setMaxTotalOccurrenceCount(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The maximum total number of occurrences. |
getMaxOccurrenceCountPerTerm()
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.
setMaxOccurrenceCountPerTerm(int value)
public void setMaxOccurrenceCountPerTerm(int value)
Sets the maximum number of occurrences of each term in a search query. The default value is 100000 .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The maximum number of occurrences of each term in a search query. |
getDateFormats()
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
isChunkSearch()
public boolean isChunkSearch()
Gets the flag of search by chunks. The default value is false .
Returns: boolean - The flag of search by chunks.
setChunkSearch(boolean value)
public void setChunkSearch(boolean value)
Sets the flag of search by chunks. The default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The flag of search by chunks. |
getSearchDocumentFilter()
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);
setSearchDocumentFilter(ISearchDocumentFilter value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | 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);
``` |
### getCancellation() {#getCancellation--}
public Cancellation getCancellation()
Gets the operation cancellation object. The default value is null .
**Returns:**
[Cancellation](../../com.groupdocs.search.common/cancellation) - The operation cancellation object.
### setCancellation(Cancellation value) {#setCancellation-com.groupdocs.search.common.Cancellation-}
public void setCancellation(Cancellation value)
Sets the operation cancellation object. The default value is null .
**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [Cancellation](../../com.groupdocs.search.common/cancellation) | The operation cancellation object. |
### getCore() {#getCore--}
public Object getCore()
**Returns:**
java.lang.Object