com.groupdocs.search.scaling

Class Searcher

java.lang.Object

com.groupdocs.search.scaling.Searcher

public abstract class Searcher
extends Object

Represents a service that manages search queries to shards of the search network.

Constructor Summary

Constructors

Constructor and Description
Searcher()

Method Summary

Modifier and Type	Method and Description
abstract void	getDocumentText(NetworkDocumentInfo documentInfo, OutputAdapter adapter) Generates the text of an indexed document and passes it through an output adapter.
abstract NetworkDocumentInfo[]	getIndexedDocumentItems(NetworkDocumentInfo documentInfo) Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).
abstract NetworkDocumentInfo[]	getIndexedDocuments(int shardIndex) Gets an array of all indexed documents.
abstract void	highlight(NetworkFoundDocument document, Highlighter highlighter, HighlightOptions options) Generates HTML formatted text with highlighted found terms.
abstract NetworkImageSearchResult	searchFirst(SearchImage image, ImageSearchOptions options) Performs a reverse image search in the distributed search index.
abstract NetworkSearchResult	searchFirst(SearchQuery query, SearchOptions options) Starts a search in the distributed search index.
abstract NetworkSearchResult	searchFirst(String query, SearchOptions options) Starts a search with a query in text form in the distributed search index.
abstract NetworkImageSearchResult	searchNext(NetworkImageSearchToken networkImageSearchToken) Continues a reverse image search in the distributed search index.
abstract NetworkSearchResult	searchNext(NetworkSearchToken networkSearchToken) Continues a search in the distributed search index.

Methods inherited from class java.lang.Object

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

Constructor Detail

Searcher

public Searcher()

Method Detail

getDocumentText

public abstract void getDocumentText(NetworkDocumentInfo documentInfo,
                                     OutputAdapter adapter)

Generates the text of an indexed document and passes it through an output adapter.

Parameters:

documentInfo - The indexed document info.

adapter - The output adapter.

getIndexedDocumentItems

public abstract NetworkDocumentInfo[] getIndexedDocumentItems(NetworkDocumentInfo documentInfo)

Gets an array of nested items of the specified document (for container documents such as ZIP, OST, PST).

Parameters:

documentInfo - The document info.

Returns:

An array of a document items.

getIndexedDocuments

public abstract NetworkDocumentInfo[] getIndexedDocuments(int shardIndex)

Gets an array of all indexed documents.

Parameters:

shardIndex - The shard index.

Returns:

An array of all indexed documents.

highlight

public abstract void highlight(NetworkFoundDocument document,
                               Highlighter highlighter,
                               HighlightOptions options)

Generates HTML formatted text with highlighted found terms.

Parameters:

document - The found document.

highlighter - The search result highlighter.

options - The highlight options.

searchFirst

public abstract NetworkImageSearchResult searchFirst(SearchImage image,
                                                     ImageSearchOptions options)

Performs a reverse image search in the distributed search index.

Parameters:

image - The image to search.

options - The image search options.

Returns:

The reverse image search result.

searchFirst

public abstract NetworkSearchResult searchFirst(SearchQuery query,
                                                SearchOptions options)

Starts a search in the distributed search index.

Parameters:

query - The search query.

options - The search options.

Returns:

The search result.

searchFirst

public abstract NetworkSearchResult searchFirst(String query,
                                                SearchOptions options)

Starts a search with a query in text form in the distributed search index.

Parameters:

query - The search query.

options - The search options.

Returns:

The search result.

searchNext

public abstract NetworkImageSearchResult searchNext(NetworkImageSearchToken networkImageSearchToken)

Continues a reverse image search in the distributed search index.

Parameters:

networkImageSearchToken - The network image search token.

Returns:

The reverse image search result.

searchNext

public abstract NetworkSearchResult searchNext(NetworkSearchToken networkSearchToken)

Continues a search in the distributed search index.

Parameters:

networkSearchToken - The network search token.

Returns:

The search result.