com.algolia.search.saas

Class Searchable

Object

com.algolia.search.saas.Searchable

Direct Known Subclasses:

Index

public abstract class Searchable
extends Object

A searchable source of data

Constructor Summary

Constructors

Constructor and Description
Searchable()

Method Summary

Modifier and Type	Method and Description
Request	searchAsync(Query query, CompletionHandler completionHandler) Search inside this index (asynchronously).
abstract Request	searchAsync(Query query, RequestOptions requestOptions, CompletionHandler completionHandler) Search inside this index (asynchronously).
Request	searchDisjunctiveFacetingAsync(Query query, Collection<String> disjunctiveFacets, Map<String,? extends Collection<String>> refinements, RequestOptions requestOptions, CompletionHandler completionHandler) Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).
Request	searchForFacetValuesAsync(String facetName, String facetText, Query query, RequestOptions requestOptions, CompletionHandler handler) Search for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.
String	toString() If you override this please be sure it returns a unique string per instance

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Searchable

public Searchable()

Method Detail

searchAsync

public abstract Request searchAsync(@Nullable
                                    Query query,
                                    @Nullable
                                    RequestOptions requestOptions,
                                    @Nullable
                                    CompletionHandler completionHandler)

Search inside this index (asynchronously).

Parameters:

query - Search parameters. May be null to use an empty query.

requestOptions - Request-specific options.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

searchAsync

public Request searchAsync(@Nullable
                           Query query,
                           @Nullable
                           CompletionHandler completionHandler)

Search inside this index (asynchronously).

Parameters:

query - Search parameters. May be null to use an empty query.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

searchDisjunctiveFacetingAsync

public Request searchDisjunctiveFacetingAsync(@NonNull
                                              Query query,
                                              @NonNull
                                              Collection<String> disjunctiveFacets,
                                              @NonNull
                                              Map<String,? extends Collection<String>> refinements,
                                              @Nullable
                                              RequestOptions requestOptions,
                                              @NonNull
                                              CompletionHandler completionHandler)

Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).

Parameters:

query - The query.

disjunctiveFacets - List of disjunctive facets.

refinements - The current refinements, mapping facet names to a list of values.

requestOptions - Request-specific options.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

searchForFacetValuesAsync

public Request searchForFacetValuesAsync(@NonNull
                                         String facetName,
                                         @NonNull
                                         String facetText,
                                         @Nullable
                                         Query query,
                                         @Nullable
                                         RequestOptions requestOptions,
                                         @NonNull
                                         CompletionHandler handler)

Search for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.

Parameters:

facetName - The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.

facetText - The text to search for in the facet's values.

query - An optional query to take extra search parameters into account. There parameters apply to index objects like in a regular search query. Only facet values contained in the matched objects will be returned

requestOptions - Request-specific options.

handler - A Completion handler that will be notified of the request's outcome.

Returns:

A cancellable request.

toString

public String toString()

If you override this please be sure it returns a unique string per instance

Overrides:

toString in class Object

Returns: