org.ametys.cms.search.ui.model

Class ReferenceTableSearchUIModel

java.lang.Object

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

org.ametys.cms.search.ui.model.ReferenceTableSearchUIModel

All Implemented Interfaces:

SearchModel, SearchUIModel, LogEnabled, Configurable, Contextualizable, Serviceable

public class ReferenceTableSearchUIModel
extends AbstractSearchUIModel
implements Configurable

Generic implementation of SearchUIModel for reference tables The search tool model automatically declares simple first level metadatas as criteria and columns.

Field Summary

Fields

Modifier and Type	Field and Description
protected HierarchicalReferenceTablesHelper	_hierarchicalReferenceTableContentsHelper The helper component for hierarchical reference tables
protected ThreadSafeComponentManager<SearchUIColumn>	_searchColumnManager ComponentManager for SearchUIColumns.
protected List<String>	_searchColumnRoles The search column roles.
protected ThreadSafeComponentManager<SearchUICriterion>	_searchCriteriaManager ComponentManager for SearchUICriterions.
protected List<String>	_searchCriteriaRoles The search criteria roles.

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
ReferenceTableSearchUIModel()

Method Summary

Modifier and Type	Method and Description
protected boolean	_filterMetadata(MetadataDefinition metadataDefinition) Returns true if metadata can be used as criteria and column search UI
protected void	addColumnComponents(ContentType cType) Add column components to the manager.
protected void	addCriteriaComponents(ContentType cType) Add criteria components to the manager.
protected void	addExcludeCandidateSystemCriterionComponent(ContentType cType) Add criteria component to exclude the candidates
protected void	addLikeTitleCriterionComponent(ContentType contentType) Add the title metadata criterion component to the manager, with a 'LIKE' operator and an hidden widget
protected void	addMetadataColumnComponent(ContentType contentType, String metadataName) Add a metadata column component to the manager.
protected void	addMetadataCriterionComponent(ContentType contentType, String metadataName, Query.Operator operator) Add a metadata criterion component to the manager.
protected void	addSystemColumnComponent(ContentType contentType, String property) Add a system column component to the manager.
protected void	addSystemCriterionComponent(ContentType contentType, String property) Add a system criterion component to the manager.
void	configure(Configuration configuration)
Map<String,SearchUICriterion>	getAdvancedCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in advanced mode
protected List<SearchUIColumn>	getColumns(ContentType cType) Lookup all the columns.
Map<String,SearchUICriterion>	getCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in simple mode
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters) Get the list of excluded content types.
Map<String,SearchUICriterion>	getFacetedCriteria(Map<String,Object> contextualParameters) Get the list of faceted search criteria.
Map<String,SearchUIColumn>	getResultFields(Map<String,Object> contextualParameters) Get the column for results
protected List<SearchUICriterion>	getSearchUICriteria(ContentType cType) Lookup all the criteria.
void	service(ServiceManager smanager)

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

addContentTypesConfiguration, contextualize, getContentTypes, getCustomCriteriaConfiguration, getExportCSVUrl, getExportCSVUrlPlugin, getExportDOCUrl, getExportDOCUrlPlugin, getExportXMLUrl, getExportXMLUrlPlugin, getIndexingFieldCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getIndexingFieldCriteriaConfiguration, getLogger, getMetadataColumnConfiguration, getMetadataColumnConfiguration, getPageSize, getPrintUrl, getPrintUrlPlugin, getSearchUrl, getSearchUrlPlugin, 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

allowSortOnMultipleJoin, getAdvancedCriterion, getCriterion, getFacetedCriterion, getResultField

Field Detail

_searchCriteriaManager

protected ThreadSafeComponentManager<SearchUICriterion> _searchCriteriaManager

ComponentManager for SearchUICriterions.

_searchColumnManager

protected ThreadSafeComponentManager<SearchUIColumn> _searchColumnManager

ComponentManager for SearchUIColumns.

_searchCriteriaRoles

protected List<String> _searchCriteriaRoles

The search criteria roles.

_searchColumnRoles

protected List<String> _searchColumnRoles

The search column roles.

_hierarchicalReferenceTableContentsHelper

protected HierarchicalReferenceTablesHelper _hierarchicalReferenceTableContentsHelper

The helper component for hierarchical reference tables

Constructor Detail

ReferenceTableSearchUIModel

public ReferenceTableSearchUIModel()

Method Detail

service

public void service(ServiceManager smanager)
             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

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.

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

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.

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

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

addCriteriaComponents

protected void addCriteriaComponents(ContentType cType)
                              throws ConfigurationException,
                                     ComponentException

Add criteria components to the manager.

Parameters:

cType - the simple content type.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addExcludeCandidateSystemCriterionComponent

protected void addExcludeCandidateSystemCriterionComponent(ContentType cType)

Add criteria component to exclude the candidates

Parameters:

cType - the simple content type

_filterMetadata

protected boolean _filterMetadata(MetadataDefinition metadataDefinition)

Returns true if metadata can be used as criteria and column search UI

Parameters:

metadataDefinition - the metadata definition

Returns:

true

addLikeTitleCriterionComponent

protected void addLikeTitleCriterionComponent(ContentType contentType)
                                       throws ConfigurationException,
                                              ComponentException

Add the title metadata criterion component to the manager, with a 'LIKE' operator and an hidden widget

Parameters:

contentType - the simple content type.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addMetadataCriterionComponent

protected void addMetadataCriterionComponent(ContentType contentType,
                                             String metadataName,
                                             Query.Operator operator)
                                      throws ConfigurationException,
                                             ComponentException

Add a metadata criterion component to the manager.

Parameters:

contentType - the simple content type.

metadataName - the metadata name.

operator - the criterion operator.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addSystemCriterionComponent

protected void addSystemCriterionComponent(ContentType contentType,
                                           String property)
                                    throws ConfigurationException,
                                           ComponentException

Add a system criterion component to the manager.

Parameters:

contentType - the simple content type.

property - the system property.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

getSearchUICriteria

protected List<SearchUICriterion> getSearchUICriteria(ContentType cType)
                                               throws ComponentException

Lookup all the criteria.

Parameters:

cType - the simple content type.

Returns:

the search criteria list.

Throws:

ComponentException - if a component cannot be looked up.

addColumnComponents

protected void addColumnComponents(ContentType cType)
                            throws ConfigurationException,
                                   ComponentException

Add column components to the manager.

Parameters:

cType - the simple content type.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addMetadataColumnComponent

protected void addMetadataColumnComponent(ContentType contentType,
                                          String metadataName)
                                   throws ConfigurationException,
                                          ComponentException

Add a metadata column component to the manager.

Parameters:

contentType - the simple content type.

metadataName - the metadata name.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addSystemColumnComponent

protected void addSystemColumnComponent(ContentType contentType,
                                        String property)
                                 throws ConfigurationException,
                                        ComponentException

Add a system column component to the manager.

Parameters:

contentType - the simple content type.

property - the system property.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

getColumns

protected List<SearchUIColumn> getColumns(ContentType cType)
                                   throws ComponentException

Lookup all the columns.

Parameters:

cType - the simple content type.

Returns:

the search column list.

Throws:

ComponentException - if a component cannot be looked up.