Package org.ametys.cms.search.ui.model

Class StaticSearchUIModel

java.lang.Object

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

org.ametys.cms.search.ui.model.StaticSearchUIModel

All Implemented Interfaces:

SearchModel, SearchUIModel, LogEnabled, Disposable, Configurable, Contextualizable, Serviceable

public class StaticSearchUIModel
extends AbstractSearchUIModel
implements Configurable, Disposable

Static implementation of a AbstractSearchUIModel

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnHelper	_columnHelper	The helper for columns
protected ContentTypesHelper	_cTypeHelper	The content type helper.
protected ThreadSafeComponentManager<SearchUIColumn>	_searchColumnManager	ComponentManager for SearchUIColumns.
protected ThreadSafeComponentManager<SearchUICriterion>	_searchCriterionManager	ComponentManager for SearchUICriterions.
protected SystemPropertyExtensionPoint	_systemPropEP	The system property extension point.

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

_advancedSearchCriteria, _columns, _context, _cTypeEP, _cTypes, _excludedCTypes, _facetedCriteria, _logger, _manager, _searchCriteria, _searchModelHelper, DEFAULT_EXPORT_CSV_URL, DEFAULT_EXPORT_DOC_URL, DEFAULT_EXPORT_XML_URL, DEFAULT_PRINT_URL, DEFAULT_SEARCH_URL, DEFAULT_URL_PLUGIN

Constructor Summary

Constructors

Constructor	Description
StaticSearchUIModel()

Method Summary

Modifier and Type	Method	Description
protected void	_addColumnsComponents(Set<ContentType> commonContentTypes, Configuration configuration, List<String> columnsRolesToLookup)	Add column components to the result column manager.
protected void	_addCriteriaComponents(Set<ContentType> commonContentTypes, Configuration configuration, List<String> searchCriteriaRoles)	Add criteria components to the search criteria manager.
protected void	_addCriteriaComponents(Set<ContentType> commonContentTypes, Configuration configuration, List<String> searchCriteriaRoles, I18nizableText group)	Add standard criteria components to the search criteria manager.
protected void	_addCustomColumnComponent(Set<ContentType> commonContentTypes, Configuration conf, String customId, List<String> columnsRolesToLookup)	Add a custom column component to the manager.
protected void	_addCustomCriteriaComponents(Set<ContentType> commonContentTypes, Configuration conf, List<String> searchCriteriaRoles, String searchCriterionId, I18nizableText group)	Add a custom criteria component to the manager.
protected void	_addFacetCriteriaComponents(Set<ContentType> commonContentTypes, Configuration configuration, List<String> searchCriteriaRoles)	Add facet criteria components to the search criteria manager.
protected void	_addIndexingFieldCriteriaComponents(Set<ContentType> commonContentTypes, Configuration conf, List<String> searchCriteriaRoles, String fieldRef, I18nizableText group)	Add a indexing field criteria component to the manager.
protected void	_addMetadataColumnComponents(Set<ContentType> commonContentTypes, Configuration conf, String metadataPath, List<String> columnsRolesToLookup)	Add a metadata column component to the manager.
protected void	_addSystemColumnComponent(Set<ContentType> commonContentTypes, Configuration originalConf, String property, List<String> columnsRolesToLookup)	Add a system column component to the manager.
protected void	_addSystemCriteriaComponents(Set<ContentType> commonContentTypes, Configuration originalConf, List<String> searchCriteriaRoles, String property, I18nizableText group)	Add a system criteria component to the manager.
protected Set<String>	_configureBaseContentTypes(Configuration configuration)	Configure the base content type ids.
protected Map<String,SearchUIColumn>	_configureColumns(List<String> columnRoles)	Lookup all the configured columns in the manager.
protected void	_configureContentTypes(Configuration configuration)	Configure the content type ids
protected void	_configureCriteria(Map<String,SearchUICriterion> criteriaMap, List<String> criteriaRoles, boolean checkFacetable)	Lookup the previously initialized criteria components and fill the given map with them.
protected void	_copyAdvancedCriteria(Map<String,SearchUICriterion> advancedCriteria, Collection<SearchUICriterion> criteria)	Copy all the allowed search criteria to the given criteria map.
protected void	_copyFacetableCriteria(Map<String,SearchUICriterion> facetedCriteria, Collection<SearchUICriterion> criteria)	Copy all the facetable search criteria to the given criteria map.
protected boolean	_isAdvanced(SearchUICriterion criterion)	Test if a search criterion can be used in advanced search mode.
protected boolean	_isValidContentType(String id, List<String> excludedTags, List<String> excludedContentTypes)	Determines if the content type is a valid content type in current configuration
boolean	allowSortOnMultipleJoin()	Indicates if sorting on join columns which contain at least one multiple definition in its path (intermediate ones only) must be allowed.
void	configure(Configuration configuration)
void	dispose()
Set<String>	getContentTypes(Map<String,Object> contextualParameters)	Get the list of content types.
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters)	Get the list of excluded content types.
String	getExportCSVUrl(Map<String,Object> contextualParameters)	Get the URL for CSV export of results
String	getExportCSVUrlPlugin(Map<String,Object> contextualParameters)	Get the plugin name for CSV 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
int	getPageSize(Map<String,Object> contextualParameters)	Get the page size.
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
String	getSearchUrl(Map<String,Object> contextualParameters)	Get the URL for search
String	getSearchUrlPlugin(Map<String,Object> contextualParameters)	Get the plugin name for search
String	getSummaryView()	Get the name of the view to use for summary of the content.
String	getWorkspace(Map<String,Object> contextualParameters)	Get the specific workspace to use.
void	service(ServiceManager manager)

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

