org.gcube.elasticsearch

Class FullTextNode

java.lang.Object

org.gcube.elasticsearch.FullTextNode

All Implemented Interfaces:

Serializable

public class FullTextNode
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_INDEX
static String	DEFAULT_ANALYZER
static String	DEFAULT_INDEXNAME
static String	DEFAULT_INDEXSTORE
static String	INDEX_PREFIX
static String	KEYWORD_ANALYZER
static String	META_INDEX
static String	TEMP_PREFIX

Constructor Summary

Constructors

Constructor and Description
FullTextNode(String hostname)
FullTextNode(String hostname, Boolean useRRAdaptor)
FullTextNode(String hostname, String clusterName, String indexName, Integer noOfReplicas, Integer noOfShards, String scope, Integer maxFragmentCnt, Integer maxFragmentSize)
FullTextNode(String hostname, String clusterName, String indexName, Integer noOfReplicas, Integer noOfShards, String scope, Integer maxFragmentCnt, Integer maxFragmentSize, Boolean useRRAdaptor)
FullTextNode(String hostname, String clusterName, String indexName, String scope)
FullTextNode(String hostname, String clusterName, String indexName, String scope, Boolean useRRAdaptor)
FullTextNode(String hostname, String dataDir, String clusterName, String indexName, Integer noOfReplicas, Integer noOfShards, String scope, Integer maxFragmentCnt, Integer maxFragmentSize)
FullTextNode(String hostname, String dataDir, String clusterName, String indexName, Integer noOfReplicas, Integer noOfShards, String scope, Integer maxFragmentCnt, Integer maxFragmentSize, Boolean useRRAdaptor)
FullTextNode(String hostname, String dataDir, String clusterName, String indexName, String scope)
FullTextNode(String hostname, String dataDir, String clusterName, String indexName, String scope, Boolean useRRAdaptor)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activateIndex(String indexName)
static void	addFile(org.elasticsearch.client.Client indexClient, String base64, String indexName, String indexType)
void	addFile(String base64)
void	addIndexType(String indexTypeStr, org.gcube.indexmanagement.common.FullTextIndexType indexType, String indexName)
void	addIndexType(String indexTypeStr, String indexName)
boolean	addMetaIndex()
void	clearIndex(String indexTypeName)
void	close() Closes the index
List<ClusterResponse>	cluster(String query, String queryHint, Integer numberOfClusters, String urlField, List<String> titleFields, List<String> contentFields, List<String> languageFields, Set<String> sids, String algorithm, Integer searchHits)
void	commit()
void	commit(String indexName)
void	commitMeta() Commits the changes to the index by sending a flush and a refresh request
Boolean	createFileIndex()
static Boolean	createFileIndex(org.elasticsearch.client.Client indexClient, String indexName, String indexType, org.elasticsearch.common.settings.Settings settings)
void	createOrJoinCluster()
boolean	deactivateIndex(String indexName)
boolean	deleteAll()
Boolean	deleteCollection(String collID) Deletes the documents of the collection with ID collID
void	deleteDocuments(List<String> docIDs) Deletes the documents with IDs within the list docIDs
boolean	deleteIndex() Deletes the index and the metaIndex
boolean	deleteIndex(String indexName) Deletes the index and the metaIndex
boolean	deleteMeta()
Boolean	feedLocator(String resultSetLocation, HashMap<String,org.gcube.indexmanagement.common.FullTextIndexType> colForField, Set<String> securityIdentifiers)
Boolean	feedLocator(String resultSetLocation, HashMap<String,org.gcube.indexmanagement.common.FullTextIndexType> colForField, String indexName, Set<String> securityIdentifiers) Feeds the index with rowsets that are read from the the given locator
boolean	feedLocator(String resultSetLocation, Set<String> securityIdentifiers)
boolean	feedLocator(String resultSetLocation, String indexName, Set<String> securityIdentifiers)
boolean	feedRowset(String rowset, String indexName, Set<String> securityIdentifiers) Feeds the index with a rowset.
Map<String,Integer>	frequentTerms(String queryString, Integer maxTerms, Set<String> securityIdentifiers)
Map<String,Integer>	frequentTerms(String queryString, Integer maxTerms, Set<String> securityIdentifiers, Boolean useRR)
Map<String,Integer>	frequentTerms(String queryString, Set<String> securityIdentifiers)
Map<String,Integer>	frequentTerms(String queryString, Set<String> securityIdentifiers, Boolean useRR)
String	getClusterName()
Long	getCollectionDocuments(String collectionID)
List<String>	getCollectionOfIndex()
Map<String,List<String>>	getCollectionsAndFieldsOfIndex()
Set<String>	getCollectionsOfIndex(String indexName)
String	getESTransportAddress()
List<String>	getFieldsOfIndex()
String	getHostname()
org.elasticsearch.client.Client	getIndexClient()
String	getIndexName()
Set<String>	getIndicesOfCollection(String collection)
Integer	getMaxFragmentCnt()
Integer	getMaxFragmentSize()
Integer	getNoOfReplicas()
Integer	getNoOfShards()
String	getScope()
void	invalidateCache()
void	joinCluster(List<String> hosts)
void	listAlgorithms()
String	query(String queryString, Integer from, Integer maxHits, Set<String> securityIdentifiers) Executes the query of gRS2 locator of maximum maxHits records (if >0)
String	query(String queryString, Integer from, Integer maxHits, Set<String> securityIdentifiers, Boolean useRR)
String	query(String queryString, Set<String> securityIdentifiers)
String	query(String queryString, Set<String> securityIdentifiers, Boolean useRR)
String	queryStream(String queryString, int maxHits, Set<String> securityIdentifiers) Important: The returned results are not sorted!
String	queryStream(String queryString, Set<String> securityIdentifiers)
boolean	rebuildMetaIndex(List<String> collectionIds, List<String> fields)
void	refreshIndexTypesOfIndex() Refreshes the index types
void	setMaxResults(Integer maxResults)
String	toString()
boolean	updateManagerProperties(HashMap<String,org.gcube.indexmanagement.common.FullTextIndexType> colForIdTypes)
boolean	updateManagerPropertiesRemoveCollID(String collectionID)

