Package org.ametys.cms.search.solr

Class CriteriaSearchModelWrapper

java.lang.Object

org.ametys.cms.search.solr.CriteriaSearchModelWrapper

All Implemented Interfaces:

SearchModel, LogEnabled

public class CriteriaSearchModelWrapper
extends Object
implements SearchModel, LogEnabled

Search model wrapper which handles custom on-the-fly columns and facets.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	_logger	The logger.
protected ThreadSafeComponentManager<SearchCriterion>	_searchCriterionManager	ComponentManager for SearchUICriterions.

Constructor Summary

Constructors

Constructor	Description
CriteriaSearchModelWrapper(SearchModel model, ServiceManager manager, Context context, Logger logger)	Build a model wrapper.

Method Summary

Modifier and Type	Method	Description
protected void	addIndexingFieldCriteriaComponents(List<Object> searchToolCriterionRoles, Set<String> baseContentTypeIds, String fieldRef)	Add a indexing field criteria component to the manager.
protected void	addSystemCriteriaComponents(List<Object> searchToolCriterionRoles, Set<String> baseContentTypeIds, String property)	Add a system criteria component to the manager.
protected Collection<String>	configureFacets(List<Object> criteriaRoles, Set<String> baseContentTypeIds, Collection<String> criteriaIds, SearchModel referenceModel, Map<String,Object> contextualParameters)	Configure the list of faceted criteria.
Set<String>	getContentTypes(Map<String,Object> contextualParameters)	Get the list of content types.
Map<String,? extends SearchCriterion>	getCriteria(Map<String,Object> contextualParameters)	Get the list of search criteria in simple mode
SearchCriterion	getCriterion(String id, Map<String,Object> contextualParameters)	Get a simple search criterion by its id
protected SearchCriterion	getCriterion(SearchModel searchModel, String criterionId, Map<String,Object> contextualParameters)	Search a criterion in the reference model from its criterion identifier.
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters)	Get the list of excluded content types.
Map<String,? extends SearchCriterion>	getFacetedCriteria(Map<String,Object> contextualParameters)	Get the list of faceted search criteria.
protected final Logger	getLogger()	Get the logger.
ModelViewItem	getResultItem(String itemPath, Map<String,Object> contextualParameters)	Retrieves the search result item with the given path
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
String	getWorkspace(Map<String,Object> contextualParameters)	Get the specific workspace to use.
Collection<String>	setFacetedCriteria(Set<String> baseContentTypeIds, Collection<String> criteriaIds, Map<String,Object> contextualParameters)	Set the custom faceted criteria.
void	setLogger(Logger logger)	Called at creation time to provide a Logger.
void	setResultColumns(Set<String> baseContentTypeIds, Collection<ColumnHelper.Column> columns, Map<String,Object> contextualParameters)	Set the custom columns.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.model.SearchModel

getFacetedCriterion

Field Details

_searchCriterionManager

protected ThreadSafeComponentManager<SearchCriterion> _searchCriterionManager

ComponentManager for SearchUICriterions.

_logger

protected Logger _logger

The logger.

Constructor Details

CriteriaSearchModelWrapper

public CriteriaSearchModelWrapper(SearchModel model,
 ServiceManager manager,
 Context context,
 Logger logger)

Build a model wrapper.

Parameters:

model - the search model to wrap.

manager - the service manager.

context - the component context.

logger - the logger.

Method Details

setLogger

public void setLogger(Logger logger)

Description copied from interface: LogEnabled

Called at creation time to provide a Logger.

Specified by:

setLogger in interface LogEnabled

Parameters:

logger - a Logger for messages.

getLogger

protected final Logger getLogger()

Get the logger.

Returns:

the logger.

setFacetedCriteria

public Collection<String> setFacetedCriteria(Set<String> baseContentTypeIds,
 Collection<String> criteriaIds,
 Map<String,Object> contextualParameters)
                                      throws Exception

Set the custom faceted criteria.

Parameters:

baseContentTypeIds - the reference content type identifiers.