addContentTypesConfiguration, contextualize, getAdvancedCriteria, getCriteria, getCustomCriteriaConfiguration, getFacetedCriteria, getIndexingFieldCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getLogger, getMetadataColumnConfiguration, getMetadataColumnConfiguration, getResultFields, getSystemColumnConfiguration, getSystemColumnConfiguration, getSystemCriteriaConfiguration, getSystemCriteriaConfiguration, getSystemCriteriaConfiguration, 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, getCriterion, getFacetedCriterion, getResultField

Field Details

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The content type helper.

_columnHelper

protected ColumnHelper _columnHelper

The helper for columns

_searchCriterionManager

protected ThreadSafeComponentManager<SearchUICriterion> _searchCriterionManager

ComponentManager for SearchUICriterions.

_searchColumnManager

protected ThreadSafeComponentManager<SearchUIColumn> _searchColumnManager

ComponentManager for SearchUIColumns.

_systemPropEP

protected SystemPropertyExtensionPoint _systemPropEP

The system property extension point.

Constructor Details

StaticSearchUIModel

public StaticSearchUIModel()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSearchUIModel

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

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.

getPageSize

public int getPageSize(Map<String,Object> contextualParameters)

Description copied from interface: SearchUIModel

Get the page size.

Specified by:

getPageSize in interface SearchUIModel

Overrides:

getPageSize in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

The page size, unlimited or default used when negative or 0.

getWorkspace

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

Description copied from interface: SearchUIModel

Get the specific workspace to use.

Specified by:

getWorkspace in interface SearchUIModel

Overrides:

getWorkspace in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters.

Returns:

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

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 CSV export of results

Specified by:

getExportCSVUrl in interface SearchUIModel

Overrides:

getExportCSVUrl in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for CSV export

getExportCSVUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for CSV export of results

Specified by:

getExportCSVUrlPlugin in interface SearchUIModel

Overrides:

getExportCSVUrlPlugin in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for CSV 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 DOC 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 DOC 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

getSummaryView

public String getSummaryView()

Description copied from interface: SearchUIModel

Get the name of the view to use for summary of the content.

Specified by:

getSummaryView in interface SearchUIModel

Overrides:

getSummaryView in class AbstractSearchUIModel

Returns:

the name of the view to use for summary of the content. Can be null.

allowSortOnMultipleJoin

