org.ametys.cms.search.solr

Class CriteriaSearchUIModelWrapper

java.lang.Object

org.ametys.cms.search.ui.model.AbstractSearchUIModel

org.ametys.cms.search.solr.CriteriaSearchUIModelWrapper

All Implemented Interfaces:

SearchModel, SearchUIModel, LogEnabled, Contextualizable, Serviceable

public class CriteriaSearchUIModelWrapper
extends AbstractSearchUIModel

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CriteriaSearchUIModelWrapper.Column A column and its (optional) label

Field Summary

Fields

Modifier and Type	Field and Description
private int	_criteriaIndex
private SearchUIModelExtensionPoint	_searchModelEP
protected ThreadSafeComponentManager<SearchUIColumn>	_searchUIColumnManager ComponentManager for SearchUIColumns.
protected ThreadSafeComponentManager<SearchUICriterion>	_searchUICriterionManager ComponentManager for SearchUICriterions.
private SystemPropertyExtensionPoint	_sysPropEP
private SearchUIModel	_wrappedModel

Fields inherited from class org.ametys.cms.search.ui.model.AbstractSearchUIModel

_advancedSearchCriteria, _columns, _context, _cTypeEP, _cTypes, _excludedCTypes, _facetedCriteria, _logger, _manager, _searchCriteria, _searchModelHelper

Constructor Summary

Constructors

Constructor and Description
CriteriaSearchUIModelWrapper(SearchUIModel model, ServiceManager manager, Context context, Logger logger) Build a model wrapper.

Method Summary

Modifier and Type	Method and Description
protected void	addIndexingFieldCriteriaComponents(List<Object> searchToolCriterionRoles, String contentTypeId, String fieldRef) Add a indexing field criteria component to the manager.
private Configuration	addLabelInColumnConf(Configuration originalConf, String label)
protected void	addMetadataColumnComponents(List<Object> columnsRolesToLookup, String contentTypeId, String metadataPath, Optional<String> columnLabel) Add a metadata column component to the manager.
protected void	addSystemColumnComponent(List<Object> columnsRolesToLookup, String contentTypeId, String property, Optional<String> columnLabel) Add a system column component to the manager.
protected void	addSystemCriteriaComponents(List<Object> searchToolCriterionRoles, String contentTypeId, String property) Add a system criteria component to the manager.
boolean	allowSortOnMultipleJoin() Indicates if sorting on join columns which contain at least one multiple metadata in its path (intermediate ones only) must be allowed.
protected void	configureColumns(List<Object> columnRoles, String contentTypeId, Collection<CriteriaSearchUIModelWrapper.Column> columnIds, SearchUIModel referenceModel, Map<String,Object> contextualParameters) Configure the list of search columns.
protected Collection<String>	configureFacets(List<Object> criteriaRoles, String contentTypeId, Collection<String> criteriaIds, SearchUIModel referenceModel, Map<String,Object> contextualParameters) Configure the list of faceted criteria.
Map<String,SearchUICriterion>	getAdvancedCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in advanced mode
protected SearchUIColumn	getColumn(SearchUIModel searchModel, String columnId, Map<String,Object> contextualParameters) Search a column in the reference model from its column identifier.
Set<String>	getContentTypes(Map<String,Object> contextualParameters) Get the list of content types.
Map<String,SearchUICriterion>	getCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in simple mode
protected SearchUICriterion	getCriterion(SearchUIModel searchModel, String criterionId, Map<String,Object> contextualParameters) Search a criterion in the reference model from its criterion identifier.
SearchUICriterion	getCriterion(String id, Map<String,Object> contextualParameters) Get a simple search criterion by its id
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters) Get the list of excluded content types.
String	getExportCSVUrl(Map<String,Object> contextualParameters) Get the URL for CVS export of results
String	getExportCSVUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for CVS export of results
String	getExportDOCUrl(Map<String,Object> contextualParameters) Get the URL for DOC export of results
String	getExportDOCUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for DOC export of results
String	getExportXMLUrl(Map<String,Object> contextualParameters) Get the URL for XML export of results
String	getExportXMLUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for XML export of results
Map<String,SearchUICriterion>	getFacetedCriteria(Map<String,Object> contextualParameters) Get the list of faceted search criteria.
String	getPrintUrl(Map<String,Object> contextualParameters) Get the URL for print results
String	getPrintUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for print results
SearchUIColumn	getResultField(String id, Map<String,Object> contextualParameters) Get the column by its identifier
Map<String,SearchUIColumn>	getResultFields(Map<String,Object> contextualParameters) Get the column for results
String	getSearchUrl(Map<String,Object> contextualParameters) Get the URL for search
String	getSearchUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for search
void	service(ServiceManager manager)
Collection<String>	setFacetedCriteria(String contentTypeId, Collection<String> criteriaIds, Map<String,Object> contextualParameters) Set the custom faceted criteria.
void	setResultColumns(String contentTypeId, Collection<CriteriaSearchUIModelWrapper.Column> columns, Map<String,Object> contextualParameters) Set the custom columns.

