org.ametys.cms.search.ui.model

Class DynamicWrappedSearchUIModel

java.lang.Object

org.ametys.cms.search.ui.model.DynamicWrappedSearchUIModel

All Implemented Interfaces:

SearchModel, SearchUIModel

public class DynamicWrappedSearchUIModel
extends Object
implements SearchUIModel

Dynamic search model wrapping a search model with a restriction on content types

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DynamicWrappedSearchUIModel.WrappedSearchUICriterion Search criteria wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
private ThreadSafeComponentManager<Enumerator>	_enumeratorManager
private Logger	_logger
private Set<String>	_restrictedContentTypes
private Set<String>	_restrictedMixins
private SearchUIModel	_wrappedModel

Constructor Summary

Constructors

Constructor and Description
DynamicWrappedSearchUIModel(SearchUIModel model, Collection<String> restrictedContentTypes, ContentTypeExtensionPoint cTypeEP, Logger logger, Context context, ServiceManager manager) Constructor

Method Summary

Modifier and Type	Method and Description
private void	_addContentTypeAndMixinEnumeratorComponent()
private void	_addContentTypeEnumeratorComponent()
private void	_addMixinEnumeratorComponent()
Map<String,SearchUICriterion>	getAdvancedCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in advanced mode
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
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.
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
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
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.
protected SearchUICriterion	wrap(SearchUICriterion criteria) Wrap an existing search criteria.

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, getFacetedCriterion

Field Detail

_enumeratorManager

private ThreadSafeComponentManager<Enumerator> _enumeratorManager

_logger

private Logger _logger

_wrappedModel

private SearchUIModel _wrappedModel

_restrictedContentTypes

private Set<String> _restrictedContentTypes

_restrictedMixins

private Set<String> _restrictedMixins

Constructor Detail

DynamicWrappedSearchUIModel

public DynamicWrappedSearchUIModel(SearchUIModel model,
                                   Collection<String> restrictedContentTypes,
                                   ContentTypeExtensionPoint cTypeEP,
                                   Logger logger,
                                   Context context,
                                   ServiceManager manager)

Constructor

Parameters:

model - The wrapped search model

restrictedContentTypes - The restricted content types

cTypeEP - The content type extension point

logger - The logger

context - The context

manager - The service manager

Method Detail

_addContentTypeEnumeratorComponent

private void _addContentTypeEnumeratorComponent()

_addContentTypeAndMixinEnumeratorComponent

private void _addContentTypeAndMixinEnumeratorComponent()

_addMixinEnumeratorComponent

private void _addMixinEnumeratorComponent()

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.

getSearchUrl

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

Description copied from interface: SearchUIModel

Get the URL for search

Specified by:

getSearchUrl in interface SearchUIModel

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

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

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

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

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

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

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

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

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

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

Returns:

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

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

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

Specified by:

getCriterion in interface SearchModel

Specified by:

getCriterion in interface SearchUIModel

Parameters:

id - The search criterion id

contextualParameters - the contextual parameters

Returns:

the criterion or null if not found

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

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

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

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

Specified by:

getResultField in interface SearchModel

Specified by:

getResultField in interface SearchUIModel

Parameters:

id - The column id

contextualParameters - the contextual parameters

Returns:

the column

getPageSize

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

Description copied from interface: SearchUIModel

Get the page size.

Specified by:

getPageSize in interface SearchUIModel

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

Parameters:

contextualParameters - the contextual parameters.

Returns:

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

wrap

protected SearchUICriterion wrap(SearchUICriterion criteria)

Wrap an existing search criteria.

Parameters:

criteria - the search criteria to wrap.

Returns:

the wrapped search criteria.