com.groupdocs.search.options

Class ImageSearchOptions

java.lang.Object

com.groupdocs.search.options.ImageSearchOptions

public class ImageSearchOptions
extends Object

Provides options for reverse image search operation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Object	getCore()
int	getHashDifferences() Gets the maximum number of mismatched bits in the image hash.
int	getMaxResultCount() Gets the maximum number of found images for an image reverse search request.
ISearchDocumentFilter	getSearchDocumentFilter() Gets the search document filter.
void	setHashDifferences(int value) Sets the maximum number of mismatched bits in the image hash.
void	setMaxResultCount(int value) Sets the maximum number of found images for an image reverse search request.
void	setSearchDocumentFilter(ISearchDocumentFilter value) Gets or sets the search document filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageSearchOptions

public ImageSearchOptions()

Initializes a new instance of the ImageSearchOptions class.

ImageSearchOptions

public ImageSearchOptions(Object data)

Initializes a new instance of the ImageSearchOptions class.

Parameters:

data - The serialized data.

ImageSearchOptions

protected ImageSearchOptions(Object state1,
                             Object state2)

Initializes a new instance of the ImageSearchOptions class.

Parameters:

state1 - The state 1.

state2 - The state 2.

Method Detail

getCore

public Object getCore()

getHashDifferences

public int getHashDifferences()

Gets the maximum number of mismatched bits in the image hash. The default value is 5.

Returns:

The maximum number of mismatched bits in the image hash.

getMaxResultCount

public int getMaxResultCount()

Gets the maximum number of found images for an image reverse search request. The default value is 1000.

Returns:

The maximum number of found images for an image reverse search request.

getSearchDocumentFilter

public ISearchDocumentFilter getSearchDocumentFilter()

Gets the search document filter. SearchDocumentFilter works on the inclusion logic. Use GroupDocs.Search.Options.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.

setHashDifferences

public void setHashDifferences(int value)

Sets the maximum number of mismatched bits in the image hash. The default value is 5.

Parameters:

value - The maximum number of mismatched bits in the image hash.

setMaxResultCount

public void setMaxResultCount(int value)

Sets the maximum number of found images for an image reverse search request. The default value is 1000.

Parameters:

value - The maximum number of found images for an image reverse search request.

setSearchDocumentFilter

public void setSearchDocumentFilter(ISearchDocumentFilter value)

Gets or sets the search document filter. SearchDocumentFilter works on the inclusion logic. Use GroupDocs.Search.Options.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.