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

Class AbstractSearchUIModel

java.lang.Object

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

All Implemented Interfaces:

SearchModel, SearchUIModel, LogEnabled

Direct Known Subclasses:

ReferenceTableSearchUIModel, ReferencingContentsWithSameValuesSearchUIModel, StaticSearchUIModel

public abstract class AbstractSearchUIModel
extends Object
implements SearchUIModel, LogEnabled

Abstract class for SearchUIModel.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,SearchUICriterion>	_advancedSearchCriteria	The search criteria in advanced mode, indexed by ID.
protected Set<String>	_cTypes	The content types of this search model.
protected Set<String>	_excludedCTypes	The content types excluded from this search model.
protected Map<String,SearchUICriterion>	_facetedCriteria	The search criteria used as facets, indexed by ID.
protected Logger	_logger	The logger.
protected ViewItemContainer	_resultItems	The result columns
protected Map<String,SearchUICriterion>	_searchCriteria	The search criteria in simple mode, indexed by ID.
protected static final String	DEFAULT_EXPORT_CSV_URL	The default URL for CSV export
protected static final String	DEFAULT_EXPORT_DOC_URL	The default URL for DOC export
protected static final String	DEFAULT_EXPORT_PDF_URL	The default URL for PDF export
protected static final String	DEFAULT_EXPORT_XML_URL	The default URL for XML export
protected static final String	DEFAULT_PRINT_URL	The URL for print results
protected static final String	DEFAULT_SEARCH_URL	The default URL for search
protected static final String	DEFAULT_URL_PLUGIN	The default plugin name for URLs

Constructor Summary

Constructors

Constructor	Description
AbstractSearchUIModel()

Method Summary

Modifier and Type	Method	Description
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
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	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.
protected final Logger	getLogger()	Get the logger.
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
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
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	setAdvancedCriteria(Collection<SearchUICriterion> criteria)	Set the criteria in advanced mode.
void	setContentTypes(Set<String> cTypes)	Set the content types.
void	setCriteria(Collection<SearchUICriterion> criteria)	Set the criteria in simple mode.
void	setExcludedContentTypes(Set<String> cTypes)	Set the excluded content types.
void	setFacetedCriteria(Collection<SearchCriterion> criteria)	Set the criteria to use as facets.
void	setLogger(Logger logger)	Called at creation time to provide a Logger.
void	setResultItems(ViewItemContainer resultItems)	Set the result items

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

DEFAULT_URL_PLUGIN

protected static final String DEFAULT_URL_PLUGIN

The default plugin name for URLs

See Also:

• Constant Field Values

DEFAULT_SEARCH_URL

protected static final String DEFAULT_SEARCH_URL

The default URL for search

See Also:

• Constant Field Values

DEFAULT_EXPORT_CSV_URL

protected static final String DEFAULT_EXPORT_CSV_URL

The default URL for CSV export

See Also:

• Constant Field Values

DEFAULT_EXPORT_DOC_URL

protected static final String DEFAULT_EXPORT_DOC_URL

The default URL for DOC export

See Also:

• Constant Field Values

DEFAULT_EXPORT_XML_URL

protected static final String DEFAULT_EXPORT_XML_URL

The default URL for XML export

See Also:

• Constant Field Values

DEFAULT_EXPORT_PDF_URL

protected static final String DEFAULT_EXPORT_PDF_URL

The default URL for PDF export

DEFAULT_PRINT_URL

protected static final String DEFAULT_PRINT_URL

The URL for print results

See Also:

• Constant Field Values

_logger

protected Logger _logger

The logger.

_cTypes

protected Set<String> _cTypes

The content types of this search model.

_excludedCTypes

protected Set<String> _excludedCTypes

The content types excluded from this search model.

_searchCriteria

protected Map<String,SearchUICriterion> _searchCriteria

The search criteria in simple mode, indexed by ID.

_advancedSearchCriteria

protected Map<String,SearchUICriterion> _advancedSearchCriteria

The search criteria in advanced mode, indexed by ID.

_facetedCriteria

protected Map<String,SearchUICriterion> _facetedCriteria

The search criteria used as facets, indexed by ID.

_resultItems

protected ViewItemContainer _resultItems

The result columns

Constructor Details

AbstractSearchUIModel

public AbstractSearchUIModel()

Method Details

setLogger

public void setLogger(Logger logger)

Description copied from interface: LogEnabled

Called at creation time to provide a Logger.

Specified by:

setLogger in interface LogEnabled

Parameters:

logger - a Logger for messages.

getLogger

protected final Logger getLogger()

Get the logger.

Returns:

the logger.

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.

setContentTypes

public void setContentTypes(Set<String> cTypes)

Set the content types.

Parameters:

cTypes - The 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.

setExcludedContentTypes

public void setExcludedContentTypes(Set<String> cTypes)

Set the excluded content types.

Parameters:

cTypes - The 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

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

setCriteria

public void setCriteria(Collection<SearchUICriterion> criteria)

Set the criteria in simple mode.

Parameters:

criteria - A collection of 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

setAdvancedCriteria

public void setAdvancedCriteria(Collection<SearchUICriterion> criteria)

Set the criteria in advanced mode.

Parameters:

criteria - A collection of search criteria.

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.

setFacetedCriteria

public void setFacetedCriteria(Collection<SearchCriterion> criteria)

Set the criteria to use as facets.

Parameters:

criteria - A collection of search criteria.

getResultItems

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

Description copied from interface: SearchModel

Retrieves the search result items

Specified by:

getResultItems in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the search result items

setResultItems

public void setResultItems(ViewItemContainer resultItems)

Set the result items

Parameters:

resultItems - The result items to set

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: SearchModel

Get the specific workspace to use.

Specified by:

getWorkspace in interface SearchModel

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

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

Specified by:

getExportCSVUrl in interface SearchUIModel

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

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

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

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

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

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

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

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.