com.groupdocs.search.options

Class SearchOptions

java.lang.Object

com.groupdocs.search.options.SearchOptions

public class SearchOptions
extends Object

Provides options for search operation.

Learn more

• Search options

Constructor Summary

Constructors

Modifier	Constructor and Description
	SearchOptions() Initializes a new instance of the SearchOptions class.
	SearchOptions(Object data) Initializes a new instance of the SearchOptions class.
protected	SearchOptions(Object state1, Object state2) Initializes a new instance of the SearchOptions class.

Method Summary

Modifier and Type	Method and Description
Cancellation	getCancellation() Gets the operation cancellation object.
Object	getCore()
DateFormatCollection	getDateFormats() Gets the collection of date formats for date range search.
FuzzySearchOptions	getFuzzySearch() Gets the fuzzy search options.
KeyboardLayoutCorrectorOptions	getKeyboardLayoutCorrector() Gets the keyboard layout corrector options.
int	getMaxOccurrenceCountPerTerm() Gets the maximum number of occurrences of each term in a search query.
int	getMaxTotalOccurrenceCount() Gets the maximum total number of occurrences of all terms in a search query.
boolean	getRetrieveAttributes() Gets the flag of retrieving attributes associated with found documents.
ISearchDocumentFilter	getSearchDocumentFilter() Gets the search document filter.
SpellingCorrectorOptions	getSpellingCorrector() Gets the spelling corrector options.
boolean	getUseCaseSensitiveSearch() Gets the flag of case sensitive search.
boolean	getUseHomophoneSearch() Gets the flag of use homophones in search.
boolean	getUseSynonymSearch() Gets the flag of use synonyms in search.
boolean	getUseWordFormsSearch() Gets the flag of use different word forms in search.
boolean	isChunkSearch() Gets the flag of search by chunks.
void	setCancellation(Cancellation value) Sets the operation cancellation object.
void	setChunkSearch(boolean value) Sets the flag of search by chunks.
void	setMaxOccurrenceCountPerTerm(int value) Sets the maximum number of occurrences of each term in a search query.
void	setMaxTotalOccurrenceCount(int value) Sets the maximum total number of occurrences of all terms in a search query.
void	setRetrieveAttributes(boolean value) Sets the flag of retrieving attributes associated with found documents.
void	setSearchDocumentFilter(ISearchDocumentFilter value) Sets the search document filter.
void	setUseCaseSensitiveSearch(boolean value) Sets the flag of case sensitive search.
void	setUseHomophoneSearch(boolean value) Sets the flag of use homophones in search.
void	setUseSynonymSearch(boolean value) Sets the flag of use synonyms in search.
void	setUseWordFormsSearch(boolean value) Sets the flag of use different word forms in search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchOptions

public SearchOptions()

Initializes a new instance of the SearchOptions class.

SearchOptions

public SearchOptions(Object data)

Initializes a new instance of the SearchOptions class.

Parameters:

data - The serialized data.

SearchOptions

protected SearchOptions(Object state1,
                        Object state2)

Initializes a new instance of the SearchOptions class.

Parameters:

state1 - The state.

state2 - The state.

Method Detail

getCancellation

public Cancellation getCancellation()

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

Returns:

The operation cancellation object.

getCore

public Object getCore()

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:

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
 
 

getFuzzySearch

public FuzzySearchOptions getFuzzySearch()

Gets the fuzzy search options.

Returns:

The fuzzy search options.

getKeyboardLayoutCorrector

public KeyboardLayoutCorrectorOptions getKeyboardLayoutCorrector()

Gets the keyboard layout corrector options.

Returns:

The keyboard layout corrector options.

getMaxOccurrenceCountPerTerm

public int getMaxOccurrenceCountPerTerm()

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

Returns:

The maximum number of occurrences of each term in a search query.

getMaxTotalOccurrenceCount

public int getMaxTotalOccurrenceCount()

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

Returns:

The maximum total number of occurrences.

getRetrieveAttributes

public boolean getRetrieveAttributes()

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

Returns:

The flag of retrieving attributes associated with found documents.

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:

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);
 
 

getSpellingCorrector

public SpellingCorrectorOptions getSpellingCorrector()

Gets the spelling corrector options.

Returns:

The spelling corrector options.

getUseCaseSensitiveSearch

public boolean getUseCaseSensitiveSearch()

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

Returns:

The flag of case sensitive search.

getUseHomophoneSearch

public boolean getUseHomophoneSearch()

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

Returns:

The flag of use homophones in search.

getUseSynonymSearch

public boolean getUseSynonymSearch()

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

Returns:

The flag of use synonyms in search.

getUseWordFormsSearch

public boolean getUseWordFormsSearch()

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

Returns:

The flag of use different word forms in search.

isChunkSearch

public boolean isChunkSearch()

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

Returns:

The flag of search by chunks.

setCancellation

public void setCancellation(Cancellation value)

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

Parameters:

value - The operation cancellation object.

setChunkSearch

public void setChunkSearch(boolean value)

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

Parameters:

value - The flag of search by chunks.

setMaxOccurrenceCountPerTerm

public void setMaxOccurrenceCountPerTerm(int value)

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

Parameters:

value - The maximum number of occurrences of each term in a search query.

setMaxTotalOccurrenceCount

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:

value - The maximum total number of occurrences.

setRetrieveAttributes

public void setRetrieveAttributes(boolean value)

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

Parameters:

value - The flag of retrieving attributes associated with found documents.

setSearchDocumentFilter

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:

value - 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);
 
 

setUseCaseSensitiveSearch

public void setUseCaseSensitiveSearch(boolean value)

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

Parameters:

value - The flag of case sensitive search.

setUseHomophoneSearch

public void setUseHomophoneSearch(boolean value)

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

Parameters:

value - The flag of use homophones in search.

setUseSynonymSearch

public void setUseSynonymSearch(boolean value)

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

Parameters:

value - The flag of use synonyms in search.

setUseWordFormsSearch

public void setUseWordFormsSearch(boolean value)

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

Parameters:

value - The flag of use different word forms in search.