Methods inherited from class org.ametys.cms.search.ui.model.AbstractSearchUIModel

addContentTypesConfiguration, contextualize, getCustomCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getLogger, getMetadataColumnConfiguration, getMetadataColumnConfiguration, getPageSize, getSummaryView, getSystemColumnConfiguration, getSystemColumnConfiguration, getSystemCriteriaConfiguration, getSystemCriteriaConfiguration, getSystemCriteriaConfiguration, getWorkspace, setAdvancedCriteria, setContentTypes, setCriteria, setExcludedContentTypes, setFacetedCriteria, setLogger, setResultFields

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.ui.model.SearchUIModel

getAdvancedCriterion, getFacetedCriterion

Field Detail

_searchUICriterionManager

protected ThreadSafeComponentManager<SearchUICriterion> _searchUICriterionManager

ComponentManager for SearchUICriterions.

_searchUIColumnManager

protected ThreadSafeComponentManager<SearchUIColumn> _searchUIColumnManager

ComponentManager for SearchUIColumns.

_searchModelEP

private SearchUIModelExtensionPoint _searchModelEP

_sysPropEP

private SystemPropertyExtensionPoint _sysPropEP

_wrappedModel

private SearchUIModel _wrappedModel

_criteriaIndex

private int _criteriaIndex

Constructor Detail

CriteriaSearchUIModelWrapper

