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

Class DefaultSearchUIModel

java.lang.Object

org.ametys.cms.search.model.DefaultSearchModel

org.ametys.cms.search.ui.model.impl.DefaultSearchUIModel

All Implemented Interfaces:

SearchModel, SearchUIModel

public class DefaultSearchUIModel
extends DefaultSearchModel
implements SearchUIModel

Default implementation of a SearchUIModel.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_exportCSVUrl	The URL for CSV export of results
protected String	_exportCSVUrlPlugin	The plugin name for CSV export of results
protected String	_exportDOCUrl	The URL for doc export of results
protected String	_exportDOCUrlPlugin	The plugin name for doc export of results
protected String	_exportPDFUrl	The URL for PDF export of results
protected String	_exportPDFUrlPlugin	The plugin name for PDF export of results
protected String	_exportXMLUrl	The URL for XML export of results
protected String	_exportXMLUrlPlugin	The plugin name for XML export of results
protected int	_pageSize	The page size
protected String	_printUrl	The URL for print results
protected String	_printUrlPlugin	The plugin name for print results
protected String	_searchUrl	The URL for search
protected String	_searchUrlPlugin	The plugin name for search
protected String	_summaryView	The name of the view to use for summary of the content
protected Map<String,SearchUICriterion>	_uiAdvancedCriteria	The advanced search ui criteria, indexed by ID.
protected Map<String,SearchUICriterion>	_uiCriteria	The simple search ui criteria, indexed by ID.
protected Map<String,SearchUICriterion>	_uiFacetedCriteria	The faceted search ui criteria, indexed by ID.

Fields inherited from class org.ametys.cms.search.model.DefaultSearchModel

_criteria, _cTypes, _excludedCTypes, _facetedCriteria, _resultItems, _workspace

Constructor Summary

Constructors

Constructor	Description
DefaultSearchUIModel()	Default constructor.
DefaultSearchUIModel(SearchUIModel searchUIModelToCopy, Map<String,Object> contextualParameters)	Constructor by copying an existing SearchUIModel.

Method Summary

Modifier and Type	Method	Description
void	addAdvancedCriterion(SearchUICriterion criterion)	Add an advanced criterion
void	addCriterion(SearchCriterion criterion)	Add a criterion
void	addFacetedCriterion(SearchCriterion criterion)	Add a faceted criterion
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
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	getExportPDFUrl(Map<String,Object> contextualParameters)	Get the URL for PDF export of results
String	getExportPDFUrlPlugin(Map<String,Object> contextualParameters)	Get the plugin name for PDF 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
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.
void	setAdvancedCriteria(Collection<? extends SearchUICriterion> criteria)	Set the advanced criteria
void	setCriteria(Collection<? extends SearchCriterion> criteria)	Set the criteria
void	setExportCSVUrl(String exportCSVUrl)	Set the URL for CSV export of results
void	setExportCSVUrlPlugin(String exportCSVUrlPlugin)	Set the plugin name for CSV export of results
void	setExportDOCUrl(String exportDOCUrl)	Set the URL for Doc export of results
void	setExportDOCUrlPlugin(String exportDOCUrlPlugin)	Set the plugin name for Doc export of results
void	setExportPDFUrl(String exportPDFUrl)	Set the URL for PDF export of results
void	setExportPDFUrlPlugin(String exportPDFUrlPlugin)	Set the plugin name for PDF export of results
void	setExportXMLUrl(String exportXMLUrl)	Set the URL for XML export of results
void	setExportXMLUrlPlugin(String exportXMLUrlPlugin)	Set the plugin name for XML export of results
void	setFacetedCriteria(Collection<? extends SearchCriterion> criteria)	Set the faceted criteria
void	setPageSize(int pageSize)	Set the page size
void	setPrintUrl(String printUrl)	Set the URL for print results
void	setPrintUrlPlugin(String printUrlPlugin)	Set the plugin name for print results
void	setSearchUrl(String searchUrl)	Set the URL for search
void	setSearchUrlPlugin(String searchUrlPlugin)	Set the plugin name for search
void	setSummaryView(String summaryView)	Set The name of the view to use for summary of the content

Methods inherited from class org.ametys.cms.search.model.DefaultSearchModel

getContentTypes, getExcludedContentTypes, getResultItems, getWorkspace, setContentTypes, setExcludedContentTypes, setResulItems, setWorkspace

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

getContentTypes, getExcludedContentTypes, getResultItem, getResultItems, getWorkspace

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

allowSortOnMultipleJoin, getAdvancedCriterion, getCriterion, getFacetedCriterion

Field Details

_uiCriteria

protected Map<String,SearchUICriterion> _uiCriteria

The simple search ui criteria, indexed by ID.

_uiFacetedCriteria

protected Map<String,SearchUICriterion> _uiFacetedCriteria

The faceted search ui criteria, indexed by ID.

_uiAdvancedCriteria

protected Map<String,SearchUICriterion> _uiAdvancedCriteria

The advanced search ui criteria, indexed by ID.

_pageSize

protected int _pageSize

The page size

_searchUrl

protected String _searchUrl

The URL for search

_searchUrlPlugin

protected String _searchUrlPlugin

The plugin name for search

_exportCSVUrl

protected String _exportCSVUrl

The URL for CSV export of results

_exportCSVUrlPlugin

protected String _exportCSVUrlPlugin

The plugin name for CSV export of results

_exportDOCUrl

protected String _exportDOCUrl

The URL for doc export of results

_exportDOCUrlPlugin

