org.ametys.web.frontoffice.search.metamodel

Class SearchServiceCreationHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.frontoffice.search.metamodel.SearchServiceCreationHelper

All Implemented Interfaces:

LogEnabled, PluginAware, Initializable, Component, Contextualizable, Serviceable

public class SearchServiceCreationHelper
extends AbstractLogEnabled
implements Component, Serviceable, Initializable, PluginAware, Contextualizable

Helper component for drawing search service creation/edition dialog box.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<AdditionalSearchServiceParameter>	_additionalSearchServiceParameters
protected Context	_context The context
protected ContentTypeExtensionPoint	_cTypeEP The extension point for content types
protected ThreadSafeComponentManager<Enumerator>	_enumeratorManager The enumerator manager
protected ServiceManager	_manager The service manager
protected String	_pluginName The plugin name
protected ReturnableExtensionPoint	_returnableEP The extension point for Returnables
protected SearchableExtensionPoint	_searchableEP The extension point for Searchables
protected Map<Returnable,Collection<Searchable>>	_searchablesByReturnable The map returnable -> Collection of searchables
protected ServiceExtensionPoint	_serviceEP The extension point for services
protected SiteEnumerator	_siteEnumerator The Site enumerator
protected SiteQueryHelper	_siteQueryHelper The helper for site query
protected SystemPropertyExtensionPoint	_systemPropertyEP The extension point for SystemProperties
static String	ROLE Avalon Role

Constructor Summary

Constructors

Constructor and Description
SearchServiceCreationHelper()

Method Summary

Modifier and Type	Method and Description
private Collection<Configuration>	_getAdditionalParameterConfigurationsOfReturnables()
private Collection<Configuration>	_getAdditionalParameterConfigurationsOfSearchables()
private <T> Object	_getAdditionalParameterValue(ModelAwareDataHolder serviceParameters, ServiceParameter<T> parameter)
private Stream<Searchable>	_getSearchables(Stream<Returnable> returnables)
protected void	buildTree() Method called at the start of the application based on Returnable.relationsWith() and Searchable.relationsWith() in order to build the data structure (in a map returnable -> Collection of searchables) linking Returnables and Searchables
void	contextualize(Context context)
protected void	createEnumerators() Creates and initializes enumerators (SiteEnumerator, etc.)
Collection<Configuration>	getAdditionalParameterConfigurationsForDisplay() Gets the configurations of the additional parameters to display in display group
Collection<Configuration>	getAdditionalParameterConfigurationsForGeneral() Gets the configurations of the additional parameters to display in general group
Collection<AdditionalSearchServiceParameter>	getAdditionalParameters() Gets the additional parameters to display
AdditionalParameterValueMap	getAdditionalParameterValues(Collection<AdditionalSearchServiceParameter> additionalParameters, Map<String,Object> clientSideValues) Gets the values of the additional parameters from a client form
AdditionalParameterValueMap	getAdditionalParameterValues(Collection<AdditionalSearchServiceParameter> additionalParameters, ModelAwareDataHolder serviceParameters) Gets the values of the additional parameters
Map<String,SearchCriterionDefinition>	getCriterionDefinitions(Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameterValues) Gets the SearchCriterionDefinitions available with the given Searchables and additional parameter values
Map<String,FacetDefinition>	getFacetDefinitions(Collection<Returnable> returnables, AdditionalParameterValueMap additionalParameterValues) Gets the FacetDefinitions available with the given Returnables and additional parameter values
List<Returnable>	getReturnables(List<String> returnableIds) Gets the Returnables with the given ids
Collection<Searchable>	getSearchables(Collection<Returnable> returnables) Gets the Searchables linked with the given Returnables
Map<String,SortDefinition>	getSortDefinitions(Collection<Returnable> returnables, AdditionalParameterValueMap additionalParameterValues) Gets the SortDefinitions available with the given Returnables and additional parameter values
void	initialize()
Collection<String>	selectedReturnables() Gets the Returnables that must be selected by default
void	service(ServiceManager manager)
void	setAdditionalParameters(Collection<AdditionalSearchServiceParameter> additionalSearchServiceParameters) Sets the additional parameters to display
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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 Detail

ROLE

public static final String ROLE

Avalon Role

_manager

protected ServiceManager _manager

The service manager

_returnableEP

protected ReturnableExtensionPoint _returnableEP

The extension point for Returnables

_searchableEP

protected SearchableExtensionPoint _searchableEP

The extension point for Searchables

_serviceEP

protected ServiceExtensionPoint _serviceEP

The extension point for services

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The extension point for content types

_systemPropertyEP

protected SystemPropertyExtensionPoint _systemPropertyEP

The extension point for SystemProperties

_siteQueryHelper

protected SiteQueryHelper _siteQueryHelper

The helper for site query

_enumeratorManager

protected ThreadSafeComponentManager<Enumerator> _enumeratorManager

The enumerator manager

_siteEnumerator

