Package com.exalead.searchapi.xmlv10.client

CloudView Search API Client

See: Description

Interface Summary

Interface	Description
AggregationFunction	The AggregationFunction class is used to manipulate aggregation function results.
Category	The Category is the main component of the navigation.
CategoryGroup	Top level component of the category tree which holds a list of categories for a given facet.
Hit	Holds the informations related to a search result.
Meta	Holds a metadata item which can multivalued and typed
MetaValue	Holds of the value of metadata item which can highlighted or not
RelatedTerm	The RelatedTerm is a component used for the navigation.
SearchAnswer	Answer of a search on the search-api.
SearchClient	Component used to send queries to an Exalead CloudView search api and format the response in different formats.
SliceInfo
SpellCheckSuggestion	Spelling suggestion
SpellCheckSuggestion.SpellCheckSubStringSuggestion
SuggestAnswer	Answer of a suggest command.
SuggestDispatcherAnswer
SuggestEntry	Part of an answer of a suggest command.
SuggestEntryExtraInformation
SuggestPrefixHandler
SuggestPrefixHandlerAnswer
SuggestPrefixHandlerEntry
SynthesisAggregationFunction
SynthesisCategory
SynthesisCategoryGroup
SynthesisCategoryGroupInfo
Text	Common interface for TextSeg and TextCut that are used for highlighted metadata item values
TextCut	Represents a text cut.
TextSeg	Represents a text segment which can be highlighted or not.
Topic	Something on which it is possible to refine.

Class Summary

Class	Description
AbstractParameter
AbstractParametersContainer<P extends AbstractParameter>
AbstractQuery<T extends AbstractQuery,P extends AbstractParameter>
ArgUtils
Category.CategoryAlphanumComparator
Category.CategoryCountComparator
Category.CategoryNumComparator
Category.CategoryReducer
Category.CategoryScoreComparator
CategoryGroupInfo
HitMeta
Merger<T>
ParametersContainer	Internal container used to store the parameters of a SearchQuery.
ParseUtils	Utilities to parse and generate SearchAPI strings.
ParseUtils.KVMap	Wrapper around map with getter utilities
SearchClientFactory	Factory used to obtain a SearchClient instance which is the main component of the Search API Client See SearchClient for more information.
SearchParameter
SearchQuery	SearchQuery holds the different search settings that are used to configure your search.
SearchQueryFactory	Factory used to obtain a SearchQuery instance Usage is discouraged.
ServerInfos	Configuration class for a connection to the Search API server.

Enum Summary

Enum	Description
AggregationFunction.ValueType
Hit.InfoKey
Meta.MetaType
SearchAPIVersion
SearchClientRemoteException.RemoteExceptionType
SynthesisAggregationFunction.ValueType
SynthesisCategory.State
Topic.State

Exception Summary

Exception	Description
SearchClientException	Any exception while performing a search.
SearchClientRemoteException	Exception which originally happened on the server side while performing a search

Package com.exalead.searchapi.xmlv10.client Description

CloudView Search API Client

The Search API Client entry point is the SearchClient component which is obtained via the SearchClientFactory.

Ex:

 SearchClient searchClient;
 try {
     searchClient = SearchClientFactory.createSearchClient("http://localhost:10010/search-api/search",
     SearchAPIVersion.XMLV10_50);
 }
 catch (MalformedURLException e1) {
     throw new Error("Malformed url", e1);
 }
 

Then you can set up a SearchQuery:

 SearchQuery query = new SearchQuery("test");
 query.setResultsSetLength(5);
 query.setResultsSetStart(10);
 

And execute the search using the SearchClient:

 SearchAnswer answer = searchClient.getResultsAsSimplifiedObject(query);
 

(See the SearchClient for more details about the different formats that can be returned)
Then navigate through your results:

 for(Hit hit:answer.getHits()){
  //use your results
 }
 

See SearchClient See SearchClientFactory See SearchQuery