public boolean allowSortOnMultipleJoin()

Description copied from interface: SearchUIModel

Indicates if sorting on join columns which contain at least one multiple definition 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.

Specified by:

allowSortOnMultipleJoin in interface SearchUIModel

Returns:

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

_configureContentTypes

protected void _configureContentTypes(Configuration configuration)
                               throws ConfigurationException

Configure the content type ids

Parameters:

configuration - The content types configuration

Throws:

ConfigurationException - If an error occurs

_configureBaseContentTypes

protected Set<String> _configureBaseContentTypes(Configuration configuration)
                                          throws ConfigurationException

Configure the base content type ids.

Parameters:

configuration - The content types configuration

Returns:

The set of base content type ids

Throws:

ConfigurationException - If an error occurs

_isValidContentType

protected boolean _isValidContentType(String id,
 List<String> excludedTags,
 List<String> excludedContentTypes)

Determines if the content type is a valid content type in current configuration

Parameters:

id - The content type id

excludedTags - The tags to exclude

excludedContentTypes - The content types to exclude

Returns:

true if the content type is a valid content type

_addCriteriaComponents

protected void _addCriteriaComponents(Set<ContentType> commonContentTypes,
 Configuration configuration,
 List<String> searchCriteriaRoles)
                               throws ConfigurationException

Add criteria components to the search criteria manager.

Parameters:

commonContentTypes - the model's common content types.

configuration - the model configuration.

searchCriteriaRoles - the criteria role list to fill.

Throws:

ConfigurationException - if an error occurs.

_addCriteriaComponents

protected void _addCriteriaComponents(Set<ContentType> commonContentTypes,
 Configuration configuration,
 List<String> searchCriteriaRoles,
 I18nizableText group)
                               throws ConfigurationException

Add standard criteria components to the search criteria manager.

Parameters:

commonContentTypes - the model's common content types.

configuration - the model configuration.

searchCriteriaRoles - the criteria role list to fill.

group - the criteria group.

Throws:

ConfigurationException - if an error occurs.

_addFacetCriteriaComponents

protected void _addFacetCriteriaComponents(Set<ContentType> commonContentTypes,
 Configuration configuration,
 List<String> searchCriteriaRoles)
                                    throws ConfigurationException

Add facet criteria components to the search criteria manager.

Parameters:

commonContentTypes - the model's common content types.

configuration - the model configuration.

searchCriteriaRoles - the criteria role list to fill.

Throws:

ConfigurationException - if an error occurs.

_addIndexingFieldCriteriaComponents

protected void _addIndexingFieldCriteriaComponents(Set<ContentType> commonContentTypes,
 Configuration conf,
 List<String> searchCriteriaRoles,
 String fieldRef,
 I18nizableText group)
                                            throws ConfigurationException

Add a indexing field criteria component to the manager.

Parameters:

commonContentTypes - the model common content types.

conf - the criteria configuration.

searchCriteriaRoles - the criteria role list to fill.

fieldRef - the field path.

group - The group.

Throws:

ConfigurationException - if an error occurs.

_addSystemCriteriaComponents

protected void _addSystemCriteriaComponents(Set<ContentType> commonContentTypes,
 Configuration originalConf,
 List<String> searchCriteriaRoles,
 String property,
 I18nizableText group)
                                     throws ConfigurationException

Add a system criteria component to the manager.

Parameters:

commonContentTypes - the model common content types.

originalConf - the criteria configuration.

searchCriteriaRoles - the criteria role list to fill.

property - the system property id.

group - The group.

Throws:

ConfigurationException - if an error occurs.

_addCustomCriteriaComponents

protected void _addCustomCriteriaComponents(Set<ContentType> commonContentTypes,
 Configuration conf,
 List<String> searchCriteriaRoles,
 String searchCriterionId,
 I18nizableText group)
                                     throws ConfigurationException

Add a custom criteria component to the manager.

Parameters:

commonContentTypes - the model common content types.

conf - the criteria configuration.

searchCriteriaRoles - the criteria role list to fill.