Methods inherited from class java.lang.Object

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

Field Detail

META_INDEX

public static String META_INDEX

TEMP_PREFIX

public static String TEMP_PREFIX

INDEX_PREFIX

public static String INDEX_PREFIX

ACTIVE_INDEX

public static String ACTIVE_INDEX

DEFAULT_INDEXNAME

public static String DEFAULT_INDEXNAME

DEFAULT_INDEXSTORE

public static String DEFAULT_INDEXSTORE

DEFAULT_ANALYZER

public static String DEFAULT_ANALYZER

KEYWORD_ANALYZER

public static String KEYWORD_ANALYZER

Constructor Detail

FullTextNode

public FullTextNode(String hostname)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            Boolean useRRAdaptor)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String clusterName,
            String indexName,
            Integer noOfReplicas,
            Integer noOfShards,
            String scope,
            Integer maxFragmentCnt,
            Integer maxFragmentSize,
            Boolean useRRAdaptor)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String clusterName,
            String indexName,
            Integer noOfReplicas,
            Integer noOfShards,
            String scope,
            Integer maxFragmentCnt,
            Integer maxFragmentSize)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String clusterName,
            String indexName,
            String scope,
            Boolean useRRAdaptor)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String clusterName,
            String indexName,
            String scope)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String dataDir,
            String clusterName,
            String indexName,
            Integer noOfReplicas,
            Integer noOfShards,
            String scope,
            Integer maxFragmentCnt,
            Integer maxFragmentSize,
            Boolean useRRAdaptor)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String dataDir,
            String clusterName,
            String indexName,
            Integer noOfReplicas,
            Integer noOfShards,
            String scope,
            Integer maxFragmentCnt,
            Integer maxFragmentSize)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String dataDir,
            String clusterName,
            String indexName,
            String scope,
            Boolean useRRAdaptor)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

FullTextNode

public FullTextNode(String hostname,
            String dataDir,
            String clusterName,
            String indexName,
            String scope)
             throws gr.uoa.di.madgik.rr.ResourceRegistryException,
                    InterruptedException

Throws:

gr.uoa.di.madgik.rr.ResourceRegistryException

InterruptedException

Method Detail

getClusterName

public String getClusterName()

getIndexName

public String getIndexName()

getNoOfReplicas

public Integer getNoOfReplicas()

getNoOfShards

public Integer getNoOfShards()

getScope

public String getScope()

getHostname

public String getHostname()

getMaxFragmentCnt

public Integer getMaxFragmentCnt()

getMaxFragmentSize

public Integer getMaxFragmentSize()

getIndexClient

public org.elasticsearch.client.Client getIndexClient()

setMaxResults

public void setMaxResults(Integer maxResults)

toString

public String toString()

Overrides:

toString in class Object

addIndexType

public void addIndexType(String indexTypeStr,
                String indexName)
                  throws Exception

Throws:

Exception

addIndexType

public void addIndexType(String indexTypeStr,
                org.gcube.indexmanagement.common.FullTextIndexType indexType,
                String indexName)
                  throws Exception

