Class SearchServiceImpl

java.lang.Object

ubic.gemma.core.search.SearchServiceImpl

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, SearchService

@Service
public class SearchServiceImpl
extends Object
implements SearchService, org.springframework.beans.factory.InitializingBean

Free-text search service: delegates per-result-type lookups to a CompositeSearchSource composed of all registered SearchSource beans (e.g. HibernateSearchSource, DatabaseSearchSource). Preserves the value-object conversion path on the way out.

Restored as part of HS-7 search restoration Step 3 (see SEARCH_RECCE.md). The pre-strip convenience surface (taxon inference from query, dedicated blacklist gating, ontology single-term expansion) is deliberately deferred until the ontology source comes back in Step 3+ / Section 6.

Author:

klc, paul, keshav

Nested Class Summary

Nested classes/interfaces inherited from interface SearchService

SearchService.SearchResultMap

Constructor Summary

Constructors

Constructor	Description
SearchServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
Set<String>	getFields(Class<? extends Identifiable> resultType, SearchSettings.SearchMode searchMode)	Obtain a list of fields that can be searched on for the given result type and search mode.
Set<Class<? extends Identifiable>>	getSupportedResultTypes()	Returns a set of supported result types.
<T extends Identifiable, U extends IdentifiableValueObject<T>> SearchResult<U>	loadValueObject(SearchResult<T> searchResult)	Convert a SearchResult to its VO flavour.
List<SearchResult<? extends IdentifiableValueObject<?>>>	loadValueObjects(Collection<SearchResult<?>> searchResults)	Convert a collection of SearchResult to their VO flavours.
SearchService.SearchResultMap	search(SearchSettings settings)
SearchService.SearchResultMap	search(SearchSettings settings, SearchContext context)	The results are sorted in order of decreasing score, organized by class.

Methods inherited from class Object

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

Constructor Details

SearchServiceImpl

public SearchServiceImpl()

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getFields

public Set<String> getFields(Class<? extends Identifiable> resultType,
 SearchSettings.SearchMode searchMode)

Description copied from interface: SearchService

Obtain a list of fields that can be searched on for the given result type and search mode.

The search mode can affect which fields will be looked-up by the search sources. To get all possible fields, use the SearchSettings.SearchMode.ACCURATE mode.

Specified by:

getFields in interface SearchService

search

@Transactional(readOnly=true)
public SearchService.SearchResultMap search(SearchSettings settings,
 SearchContext context)
                                     throws SearchException

Description copied from interface: SearchService

The results are sorted in order of decreasing score, organized by class. The following objects can be searched for, depending on the configuration of the input object.

• Genes
• ExpressionExperiments
• CompositeSequences (probes)
• ArrayDesigns (platforms)
• Characteristics (e.g., Ontology annotations)
• BioSequences
• BibliographicReferences (articles)

Search results are internally subjected to ACLs, so it is safe to assume that the returned results (or result IDs) can be viewed by the current user.

Specified by:

search in interface SearchService

Parameters:

settings - settings for the search

context - a context holding optional highlighter and issue reporter

Returns:

Map of Class to SearchResults. The results are already filtered for security considerations.

Throws:

SearchException

search

@Transactional(readOnly=true)
public SearchService.SearchResultMap search(SearchSettings settings)
                                     throws SearchException

Specified by:

search in interface SearchService

Throws:

SearchException

getSupportedResultTypes

public Set<Class<? extends Identifiable>> getSupportedResultTypes()

Description copied from interface: SearchService

Returns a set of supported result types.

This is mainly used to perform a search for everything via SearchSettings.getResultTypes().

Specified by:

getSupportedResultTypes in interface SearchService

loadValueObject

@Transactional(readOnly=true)
public <T extends Identifiable, U extends IdentifiableValueObject<T>>
SearchResult<U> loadValueObject(SearchResult<T> searchResult)
                         throws IllegalArgumentException

Description copied from interface: SearchService

Convert a SearchResult to its VO flavour.

The resulting search result preserve the result ID, score and highlighted text, and SearchResult.getResultType(), but sees its SearchResult.getResultObject() transformed.

The conversion logic is mainly defined by the corresponding BaseVoEnabledService that match the result type. See SearchService.getSupportedResultTypes() for a set of supported result types this o function can handle.

Specified by:

loadValueObject in interface SearchService

Throws:

IllegalArgumentException - if the passed search result is not supported for VO conversion

loadValueObjects

@Transactional(readOnly=true)
public List<SearchResult<? extends IdentifiableValueObject<?>>> loadValueObjects(Collection<SearchResult<?>> searchResults)
                                                                          throws IllegalArgumentException

Description copied from interface: SearchService

Convert a collection of SearchResult to their VO flavours.

Note that since the results might contain a mixture of different result types, the implementation can take advantage of grouping result by types in order to use BaseVoEnabledService.loadValueObjects(Collection), which is generally more efficient than loading each result individually.

Specified by:

loadValueObjects in interface SearchService

Parameters:

searchResults - a collection of SearchResult, which may contain a mixture of different Identifiable result objects

Returns:

converted search results as per SearchService.loadValueObject(SearchResult)

Throws:

IllegalArgumentException - if any of the supplied search results cannot be converted to VO

See Also:

• BaseVoEnabledService.loadValueObjects(Collection)