org.gcube.rest.index.client

Class IndexClient

java.lang.Object

org.gcube.rest.index.client.IndexClient

public class IndexClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexClient.Builder

Constructor Summary

Constructors

Constructor and Description
IndexClient(IndexClient.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	activateIndex(String indexName)
List<org.gcube.rest.index.common.entities.ClusterResponse>	clustering(String queryString, String queryHint)
List<org.gcube.rest.index.common.entities.ClusterResponse>	clustering(String queryString, String queryHint, Set<String> sids, Integer numberOfClusters, String urlField, List<String> titleFields, List<String> contentFields, List<String> languageFields)
List<org.gcube.rest.index.common.entities.ClusterResponse>	clustering(String queryString, String queryHint, Set<String> sids, Integer numberOfClusters, String urlField, List<String> titleFields, List<String> contentFields, List<String> languageFields, String algorithm, Integer searchHits)
Integer	collectionCount(String collectionID)
Set<String>	collectionsOfIndex(String indexName)
Boolean	deactivateIndex(String indexName)
Boolean	deleteDocuments(List<String> documentIDs)
Boolean	deleteIndex(String indexName)
Boolean	destroy()
Boolean	destroyCluster()
boolean	feedLocator(String resultSetLocation, String indexName, Boolean activate, Set<String> sids)
boolean	feedLocatorSync(String resultSetLocation, String indexName, Boolean activate, Set<String> sids)
boolean	flush()
Map<String,Integer>	frequentTerms(String queryString, Set<String> sids)
Map<String,Integer>	frequentTerms(String queryString, Set<String> sids, Boolean useRR)
Map<String,Integer>	frequentTerms(String queryString, Set<String> sids, Integer maxTerms, Boolean useRR)
String	getClusterID()
String	getEndpoint()
String	getIndexID()
String	getResourceID()
String	getScope()
Set<String>	indicesOfCollection(String collectionID)
String	query(String queryString, Set<String> sids)
String	query(String queryString, Set<String> sids, Boolean useRR)
String	query(String queryString, Set<String> sids, Integer from, Integer count)
String	query(String queryString, Set<String> sids, Integer from, Integer count, Boolean useRR)
List<Map<String,String>>	queryAndRead(String queryString, Set<String> sids)
List<Map<String,String>>	queryAndRead(String queryString, Set<String> sids, Boolean useRR)
List<Map<String,String>>	queryAndRead(String queryString, Set<String> sids, Integer from, Integer count)
List<Map<String,String>>	queryAndRead(String queryString, Set<String> sids, Integer from, Integer count, Boolean useRR)
List<Map<String,String>>	queryAndReadClientSide(String queryString, Set<String> sids)
List<Map<String,String>>	queryAndReadClientSide(String queryString, Set<String> sids, Boolean useRR)
List<Map<String,String>>	queryAndReadClientSide(String queryString, Set<String> sids, Integer from, Integer count)
List<Map<String,String>>	queryAndReadClientSide(String queryString, Set<String> sids, Integer from, Integer count, Boolean useRR)
Boolean	rebuildMetaIndex()
Boolean	refresh()
Boolean	setCollectionsAndFields(List<String> collections, List<String> fields)
Boolean	shutdown(Boolean delete)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexClient

public IndexClient(IndexClient.Builder builder)
            throws IndexException

Throws:

IndexException

Method Detail

getEndpoint

public String getEndpoint()

getResourceID

public String getResourceID()

getScope

public String getScope()

getClusterID

public String getClusterID()

getIndexID

public String getIndexID()

feedLocator

public boolean feedLocator(String resultSetLocation,
                  String indexName,
                  Boolean activate,
                  Set<String> sids)
                    throws IndexException

Throws:

IndexException

feedLocatorSync

public boolean feedLocatorSync(String resultSetLocation,
                      String indexName,
                      Boolean activate,
                      Set<String> sids)
                        throws IndexException

Throws:

IndexException

flush

public boolean flush()
              throws IndexException

Throws:

IndexException

clustering

public List<org.gcube.rest.index.common.entities.ClusterResponse> clustering(String queryString,
                                                                    String queryHint)
                                                                      throws IndexException

Throws:

IndexException

clustering

public List<org.gcube.rest.index.common.entities.ClusterResponse> clustering(String queryString,
                                                                    String queryHint,
                                                                    Set<String> sids,
                                                                    Integer numberOfClusters,
                                                                    String urlField,
                                                                    List<String> titleFields,
                                                                    List<String> contentFields,
                                                                    List<String> languageFields)
                                                                      throws IndexException

Throws:

IndexException

clustering

public List<org.gcube.rest.index.common.entities.ClusterResponse> clustering(String queryString,
                                                                    String queryHint,
                                                                    Set<String> sids,
                                                                    Integer numberOfClusters,
                                                                    String urlField,
                                                                    List<String> titleFields,
                                                                    List<String> contentFields,
                                                                    List<String> languageFields,
                                                                    String algorithm,
                                                                    Integer searchHits)
                                                                      throws IndexException

Throws:

IndexException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Set<String> sids)
                                  throws IndexException