Throws:

Exception

createOrJoinCluster

public void createOrJoinCluster()

getESTransportAddress

public String getESTransportAddress()

joinCluster

public void joinCluster(List<String> hosts)
                 throws IOException

Parameters:

knownNodes - list of hostname:port

Throws:

IOException

query

public String query(String queryString,
           Set<String> securityIdentifiers)
             throws org.gcube.indexmanagement.common.IndexException,
                    gr.uoa.di.madgik.grs.writer.GRS2WriterException

Parameters:

queryString -

Returns:

gRS2 locator of the query results

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

query

public String query(String queryString,
           Set<String> securityIdentifiers,
           Boolean useRR)
             throws org.gcube.indexmanagement.common.IndexException,
                    gr.uoa.di.madgik.grs.writer.GRS2WriterException

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

query

public String query(String queryString,
           Integer from,
           Integer maxHits,
           Set<String> securityIdentifiers)
             throws gr.uoa.di.madgik.grs.writer.GRS2WriterException,
                    org.gcube.indexmanagement.common.IndexException

Executes the query of gRS2 locator of maximum maxHits records (if >0)

Parameters:

queryString -

maxHits -

Returns:

gRS2 locator of the results

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

query

public String query(String queryString,
           Integer from,
           Integer maxHits,
           Set<String> securityIdentifiers,
           Boolean useRR)
             throws gr.uoa.di.madgik.grs.writer.GRS2WriterException,
                    org.gcube.indexmanagement.common.IndexException

Throws:

gr.uoa.di.madgik.grs.writer.GRS2WriterException

org.gcube.indexmanagement.common.IndexException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Set<String> securityIdentifiers)
                                  throws org.gcube.indexmanagement.common.IndexException,
                                         gr.uoa.di.madgik.grs.writer.GRS2WriterException

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Set<String> securityIdentifiers,
                                Boolean useRR)
                                  throws org.gcube.indexmanagement.common.IndexException,
                                         gr.uoa.di.madgik.grs.writer.GRS2WriterException

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Integer maxTerms,
                                Set<String> securityIdentifiers)
                                  throws gr.uoa.di.madgik.grs.writer.GRS2WriterException,
                                         org.gcube.indexmanagement.common.IndexException

Throws:

gr.uoa.di.madgik.grs.writer.GRS2WriterException

org.gcube.indexmanagement.common.IndexException

frequentTerms

public Map<String,Integer> frequentTerms(String queryString,
                                Integer maxTerms,
                                Set<String> securityIdentifiers,
                                Boolean useRR)
                                  throws gr.uoa.di.madgik.grs.writer.GRS2WriterException,
                                         org.gcube.indexmanagement.common.IndexException

Throws:

gr.uoa.di.madgik.grs.writer.GRS2WriterException

org.gcube.indexmanagement.common.IndexException

queryStream

public String queryStream(String queryString,
                 Set<String> securityIdentifiers)
                   throws org.gcube.indexmanagement.common.IndexException,
                          gr.uoa.di.madgik.grs.writer.GRS2WriterException

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

queryStream

public String queryStream(String queryString,
                 int maxHits,
                 Set<String> securityIdentifiers)
                   throws org.gcube.indexmanagement.common.IndexException,
                          gr.uoa.di.madgik.grs.writer.GRS2WriterException

Important: The returned results are not sorted!

Parameters:

queryString -

Returns:

gRS2 locator of the results

Throws:

org.gcube.indexmanagement.common.IndexException

gr.uoa.di.madgik.grs.writer.GRS2WriterException

activateIndex

public boolean activateIndex(String indexName)

deactivateIndex

public boolean deactivateIndex(String indexName)

deleteIndex

public boolean deleteIndex()

Deletes the index and the metaIndex

deleteMeta

public boolean deleteMeta()

deleteAll

public boolean deleteAll()

getCollectionsOfIndex

public Set<String> getCollectionsOfIndex(String indexName)

getCollectionDocuments

public Long getCollectionDocuments(String collectionID)

getIndicesOfCollection

public Set<String> getIndicesOfCollection(String collection)

deleteIndex

public boolean deleteIndex(String indexName)

Deletes the index and the metaIndex

deleteDocuments

public void deleteDocuments(List<String> docIDs)

Deletes the documents with IDs within the list docIDs

Parameters:

docIDs -

deleteCollection

public Boolean deleteCollection(String collID)

Deletes the documents of the collection with ID collID

Parameters:

collID -

commitMeta

public void commitMeta()

Commits the changes to the index by sending a flush and a refresh request

