org.gcube.socialnetworking.social_data_search_client

Interface ElasticSearchClient

All Known Implementing Classes:

ElasticSearchClientImpl

public interface ElasticSearchClient

The ElasticSearchClient client interface to search in social data.

Author:

Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)

Method Summary

Modifier and Type	Method and Description
boolean	deleteDocument(String docID) Delete from the index a document with id docID.
List<org.gcube.portal.databook.shared.EnhancedFeed>	search(String query, Set<String> vreIDS, int from, int quantity) Given a query, the method find matching enhanced feeds into the elasticsearch index and return at most quantity hits starting from from.
List<org.gcube.portal.databook.shared.EnhancedFeed>	searchInField(String query, Set<String> vreIDS, int from, int quantity, org.gcube.socialnetworking.social_data_indexing_common.utils.SearchableFields field) Given a query, the method find matching enhanced feeds into the elasticsearch index and return at most quantity hits starting from from.

Method Detail

search

List<org.gcube.portal.databook.shared.EnhancedFeed> search(String query,
                                                           Set<String> vreIDS,
                                                           int from,
                                                           int quantity)

Given a query, the method find matching enhanced feeds into the elasticsearch index and return at most quantity hits starting from from. A multimatch query is performed against all searchable fields.

Parameters:

query - the query to match

vreIDS - specifies the vre(s) to which the returning feeds must belong

from - start hits index

quantity - max number of hits to return starting from from

Returns:

A list of matching enhanced feeds or nothing

searchInField

List<org.gcube.portal.databook.shared.EnhancedFeed> searchInField(String query,
                                                                  Set<String> vreIDS,
                                                                  int from,
                                                                  int quantity,
                                                                  org.gcube.socialnetworking.social_data_indexing_common.utils.SearchableFields field)

Given a query, the method find matching enhanced feeds into the elasticsearch index and return at most quantity hits starting from from. The query is performed against one of the searchable fields.

Parameters:

query - the query to match

vreIDS - specifies the vre(s) to which the returning feeds must belong

from - start hits index

quantity - max number of hits to return starting from from

field - the field against which the query is performed

Returns:

A list of matching enhanced feeds or nothing

deleteDocument

boolean deleteDocument(String docID)

Delete from the index a document with id docID.

Parameters:

docID - the id of the doc to delete

Returns:

true on success, false otherwise