Throws:

IndexException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Set<String> sids,
                                Boolean useRR)
                                  throws IndexException

Throws:

IndexException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Set<String> sids,
                                Integer maxTerms,
                                Boolean useRR)
                                  throws IndexException

Throws:

IndexException

query

public String query(String queryString,
           Set<String> sids)
             throws IndexException

Throws:

IndexException

query

public String query(String queryString,
           Set<String> sids,
           Boolean useRR)
             throws IndexException

Throws:

IndexException

query

public String query(String queryString,
           Set<String> sids,
           Integer from,
           Integer count)
             throws IndexException

Throws:

IndexException

query

public String query(String queryString,
           Set<String> sids,
           Integer from,
           Integer count,
           Boolean useRR)
             throws IndexException

Throws:

IndexException

queryAndReadClientSide

public List<Map<String,String>> queryAndReadClientSide(String queryString,
                                              Set<String> sids)
                                                throws IndexException

Throws:

IndexException

queryAndReadClientSide

public List<Map<String,String>> queryAndReadClientSide(String queryString,
                                              Set<String> sids,
                                              Boolean useRR)
                                                throws IndexException

Throws:

IndexException

queryAndReadClientSide

public List<Map<String,String>> queryAndReadClientSide(String queryString,
                                              Set<String> sids,
                                              Integer from,
                                              Integer count)
                                                throws IndexException

Throws:

IndexException

queryAndReadClientSide

public List<Map<String,String>> queryAndReadClientSide(String queryString,
                                              Set<String> sids,
                                              Integer from,
                                              Integer count,
                                              Boolean useRR)
                                                throws IndexException

Throws:

IndexException

queryAndRead

public List<Map<String,String>> queryAndRead(String queryString,
                                    Set<String> sids,
                                    Boolean useRR)
                                      throws IndexException

Throws:

IndexException

queryAndRead

public List<Map<String,String>> queryAndRead(String queryString,
                                    Set<String> sids)
                                      throws IndexException

Throws:

IndexException

queryAndRead

public List<Map<String,String>> queryAndRead(String queryString,
                                    Set<String> sids,
                                    Integer from,
                                    Integer count)
                                      throws IndexException

Throws:

IndexException

queryAndRead

public List<Map<String,String>> queryAndRead(String queryString,
                                    Set<String> sids,
                                    Integer from,
                                    Integer count,
                                    Boolean useRR)
                                      throws IndexException

Throws:

IndexException

refresh

public Boolean refresh()
                throws IndexException

Throws:

IndexException

setCollectionsAndFields

public Boolean setCollectionsAndFields(List<String> collections,
                              List<String> fields)
                                throws IndexException

Throws:

IndexException

shutdown

public Boolean shutdown(Boolean delete)
                 throws IndexException

Throws:

IndexException

destroyCluster

public Boolean destroyCluster()
                       throws IndexException

Throws:

IndexException

destroy

public Boolean destroy()
                throws IndexException

Throws:

IndexException

rebuildMetaIndex

public Boolean rebuildMetaIndex()
                         throws IndexException

Throws:

IndexException

deleteIndex

public Boolean deleteIndex(String indexName)
                    throws IndexException

Throws:

IndexException

deleteDocuments

public Boolean deleteDocuments(List<String> documentIDs)
                        throws IndexException

Throws:

IndexException

collectionsOfIndex

public Set<String> collectionsOfIndex(String indexName)
                               throws IndexException

Throws:

IndexException

indicesOfCollection

public Set<String> indicesOfCollection(String collectionID)
                                throws IndexException

Throws:

IndexException

collectionCount

public Integer collectionCount(String collectionID)
                        throws IndexException

Throws:

IndexException

activateIndex

public Boolean activateIndex(String indexName)
                      throws IndexException

Throws:

IndexException

deactivateIndex

public Boolean deactivateIndex(String indexName)
                        throws IndexException

Throws:

IndexException