protected SiteEnumerator _siteEnumerator

The Site enumerator

_pluginName

protected String _pluginName

The plugin name

_context

protected Context _context

The context

_searchablesByReturnable

protected Map<Returnable,Collection<Searchable>> _searchablesByReturnable

The map returnable -> Collection of searchables

_additionalSearchServiceParameters

private Collection<AdditionalSearchServiceParameter> _additionalSearchServiceParameters

Constructor Detail

SearchServiceCreationHelper

public SearchServiceCreationHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

buildTree

protected void buildTree()

Method called at the start of the application based on Returnable.relationsWith() and Searchable.relationsWith() in order to build the data structure (in a map returnable -> Collection of searchables) linking Returnables and Searchables

createEnumerators

protected void createEnumerators()
                          throws Exception

Creates and initializes enumerators (SiteEnumerator, etc.)

Throws:

Exception - if an error occurs

getReturnables

public List<Returnable> getReturnables(List<String> returnableIds)

Gets the Returnables with the given ids

Parameters:

returnableIds - the ids of the Returnables

Returns:

the Returnables with the given ids

getSearchables

public Collection<Searchable> getSearchables(Collection<Returnable> returnables)

Gets the Searchables linked with the given Returnables

Parameters:

returnables - the Returnables

Returns:

the Searchables linked with the given Returnable

_getSearchables

private Stream<Searchable> _getSearchables(Stream<Returnable> returnables)

getCriterionDefinitions

public Map<String,SearchCriterionDefinition> getCriterionDefinitions(Collection<Searchable> searchables,
                                                                     AdditionalParameterValueMap additionalParameterValues)

Gets the SearchCriterionDefinitions available with the given Searchables and additional parameter values

Parameters:

searchables - The Searchables

additionalParameterValues - The additional parameter values

Returns:

the SearchCriterionDefinitions available with the given Searchables and additional parameter values

getFacetDefinitions

public Map<String,FacetDefinition> getFacetDefinitions(Collection<Returnable> returnables,
                                                       AdditionalParameterValueMap additionalParameterValues)

Gets the FacetDefinitions available with the given Returnables and additional parameter values

Parameters:

returnables - The Returnables

additionalParameterValues - The additional parameter values

Returns:

the FacetDefinitions available with the given Returnables and additional parameter values

getSortDefinitions

public Map<String,SortDefinition> getSortDefinitions(Collection<Returnable> returnables,
                                                     AdditionalParameterValueMap additionalParameterValues)

Gets the SortDefinitions available with the given Returnables and additional parameter values

Parameters:

returnables - The Returnables

additionalParameterValues - The additional parameter values

Returns:

the SortDefinitions available with the given Returnables and additional parameter values

selectedReturnables

public Collection<String> selectedReturnables()

Gets the Returnables that must be selected by default

Returns:

the Returnables that must be selected by default

getAdditionalParameterConfigurationsForGeneral

public Collection<Configuration> getAdditionalParameterConfigurationsForGeneral()

Gets the configurations of the additional parameters to display in general group

Returns:

the configurations of the additional parameters to display

_getAdditionalParameterConfigurationsOfSearchables

private Collection<Configuration> _getAdditionalParameterConfigurationsOfSearchables()

getAdditionalParameterConfigurationsForDisplay

public Collection<Configuration> getAdditionalParameterConfigurationsForDisplay()

Gets the configurations of the additional parameters to display in display group

Returns:

the configurations of the additional parameters to display

_getAdditionalParameterConfigurationsOfReturnables

private Collection<Configuration> _getAdditionalParameterConfigurationsOfReturnables()

setAdditionalParameters

public void setAdditionalParameters(Collection<AdditionalSearchServiceParameter> additionalSearchServiceParameters)

Sets the additional parameters to display

Parameters:

additionalSearchServiceParameters - the additional parameters to display

getAdditionalParameters

public Collection<AdditionalSearchServiceParameter> getAdditionalParameters()

Gets the additional parameters to display

Returns:

the additional parameters to display

getAdditionalParameterValues

public AdditionalParameterValueMap getAdditionalParameterValues(Collection<AdditionalSearchServiceParameter> additionalParameters,
                                                                ModelAwareDataHolder serviceParameters)

Gets the values of the additional parameters

Parameters:

additionalParameters - the additional parameters

serviceParameters - the storage of the service parameters

Returns:

the values of the additional parameters

_getAdditionalParameterValue

private <T> Object _getAdditionalParameterValue(ModelAwareDataHolder serviceParameters,
                                                ServiceParameter<T> parameter)

getAdditionalParameterValues

public AdditionalParameterValueMap getAdditionalParameterValues(Collection<AdditionalSearchServiceParameter> additionalParameters,
                                                                Map<String,Object> clientSideValues)

Gets the values of the additional parameters from a client form

Parameters:

additionalParameters - the additional parameters

clientSideValues - the values of the client form

Returns:

the values of the additional parameters from the client form