Package 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 Serviceable, Contextualizable, Configurable

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected Context	_context	The context.
protected HierarchicalReferenceTablesHelper	_hierarchicalReferenceTableContentsHelper	The helper component for hierarchical reference tables
protected ServiceManager	_manager	The service manager
protected List<String>	_searchColumnRoles	The search column roles.
protected ThreadSafeComponentManager<SearchUICriterion>	_searchCriteriaManager	ComponentManager for SearchUICriterions.
protected List<String>	_searchCriteriaRoles	The search criteria roles.
protected SearchCriterionHelper	_searchCriterionHelper	The search criterion helper
protected SystemPropertyExtensionPoint	_systemPropertyExtensionPoint	The systemPropertyExtension point

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

_advancedSearchCriteria, _cTypes, _excludedCTypes, _facetedCriteria, _logger, _resultItems, _searchCriteria, DEFAULT_EXPORT_CSV_URL, DEFAULT_EXPORT_DOC_URL, DEFAULT_EXPORT_PDF_URL, DEFAULT_EXPORT_XML_URL, DEFAULT_PRINT_URL, DEFAULT_SEARCH_URL, DEFAULT_URL_PLUGIN

Constructor Summary

Constructors

Constructor	Description
ReferenceTableSearchUIModel()

Method Summary

Modifier and Type	Method	Description
protected List<ViewItem>	_copyAndFilterViewItemsForColumns(List<ViewItem> viewItems)	Copy the given view items and filter to keep only items that can be used in SearchUIColumns.
protected boolean	_filterModelItemForColumn(ModelItem modelItem)	Returns true if model item can be used as column search UI
protected boolean	_filterModelItemForCriteria(ModelItem modelItem)	Returns true if the model item can be used as criteria
protected ViewItemContainer	_getResultItems(ContentType contentType)	Retrieves the result items for the given content type
protected void	addAttributeCriterionComponent(ContentType contentType, String attributePath, Query.Operator operator)	Add an attribute criterion component to the manager.
protected void	addCriteriaComponents(ContentType cType)	Add criteria components to the manager.
protected void	addCriteriaComponents(ContentType cType, ViewItemContainer viewContainer)	Add criteria components to the manager.
protected void	addExcludeCandidateSystemCriterionComponent(ContentType cType)	Add criteria component to exclude the candidates
protected void	addLikeTitleCriterionComponent(ContentType contentType, String attributePath)	Add the title attribute criterion component to the manager, with a 'LIKE' operator and an hidden widget
protected void	addSystemCriterionComponent(ContentType contentType, String property)	Add a system criterion component to the manager.
void	configure(Configuration configuration)
void	contextualize(Context context)
Map<String,SearchUICriterion>	getAdvancedCriteria(Map<String,Object> contextualParameters)	Get the list of search criteria in advanced mode
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.
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
protected List<SearchUICriterion>	getSearchUICriteria(ContentType cType)	Lookup all the criteria.
void	service(ServiceManager manager)

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

getContentTypes, getExportCSVUrl, getExportCSVUrlPlugin, getExportDOCUrl, getExportDOCUrlPlugin, getExportPDFUrl, getExportPDFUrlPlugin, getExportXMLUrl, getExportXMLUrlPlugin, getLogger, getPageSize, getPrintUrl, getPrintUrlPlugin, getSearchUrl, getSearchUrlPlugin, getSummaryView, getWorkspace, setAdvancedCriteria, setContentTypes, setCriteria, setExcludedContentTypes, setFacetedCriteria, setLogger, setResultItems

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

getResultItem

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUIModel

allowSortOnMultipleJoin, getAdvancedCriterion, getCriterion, getFacetedCriterion

Field Details

_searchCriteriaManager

protected ThreadSafeComponentManager<SearchUICriterion> _searchCriteriaManager

ComponentManager for SearchUICriterions.

_searchCriteriaRoles

protected List<String> _searchCriteriaRoles

The search criteria roles.

_searchColumnRoles

protected List<String> _searchColumnRoles

The search column roles.

_context

protected Context _context

The context.

_manager

protected ServiceManager _manager

The service manager

_hierarchicalReferenceTableContentsHelper

protected HierarchicalReferenceTablesHelper _hierarchicalReferenceTableContentsHelper

The helper component for hierarchical reference tables

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_systemPropertyExtensionPoint

protected SystemPropertyExtensionPoint _systemPropertyExtensionPoint

The systemPropertyExtension point

_searchCriterionHelper

protected SearchCriterionHelper _searchCriterionHelper

The search criterion helper

Constructor Details

ReferenceTableSearchUIModel

public ReferenceTableSearchUIModel()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

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

getResultItems

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

Description copied from interface: SearchModel

Retrieves the search result items

Specified by:

getResultItems in interface SearchModel

Overrides:

getResultItems in class AbstractSearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the search result items

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.

addCriteriaComponents

protected void addCriteriaComponents(ContentType cType,
 ViewItemContainer viewContainer)
                              throws ConfigurationException,
ComponentException

Add criteria components to the manager.

Parameters:

cType - the simple content type.

viewContainer - the view item container

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addExcludeCandidateSystemCriterionComponent

protected void addExcludeCandidateSystemCriterionComponent(ContentType cType)
                                                    throws ConfigurationException

Add criteria component to exclude the candidates

Parameters:

cType - the simple content type

Throws:

ConfigurationException - if an error occurs while creating the criteria configuration

_filterModelItemForCriteria

protected boolean _filterModelItemForCriteria(ModelItem modelItem)

Returns true if the model item can be used as criteria

Parameters:

modelItem - the model item

Returns:

true if the model item can be used as criteria

addLikeTitleCriterionComponent

protected void addLikeTitleCriterionComponent(ContentType contentType,
 String attributePath)
                                       throws ConfigurationException,
ComponentException

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

Parameters:

contentType - the simple content type.

attributePath - the attribute path.

Throws:

ConfigurationException - if a configuration error occurs.

ComponentException - if a component cannot be initialized.

addAttributeCriterionComponent

protected void addAttributeCriterionComponent(ContentType contentType,
 String attributePath,
 Query.Operator operator)
                                       throws ConfigurationException,
ComponentException

Add an attribute criterion component to the manager.

Parameters:

contentType - the simple content type.

attributePath - the attribute path.

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.

_getResultItems

protected ViewItemContainer _getResultItems(ContentType contentType)

Retrieves the result items for the given content type

Parameters:

contentType - The content type

Returns:

the result items

_copyAndFilterViewItemsForColumns

protected List<ViewItem> _copyAndFilterViewItemsForColumns(List<ViewItem> viewItems)

Copy the given view items and filter to keep only items that can be used in SearchUIColumns. Also copy the children of view item accessors

Parameters:

viewItems - the view items to copy

Returns:

the view items copies

_filterModelItemForColumn

protected boolean _filterModelItemForColumn(ModelItem modelItem)

Returns true if model item can be used as column search UI

Parameters:

modelItem - the model item

Returns:

true if model item can be used as column search UI