com.exalead.searchapi.xmlv10.client

Interface SearchClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

public interface SearchClient
extends java.io.Closeable

Component used to send queries to an Exalead CloudView search api and format the response in different formats.

This component is thread safe, and compatible with:

• Exalead CloudView 4.6
• Exalead CloudView 5.1
• Exalead CloudView 6.0

Some specific features might not be available on some versions of the CloudView product. Please refer to the detailed documentation for more information. The instantiation of the client is done via the SearchClientFactory

Method Summary

Modifier and Type	Method and Description
SearchAnswer	getResults(SearchQuery query) Get the response to a search query
org.w3c.dom.Document	getResultsAsDocument(SearchQuery query) Get the XML response of the HTTP search-api as a DOM document.
com.exalead.search.v10.Answer	getResultsAsObject(SearchQuery query) Deprecated. Use getResultsAsSimplifiedObject(SearchQuery)
SearchAnswer	getResultsAsSimplifiedObject(SearchQuery query) Deprecated. Use getResults(SearchQuery)
java.io.InputStream	getResultsAsStream(SearchQuery query) Get the search-api HTTP response as a raw InputStream.
java.lang.String	getResultsAsString(SearchQuery query) Deprecated.
SearchQuery	newSearchQuery() Build a new search query to send to the search-api.

Methods inherited from interface java.io.Closeable

close

Method Detail

getResults

SearchAnswer getResults(SearchQuery query)
                 throws SearchClientException

Get the response to a search query

Throws:

SearchClientException

getResultsAsStream

java.io.InputStream getResultsAsStream(SearchQuery query)
                                throws SearchClientException

Get the search-api HTTP response as a raw InputStream.

Throws:

SearchClientException

getResultsAsString

@Deprecated
java.lang.String getResultsAsString(SearchQuery query)
                                         throws SearchClientException

Deprecated.

Get the search-api HTTP response as a String, read from the raw InputStream. Usage is discouraged.

Throws:

SearchClientException

getResultsAsDocument

org.w3c.dom.Document getResultsAsDocument(SearchQuery query)
                                   throws SearchClientException

Get the XML response of the HTTP search-api as a DOM document.

Throws:

SearchClientException

getResultsAsObject

@Deprecated
com.exalead.search.v10.Answer getResultsAsObject(SearchQuery query)
                                                      throws SearchClientException

Deprecated. Use getResultsAsSimplifiedObject(SearchQuery)

Get the response of the HTTP search-api as a legacy XMLv10 Java object, converted using JAXB.

Throws:

SearchClientException

getResultsAsSimplifiedObject

@Deprecated
SearchAnswer getResultsAsSimplifiedObject(SearchQuery query)
                                               throws SearchClientException

Deprecated. Use getResults(SearchQuery)

Get the response of the search-api as a structured object.

Throws:

SearchClientException

newSearchQuery

SearchQuery newSearchQuery()

Build a new search query to send to the search-api.