public CriteriaSearchUIModelWrapper(SearchUIModel 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 Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSearchUIModel

Throws:

ServiceException

setFacetedCriteria

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

Set the custom faceted criteria.

Parameters:

contentTypeId - the reference content type ID, can be null.

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(String contentTypeId,
                             Collection<CriteriaSearchUIModelWrapper.Column> columns,
                             Map<String,Object> contextualParameters)
                      throws Exception

Set the custom columns.

Parameters:

contentTypeId - the reference content type ID, can be null.

columns - The columns

contextualParameters - the contextual parameters

Throws:

Exception - if an error occurs initializing columns.

configureFacets

protected Collection<String> configureFacets(List<Object> criteriaRoles,
                                             String contentTypeId,
                                             Collection<String> criteriaIds,
                                             SearchUIModel 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).

contentTypeId - The reference content type ID.

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 SearchUICriterion getCriterion(SearchUIModel 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.

configureColumns

protected void configureColumns(List<Object> columnRoles,
                                String contentTypeId,
                                Collection<CriteriaSearchUIModelWrapper.Column> columnIds,
                                SearchUIModel referenceModel,
                                Map<String,Object> contextualParameters)
                         throws ConfigurationException

Configure the list of search columns.

Parameters:

columnRoles - the roles of columns to lookup (or the already existing SearchUIColumn objects).

contentTypeId - The reference content type ID.

columnIds - The columns

referenceModel - the reference model.

contextualParameters - the contextual parameters

Throws:

ConfigurationException - if an error occurs creating a component configuration.

getColumn

protected SearchUIColumn getColumn(SearchUIModel searchModel,
                                   String columnId,
                                   Map<String,Object> contextualParameters)

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

Parameters:

searchModel - the reference search model.

columnId - the column identifier.

contextualParameters - the contextual parameters

Returns:

the column if found, null otherwise.

addIndexingFieldCriteriaComponents

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

Add a indexing field criteria component to the manager.

Parameters:

searchToolCriterionRoles - the criteria role list to fill.

contentTypeId - the reference content type ID, can be null.

fieldRef - the field path.

Throws:

ConfigurationException - if an error occurs.

addSystemCriteriaComponents

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

Add a system criteria component to the manager.

Parameters:

searchToolCriterionRoles - the criteria role list to fill.

contentTypeId - the reference content type ID, can be null.

property - the system property id.

Throws:

ConfigurationException - if an error occurs.

addLabelInColumnConf

private Configuration addLabelInColumnConf(Configuration originalConf,
                                           String label)
                                    throws ConfigurationException

Throws:

ConfigurationException

addMetadataColumnComponents

protected void addMetadataColumnComponents(List<Object> columnsRolesToLookup,
                                           String contentTypeId,
                                           String metadataPath,
                                           Optional<String> columnLabel)
                                    throws ConfigurationException

Add a metadata column component to the manager.

Parameters:

columnsRolesToLookup - the columns roles

contentTypeId - the reference content type ID, can be null.

metadataPath - the metadata path.

columnLabel - The (optional) label of the column. If not present, the column label will be the metadata one.

Throws:

ConfigurationException - if an error occurs.

addSystemColumnComponent

protected void addSystemColumnComponent(List<Object> columnsRolesToLookup,
                                        String contentTypeId,
                                        String property,
                                        Optional<String> columnLabel)
                                 throws ConfigurationException

Add a system column component to the manager.

Parameters:

columnsRolesToLookup - the columns roles

contentTypeId - the reference content type ID, can be null.

property - the system property.

columnLabel - The (optional) label of the column. If not present, the column label will be the metadata one.

Throws:

ConfigurationException - if an error occurs.

getFacetedCriteria

public Map<String,SearchUICriterion> getFacetedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of faceted search criteria.

Specified by:

getFacetedCriteria in interface SearchModel

Specified by:

getFacetedCriteria in interface SearchUIModel

Overrides:

getFacetedCriteria in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of faceted search criteria.

getResultFields

public Map<String,SearchUIColumn> getResultFields(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the column for results

Specified by:

getResultFields in interface SearchModel

Specified by:

getResultFields in interface SearchUIModel

Overrides:

getResultFields in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters. Can be null.

Returns:

the column for results

getResultField

public SearchUIColumn getResultField(String id,
                                     Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the column by its identifier

Parameters:

id - The column id

contextualParameters - the contextual parameters

Returns:

the column

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

Overrides:

getContentTypes in class AbstractSearchUIModel

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

Overrides:

getExcludedContentTypes in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

The list of excluded content types.

getSearchUrl

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

Description copied from interface: SearchUIModel

Get the URL for search

Specified by:

getSearchUrl in interface SearchUIModel

Overrides:

getSearchUrl in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for search

getSearchUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for search

Specified by:

getSearchUrlPlugin in interface SearchUIModel

Overrides:

getSearchUrlPlugin in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for search

getExportCSVUrl

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

Description copied from interface: SearchUIModel

Get the URL for CVS export of results

Specified by:

getExportCSVUrl in interface SearchUIModel

Overrides:

getExportCSVUrl in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for CVS export

getExportCSVUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for CVS export of results

Specified by:

getExportCSVUrlPlugin in interface SearchUIModel

Overrides:

getExportCSVUrlPlugin in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for CVS export

getExportDOCUrl

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

Description copied from interface: SearchUIModel

Get the URL for DOC export of results

Specified by:

getExportDOCUrl in interface SearchUIModel

Overrides:

getExportDOCUrl in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for CVS export

getExportDOCUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for DOC export of results

Specified by:

getExportDOCUrlPlugin in interface SearchUIModel

Overrides:

getExportDOCUrlPlugin in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for CVS export

getExportXMLUrl

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

Description copied from interface: SearchUIModel

Get the URL for XML export of results

Specified by:

getExportXMLUrl in interface SearchUIModel

Overrides:

getExportXMLUrl in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for XML export

getExportXMLUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for XML export of results

Specified by:

getExportXMLUrlPlugin in interface SearchUIModel

Overrides:

getExportXMLUrlPlugin in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for XML export

getPrintUrl

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

Description copied from interface: SearchUIModel

Get the URL for print results

Specified by:

getPrintUrl in interface SearchUIModel

Overrides:

getPrintUrl in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for print results

getPrintUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for print results

Specified by:

getPrintUrlPlugin in interface SearchUIModel

Overrides:

getPrintUrlPlugin in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for print results

allowSortOnMultipleJoin

public boolean allowSortOnMultipleJoin()

Description copied from interface: SearchUIModel

Indicates if sorting on join columns which contain at least one multiple metadata in its path (intermediate ones only) must be allowed.
If the final metadata of the path is multiple, the column will not be sortable though.

Returns:

true if sorting on join columns which contains at least one multiple metadata in its path (intermediate ones only) must be allowed.

getCriteria

public Map<String,SearchUICriterion> 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

Specified by:

getCriteria in interface SearchUIModel

Overrides:

getCriteria in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

getCriterion

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

Description copied from interface: SearchModel

Get a simple search criterion by its id

Parameters:

id - The search criterion id

contextualParameters - the contextual parameters

Returns:

the criterion or null if not found

getAdvancedCriteria

public Map<String,SearchUICriterion> getAdvancedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the list of search criteria in advanced mode

Specified by:

getAdvancedCriteria in interface SearchUIModel

Overrides:

getAdvancedCriteria in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in advanced mode