commit

public void commit()

commit

public void commit(String indexName)

clearIndex

public void clearIndex(String indexTypeName)

close

public void close()

Closes the index

feedRowset

public boolean feedRowset(String rowset,
                 String indexName,
                 Set<String> securityIdentifiers)

Feeds the index with a rowset.

Parameters:

rowset -

Returns:

True on success or False on failure

feedLocator

public boolean feedLocator(String resultSetLocation,
                  String indexName,
                  Set<String> securityIdentifiers)
                    throws gr.uoa.di.madgik.grs.reader.GRS2ReaderException,
                           URISyntaxException,
                           gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException,
                           gr.uoa.di.madgik.grs.buffer.GRS2BufferException

Throws:

gr.uoa.di.madgik.grs.reader.GRS2ReaderException

URISyntaxException

gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException

gr.uoa.di.madgik.grs.buffer.GRS2BufferException

feedLocator

public boolean feedLocator(String resultSetLocation,
                  Set<String> securityIdentifiers)
                    throws gr.uoa.di.madgik.grs.reader.GRS2ReaderException,
                           URISyntaxException,
                           gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException,
                           gr.uoa.di.madgik.grs.buffer.GRS2BufferException

Throws:

gr.uoa.di.madgik.grs.reader.GRS2ReaderException

URISyntaxException

gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException

gr.uoa.di.madgik.grs.buffer.GRS2BufferException

feedLocator

public Boolean feedLocator(String resultSetLocation,
                  HashMap<String,org.gcube.indexmanagement.common.FullTextIndexType> colForField,
                  Set<String> securityIdentifiers)
                    throws gr.uoa.di.madgik.grs.reader.GRS2ReaderException,
                           URISyntaxException,
                           gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException,
                           gr.uoa.di.madgik.grs.buffer.GRS2BufferException

Throws:

gr.uoa.di.madgik.grs.reader.GRS2ReaderException

URISyntaxException

gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException

gr.uoa.di.madgik.grs.buffer.GRS2BufferException

feedLocator

public Boolean feedLocator(String resultSetLocation,
                  HashMap<String,org.gcube.indexmanagement.common.FullTextIndexType> colForField,
                  String indexName,
                  Set<String> securityIdentifiers)
                    throws gr.uoa.di.madgik.grs.reader.GRS2ReaderException,
                           URISyntaxException,
                           gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException,
                           gr.uoa.di.madgik.grs.buffer.GRS2BufferException

Feeds the index with rowsets that are read from the the given locator

Parameters:

resultSetLocation -

colForField -

Returns:

true if feed was successful, otherwise false

Throws:

gr.uoa.di.madgik.grs.reader.GRS2ReaderException

URISyntaxException

gr.uoa.di.madgik.grs.record.GRS2RecordDefinitionException

gr.uoa.di.madgik.grs.buffer.GRS2BufferException

refreshIndexTypesOfIndex

public void refreshIndexTypesOfIndex()

Refreshes the index types

updateManagerProperties

public boolean updateManagerProperties(HashMap<String,org.gcube.indexmanagement.common.FullTextIndexType> colForIdTypes)

updateManagerPropertiesRemoveCollID

public boolean updateManagerPropertiesRemoveCollID(String collectionID)

addMetaIndex

public boolean addMetaIndex()

invalidateCache

public void invalidateCache()

rebuildMetaIndex

public boolean rebuildMetaIndex(List<String> collectionIds,
                       List<String> fields)

getCollectionsAndFieldsOfIndex

public Map<String,List<String>> getCollectionsAndFieldsOfIndex()

getCollectionOfIndex

public List<String> getCollectionOfIndex()

getFieldsOfIndex

public List<String> getFieldsOfIndex()

createFileIndex

public Boolean createFileIndex()

createFileIndex

public static Boolean createFileIndex(org.elasticsearch.client.Client indexClient,
                      String indexName,
                      String indexType,
                      org.elasticsearch.common.settings.Settings settings)

addFile

public void addFile(String base64)
             throws IOException

Throws:

IOException

addFile

public static void addFile(org.elasticsearch.client.Client indexClient,
           String base64,
           String indexName,
           String indexType)
                    throws IOException

Throws:

IOException

cluster

public List<ClusterResponse> cluster(String query,
                            String queryHint,
                            Integer numberOfClusters,
                            String urlField,
                            List<String> titleFields,
                            List<String> contentFields,
                            List<String> languageFields,
                            Set<String> sids,
                            String algorithm,
                            Integer searchHits)

listAlgorithms

public void listAlgorithms()