org.gcube.searchsystem.environmentadaptor

Class ResourceRegistryAdapter

java.lang.Object

org.gcube.searchsystem.environmentadaptor.ResourceRegistryAdapter

All Implemented Interfaces:

EnvironmentAdaptor

public class ResourceRegistryAdapter
extends Object
implements EnvironmentAdaptor

Constructor Summary

Constructors

Constructor and Description
ResourceRegistryAdapter(gr.uoa.di.madgik.environment.hint.EnvHintCollection hints) Default constructor which takes the working scope for the ResourceRegistry

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAllCollections(String scope)
Map<String,String>	getAllCollectionsTypes(String scope)
Map<String,Set<String>>	getAllPresentableFieldsPerCollection(String scope)
Map<String,Set<String>>	getAllSearchableFieldsPerCollection(String scope)
Set<String>	getCollectionByFieldRelationLang(Map<String,List<String>> fieldRelationMap, String language, List<String> projections) Get the collections for a number of criteria and a specific language.
Map<String,Set<String>>	getCollectionLangsByFieldRelation(Map<String,List<String>> fieldRelationMap, List<String> projections) Get the collection-languages pairs for a number of criteria.
String	getFieldIDFromName(String fieldName)
Map<String,String>	getFieldsMapping(String scope)
Set<String>	getLanguageByFieldRelationCol(Map<String,List<String>> fieldRelationMap, String collection, List<String> projections) Get the languages for a number of criteria and a specific collection.
long	getLastUpdate()
HashMap<String,HashSet<String>>	getProjectionsPerSource(Set<String> sources, Set<String> projectionsNeeded, HashMap<String,HashSet<String>> colLangs) Get the fields projected by each of the sources of the input.
Set<String>	getSourceIdsForFieldRelationCollectionLanguage(String field, String relation, String collection, String language, String indication) Get source identifiers for all the sources that publish a searchable field for a specific collection and language AND they also support the specified relation, and they provide the capability(e.g.
static boolean	initializeAdapter()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRegistryAdapter

public ResourceRegistryAdapter(gr.uoa.di.madgik.environment.hint.EnvHintCollection hints)

Default constructor which takes the working scope for the ResourceRegistry

Parameters:

scope - - the working scope

Method Detail

initializeAdapter

public static boolean initializeAdapter()
                                 throws Exception

Throws:

Exception

getFieldsMapping

public Map<String,String> getFieldsMapping(String scope)
                                    throws Exception

Throws:

Exception

getFieldIDFromName

public String getFieldIDFromName(String fieldName)
                          throws Exception

Throws:

Exception

getAllCollections

public Map<String,String> getAllCollections(String scope)
                                     throws Exception

Throws:

Exception

getAllCollectionsTypes

public Map<String,String> getAllCollectionsTypes(String scope)
                                          throws Exception

Throws:

Exception

getAllSearchableFieldsPerCollection

public Map<String,Set<String>> getAllSearchableFieldsPerCollection(String scope)
                                                            throws Exception

Throws:

Exception

getAllPresentableFieldsPerCollection

public Map<String,Set<String>> getAllPresentableFieldsPerCollection(String scope)
                                                             throws Exception

Throws:

Exception

getProjectionsPerSource

public HashMap<String,HashSet<String>> getProjectionsPerSource(Set<String> sources,
                                                      Set<String> projectionsNeeded,
                                                      HashMap<String,HashSet<String>> colLangs)
                                                        throws Exception

Description copied from interface: EnvironmentAdaptor

Get the fields projected by each of the sources of the input. For including a field in the output(for a specific source) this field must be presentable for all the collection-language pairs specified in the input(for this specific source)

Specified by:

getProjectionsPerSource in interface EnvironmentAdaptor

Parameters:

sources - - the sources of interest

projectionsNeeded - - the fields of interest

colLangs - - the collection-language pairs of interest

Returns:

a map containing the fields for each source

Throws:

Exception

getCollectionLangsByFieldRelation

public Map<String,Set<String>> getCollectionLangsByFieldRelation(Map<String,List<String>> fieldRelationMap,
                                                        List<String> projections)
                                                          throws Exception

Description copied from interface: EnvironmentAdaptor

Get the collection-languages pairs for a number of criteria. The criteria are specified by field-relation pairs. The return map will have all the collection-language pairs for which there are sources for all the searchable field - supported relation pairs specified. The projections is an optional field, which specifies which are the presentable fields that must be published by sources for a collection-language pair

Specified by:

getCollectionLangsByFieldRelation in interface EnvironmentAdaptor

Parameters:

fieldRelationMap - - the search criteria specified

projections - - the presentation criteria specified

Returns:

the collection-language pairs satisfying the criteria

Throws:

Exception

getCollectionByFieldRelationLang

public Set<String> getCollectionByFieldRelationLang(Map<String,List<String>> fieldRelationMap,
                                           String language,
                                           List<String> projections)
                                             throws Exception

Description copied from interface: EnvironmentAdaptor

Get the collections for a number of criteria and a specific language. The criteria are specified by field-relation pairs. The return map will have all the collections for which there are sources for all the (language+searchable)(meaning that the source publishes this field as searchable for this specific language and a collection X) field - supported relation pairs specified. The projections is an optional field, which specifies which are the (language+presentable) fields that must be published by sources for a collection

Specified by:

getCollectionByFieldRelationLang in interface EnvironmentAdaptor

Parameters:

fieldRelationMap - - the search criteria specified

language - - the language specifed

projections - - the presentation criteria specified

Returns:

the list of collections satisfying the criteria for the language specified

Throws:

Exception

getLanguageByFieldRelationCol

public Set<String> getLanguageByFieldRelationCol(Map<String,List<String>> fieldRelationMap,
                                        String collection,
                                        List<String> projections)
                                          throws Exception

Description copied from interface: EnvironmentAdaptor

Get the languages for a number of criteria and a specific collection. The criteria are specified by field-relation pairs. The return map will have all the languages for which there are sources for all the (collection+searchable)(meaning that the source publishes this field as searchable for this specific collection and a language X) field - supported relation pairs specified. The projections is an optional field, which specifies which are the (collection+presentable) fields that must be published by sources for a language

Specified by:

getLanguageByFieldRelationCol in interface EnvironmentAdaptor

Parameters:

fieldRelationMap - - the search criteria specified

collection - - the collection specified

projections - - the presentation criteria specified

Returns:

the list of languages satisfying the criteria for the collection specified

Throws:

Exception

getSourceIdsForFieldRelationCollectionLanguage

public Set<String> getSourceIdsForFieldRelationCollectionLanguage(String field,
                                                         String relation,
                                                         String collection,
                                                         String language,
                                                         String indication)
                                                           throws Exception

Description copied from interface: EnvironmentAdaptor

Get source identifiers for all the sources that publish a searchable field for a specific collection and language AND they also support the specified relation, and they provide the capability(e.g. rank) specified in the indication argument.

Specified by:

getSourceIdsForFieldRelationCollectionLanguage in interface EnvironmentAdaptor

Parameters:

field - - the searchable field specified

relation - - the relation specified

collection - - the collection specified

language - - the language specified

indication - - the capability specified

Returns:

the set of source identifiers - note that these identifiers can be internal to the adaptor and in the next search stages(e.g. workflow), the same adaptor must be used.

Throws:

Exception

getLastUpdate

public long getLastUpdate()

Specified by:

getLastUpdate in interface EnvironmentAdaptor