protected String _exportDOCUrlPlugin

The plugin name for doc export of results

_exportXMLUrl

protected String _exportXMLUrl

The URL for XML export of results

_exportXMLUrlPlugin

protected String _exportXMLUrlPlugin

The plugin name for XML export of results

_exportPDFUrl

protected String _exportPDFUrl

The URL for PDF export of results

_exportPDFUrlPlugin

protected String _exportPDFUrlPlugin

The plugin name for PDF export of results

_printUrl

protected String _printUrl

The URL for print results

_printUrlPlugin

protected String _printUrlPlugin

The plugin name for print results

_summaryView

protected String _summaryView

The name of the view to use for summary of the content

Constructor Details

DefaultSearchUIModel

public DefaultSearchUIModel()

Default constructor.

DefaultSearchUIModel

public DefaultSearchUIModel(SearchUIModel searchUIModelToCopy,
 Map<String,Object> contextualParameters)

Constructor by copying an existing SearchUIModel.

Parameters:

searchUIModelToCopy - The SearchUIModel to copy

contextualParameters - The contextual parameters

Method Details

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 DefaultSearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

addCriterion

public void addCriterion(SearchCriterion criterion)

Description copied from class: DefaultSearchModel

Add a criterion

Overrides:

addCriterion in class DefaultSearchModel

Parameters:

criterion - the criterion to add

setCriteria

public void setCriteria(Collection<? extends SearchCriterion> criteria)

Description copied from class: DefaultSearchModel

Set the criteria

Overrides:

setCriteria in class DefaultSearchModel

Parameters:

criteria - The criteria list

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 DefaultSearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of faceted search criteria.

addFacetedCriterion

public void addFacetedCriterion(SearchCriterion criterion)

Description copied from class: DefaultSearchModel

Add a faceted criterion

Overrides:

addFacetedCriterion in class DefaultSearchModel

Parameters:

criterion - the faceted criterion to add

setFacetedCriteria

public void setFacetedCriteria(Collection<? extends SearchCriterion> criteria)

Description copied from class: DefaultSearchModel

Set the faceted criteria

Overrides:

setFacetedCriteria in class DefaultSearchModel

Parameters:

criteria - The list of faceted 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

addAdvancedCriterion

public void addAdvancedCriterion(SearchUICriterion criterion)

Add an advanced criterion

Parameters:

criterion - the advanced criterion to add

setAdvancedCriteria

public void setAdvancedCriteria(Collection<? extends SearchUICriterion> criteria)

Set the advanced criteria

Parameters:

criteria - The list of advanced criterion

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.

setPageSize

public void setPageSize(int pageSize)

Set the page size

Parameters:

pageSize - The page size to set. Set to negative or 0 for unlimited or default

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

setSearchUrl

public void setSearchUrl(String searchUrl)

Set the URL for search

Parameters:

searchUrl - The URL to set

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

setSearchUrlPlugin

public void setSearchUrlPlugin(String searchUrlPlugin)

Set the plugin name for search

Parameters:

searchUrlPlugin - the plugin name to set

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

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for CSV export

setExportCSVUrl

public void setExportCSVUrl(String exportCSVUrl)

Set the URL for CSV export of results

Parameters:

exportCSVUrl - The URL to set

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

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for CSV export

setExportCSVUrlPlugin

public void setExportCSVUrlPlugin(String exportCSVUrlPlugin)

Set the plugin name for CSV export of results

Parameters:

exportCSVUrlPlugin - the plugin name to set

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 DOC export

setExportDOCUrl

public void setExportDOCUrl(String exportDOCUrl)

Set the URL for Doc export of results

Parameters:

exportDOCUrl - The URL to set

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 DOC export

setExportDOCUrlPlugin

public void setExportDOCUrlPlugin(String exportDOCUrlPlugin)

Set the plugin name for Doc export of results

Parameters:

exportDOCUrlPlugin - the plugin name to set

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

setExportXMLUrl

public void setExportXMLUrl(String exportXMLUrl)

Set the URL for XML export of results

Parameters:

exportXMLUrl - The URL to set

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

setExportXMLUrlPlugin

public void setExportXMLUrlPlugin(String exportXMLUrlPlugin)

Set the plugin name for XML export of results

Parameters:

exportXMLUrlPlugin - the plugin name to set

getExportPDFUrl

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

Description copied from interface: SearchUIModel

Get the URL for PDF export of results

Specified by:

getExportPDFUrl in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for PDF export

setExportPDFUrl

public void setExportPDFUrl(String exportPDFUrl)

Set the URL for PDF export of results

Parameters:

exportPDFUrl - The URL to set

getExportPDFUrlPlugin

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

Description copied from interface: SearchUIModel

Get the plugin name for PDF export of results

Specified by:

getExportPDFUrlPlugin in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for PDF export

setExportPDFUrlPlugin

public void setExportPDFUrlPlugin(String exportPDFUrlPlugin)

Set the plugin name for PDF export of results

Parameters:

exportPDFUrlPlugin - the plugin name to set

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

setPrintUrl

public void setPrintUrl(String printUrl)

Set the URL for print results

Parameters:

printUrl - The URL to set

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

setPrintUrlPlugin

public void setPrintUrlPlugin(String printUrlPlugin)

Set the plugin name for print results

Parameters:

printUrlPlugin - the plugin name to set

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.

setSummaryView

public void setSummaryView(String summaryView)

Set The name of the view to use for summary of the content

Parameters:

summaryView - the name to set