Package org.ametys.plugins.odfweb.service.search

Class MatchingSubprogramSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.frontoffice.search.requesttime.AbstractSearchComponent

org.ametys.plugins.odfweb.service.search.MatchingSubprogramSearchComponent

All Implemented Interfaces:

LogEnabled, PluginAware, Prioritizable, Supporter<SearchComponentArguments>, SearchComponent, Serviceable

public class MatchingSubprogramSearchComponent
extends AbstractSearchComponent
implements Serviceable

SearchComponent for getting subprograms matching search

Field Summary

Fields

Modifier and Type	Field	Description
protected AdvancedQueryBuilder	_advancedQueryBuilder	The builder of advanced queries
protected ContentSearcherFactory	_contentSearcherfactory	The content searcher factory
protected ODFSearchHelper	_odfSearchHelper	The ODF search helper
protected SearchComponentHelper	_searchComponentHelper	The search component helper

Fields inherited from interface org.ametys.web.frontoffice.search.requesttime.SearchComponent

DISABLE_DEFAULT_SAX_PARAMETER_NAME, MAX_PRIORITY, MIN_PRIORITY, SEARCH_PRIORITY

Constructor Summary

Constructors

Constructor	Description
MatchingSubprogramSearchComponent()

Method Summary

Modifier and Type	Method	Description
protected Query	buildQuery(AbstractTreeNode<SearchServiceCriterion<?>> criterionTree, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Map<String,Object> contextualParameters)	Builds the query of the criterion tree
void	execute(SearchComponentArguments args)	Executes the component.
int	getPriority()	Get the priority for the component.
protected List<String>	retrieveSubProgramsMatchingSearch(SearchServiceInstance serviceInstance, Map<String,Object> userCriteria, Collection<SearchServiceFacetDefinition> serviceFacets, Map<String,List<String>> userFacets, String lang)	Retrieves, thanks to a (independent but close to the main one) Solr search, the SubPrograms that match the same query than the Programs, for further special display.
void	service(ServiceManager manager)
protected Query	singleCriterionToQuery(SearchServiceCriterion<?> criterion, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Map<String,Object> contextualParameters)	Builds the query of the single criterion
boolean	supports(SearchComponentArguments args)	Check if an element is supported

Methods inherited from class org.ametys.web.frontoffice.search.requesttime.AbstractSearchComponent

getId, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_contentSearcherfactory

protected ContentSearcherFactory _contentSearcherfactory

The content searcher factory

_advancedQueryBuilder

protected AdvancedQueryBuilder _advancedQueryBuilder

The builder of advanced queries

_searchComponentHelper

protected SearchComponentHelper _searchComponentHelper

The search component helper

_odfSearchHelper

protected ODFSearchHelper _odfSearchHelper

The ODF search helper

Constructor Details

MatchingSubprogramSearchComponent

public MatchingSubprogramSearchComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<SearchComponentArguments>

Parameters:

args - The element

Returns:

true if the element is supported, false otherwise

execute

public void execute(SearchComponentArguments args)
             throws Exception

Description copied from interface: SearchComponent

Executes the component.

Specified by:

execute in interface SearchComponent

Parameters:

args - the arguments

Throws:

Exception - if an exception occurs. Other search components will be attempted to be executed

retrieveSubProgramsMatchingSearch

protected List<String> retrieveSubProgramsMatchingSearch(SearchServiceInstance serviceInstance,
 Map<String,Object> userCriteria,
 Collection<SearchServiceFacetDefinition> serviceFacets,
 Map<String,List<String>> userFacets,
 String lang)
                                                  throws Exception

Retrieves, thanks to a (independent but close to the main one) Solr search, the SubPrograms that match the same query than the Programs, for further special display.

Parameters:

serviceInstance - The service instance

userCriteria - The user criteria

serviceFacets - the service facets

userFacets - the user facets

lang - The current lang

Returns:

the SubPrograms that match the same query than the Programs

Throws:

Exception - If an exception occured during the Solr search

buildQuery

protected Query buildQuery(AbstractTreeNode<SearchServiceCriterion<?>> criterionTree,
 Map<String,Object> userCriteria,
 Collection<Returnable> returnables,
 Collection<Searchable> searchables,
 AdditionalParameterValueMap additionalParameters,
 String currentLang,
 Map<String,Object> contextualParameters)

Builds the query of the criterion tree

Parameters:

criterionTree - The criterion tree of the service instance

userCriteria - The user input criteria

returnables - The returnables of the service instance

searchables - The searchables of the service instance

additionalParameters - The values of additional parameters of the service instance

currentLang - The current lang

contextualParameters - the search contextual parameters.

Returns:

The query of the criterion tree

singleCriterionToQuery

protected Query singleCriterionToQuery(SearchServiceCriterion<?> criterion,
 Map<String,Object> userCriteria,
 Collection<Returnable> returnables,
 Collection<Searchable> searchables,
 AdditionalParameterValueMap additionalParameters,
 String currentLang,
 Map<String,Object> contextualParameters)

Builds the query of the single criterion

Parameters:

criterion - The criterion

userCriteria - The user input criteria

returnables - The returnables of the service instance

searchables - The searchables of the service instance

additionalParameters - The values of additional parameters of the service instance

currentLang - The current lang

contextualParameters - the search contextual parameters.

Returns:

The query of the single criterion