criteriaIds - the criteria IDs

contextualParameters - the contextual parameters

Returns:

the valid criteria IDs

Throws:

Exception - if an error occurs initializing criteria.

setResultColumns

public void setResultColumns(Set<String> baseContentTypeIds,
 Collection<ColumnHelper.Column> columns,
 Map<String,Object> contextualParameters)
                      throws Exception

Set the custom columns.

Parameters:

baseContentTypeIds - the reference content type identifiers.

columns - The columns

contextualParameters - the contextual parameters

Throws:

Exception - if an error occurs initializing columns.

configureFacets

protected Collection<String> configureFacets(List<Object> criteriaRoles,
 Set<String> baseContentTypeIds,
 Collection<String> criteriaIds,
 SearchModel referenceModel,
 Map<String,Object> contextualParameters)
                                      throws ConfigurationException

Configure the list of faceted criteria.

Parameters:

criteriaRoles - the roles of criteria to lookup (or the already existing SearchUICriterion objects).

baseContentTypeIds - The reference content type identifiers.

criteriaIds - the criteria IDs.

referenceModel - the reference model.

contextualParameters - the contextual parameters

Returns:

the valid criteria IDs

Throws:

ConfigurationException - if an error occurs creating a component configuration.

getCriterion

protected SearchCriterion getCriterion(SearchModel searchModel,
 String criterionId,
 Map<String,Object> contextualParameters)

Search a criterion in the reference model from its criterion identifier.

Parameters:

searchModel - the reference search model.

criterionId - the criterion identifier.

contextualParameters - the contextual parameters

Returns:

the criterion if found, null otherwise.

addIndexingFieldCriteriaComponents

protected void addIndexingFieldCriteriaComponents(List<Object> searchToolCriterionRoles,
 Set<String> baseContentTypeIds,
 String fieldRef)
                                           throws ConfigurationException

Add a indexing field criteria component to the manager.

Parameters:

searchToolCriterionRoles - the criteria role list to fill.

baseContentTypeIds - the reference content type identifiers.

fieldRef - the field path.

Throws:

ConfigurationException - if an error occurs.

addSystemCriteriaComponents

protected void addSystemCriteriaComponents(List<Object> searchToolCriterionRoles,
 Set<String> baseContentTypeIds,
 String property)
                                    throws ConfigurationException

Add a system criteria component to the manager.

Parameters:

searchToolCriterionRoles - the criteria role list to fill.

baseContentTypeIds - the reference content type identifiers.

property - the system property id.

Throws:

ConfigurationException - if an error occurs.

getFacetedCriteria

public Map<String,? extends SearchCriterion> getFacetedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of faceted search criteria.

Specified by:

getFacetedCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of faceted search criteria.

getResultItems

public ViewItemContainer getResultItems(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Retrieves the search result items

Specified by:

getResultItems in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the search result items

getResultItem

public ModelViewItem getResultItem(String itemPath,
 Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Retrieves the search result item with the given path

Specified by:

getResultItem in interface SearchModel

Parameters:

itemPath - the path of the result item to retrieve

contextualParameters - the contextual parameters

Returns:

the search result item with

getContentTypes

public Set<String> getContentTypes(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of content types.

Specified by:

getContentTypes in interface SearchModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

The list of content types.

getExcludedContentTypes

public Set<String> getExcludedContentTypes(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of excluded content types.

Specified by:

getExcludedContentTypes in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

The list of excluded content types.

getCriteria

public Map<String,? extends SearchCriterion> getCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of search criteria in simple mode

Specified by:

getCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

getCriterion

public SearchCriterion getCriterion(String id,
 Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get a simple search criterion by its id

Specified by:

getCriterion in interface SearchModel

Parameters:

id - The search criterion id

contextualParameters - the contextual parameters

Returns:

the criterion or null if not found

getWorkspace

public String getWorkspace(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the specific workspace to use.

Specified by:

getWorkspace in interface SearchModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

the workspace to use when searching, or null to use the default workspace.