searchCriterionId - the custom criteria id.

group - The group. Can be null.

Throws:

ConfigurationException - if an error occurs.

_configureCriteria

protected void _configureCriteria(Map<String,SearchUICriterion> criteriaMap,
 List<String> criteriaRoles,
 boolean checkFacetable)
                           throws ConfigurationException

Lookup the previously initialized criteria components and fill the given map with them.

Parameters:

criteriaMap - the criteria map to fill.

criteriaRoles - the roles of the criteria components to lookup.

checkFacetable - true to check if the criteria are facetable.

Throws:

ConfigurationException - if an error occurs.

_copyAdvancedCriteria

protected void _copyAdvancedCriteria(Map<String,SearchUICriterion> advancedCriteria,
 Collection<SearchUICriterion> criteria)
                              throws ConfigurationException

Copy all the allowed search criteria to the given criteria map.

Parameters:

advancedCriteria - the criteria map to fill.

criteria - the source criteria collection.

Throws:

ConfigurationException - if an error occurs.

_copyFacetableCriteria

protected void _copyFacetableCriteria(Map<String,SearchUICriterion> facetedCriteria,
 Collection<SearchUICriterion> criteria)
                               throws ConfigurationException

Copy all the facetable search criteria to the given criteria map.

Parameters:

facetedCriteria - the criteria map to fill.

criteria - the source criteria collection.

Throws:

ConfigurationException - if an error occurs.

_isAdvanced

protected boolean _isAdvanced(SearchUICriterion criterion)

Test if a search criterion can be used in advanced search mode. For instance: geocode, rich-text, file-typed criterion are not allowed.

Parameters:

criterion - the search criterion to test.

Returns:

true if the criterion can be used in advanced search mode, false otherwise.

_addColumnsComponents

protected void _addColumnsComponents(Set<ContentType> commonContentTypes,
 Configuration configuration,
 List<String> columnsRolesToLookup)
                              throws ConfigurationException

Add column components to the result column manager.

Parameters:

commonContentTypes - the model's common content types.

configuration - the model configuration.

columnsRolesToLookup - The list of column roles to lookup that will be filled by the method.

Throws:

ConfigurationException - if an error occurs.

_addMetadataColumnComponents

protected void _addMetadataColumnComponents(Set<ContentType> commonContentTypes,
 Configuration conf,
 String metadataPath,
 List<String> columnsRolesToLookup)
                                     throws ConfigurationException

Add a metadata column component to the manager.

Parameters:

commonContentTypes - the model common content types.

conf - the column configuration.

metadataPath - the metadata path, separated by '/'.

columnsRolesToLookup - The list to fill with the column roles to lookup when the manager is initialized.

Throws:

ConfigurationException - if an error occurs.

_addSystemColumnComponent

protected void _addSystemColumnComponent(Set<ContentType> commonContentTypes,
 Configuration originalConf,
 String property,
 List<String> columnsRolesToLookup)
                                  throws ConfigurationException

Add a system column component to the manager.

Parameters:

commonContentTypes - the model common content types.

originalConf - the column configuration.

property - the system property.

columnsRolesToLookup - The list to fill with the column roles to lookup when the manager is initialized.

Throws:

ConfigurationException - if an error occurs.

_addCustomColumnComponent

protected void _addCustomColumnComponent(Set<ContentType> commonContentTypes,
 Configuration conf,
 String customId,
 List<String> columnsRolesToLookup)
                                  throws ConfigurationException

Add a custom column component to the manager.

Parameters:

commonContentTypes - the model common content types.

conf - the column configuration.

customId - the custom column id.

columnsRolesToLookup - The list to fill with the column roles to lookup when the manager is initialized.

Throws:

ConfigurationException - if an error occurs.

_configureColumns

protected Map<String,SearchUIColumn> _configureColumns(List<String> columnRoles)
                                                throws Exception

Lookup all the configured columns in the manager.

Parameters:

columnRoles - The list of column roles added to the component manager.

Returns:

the list of search columns.

Throws:

Exception - if an error occurs.