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, Model, ModelItemAccessor, ModelItemContainer

Direct Known Subclasses:

ReferenceTableSearchUIModel, ReferencingContentsWithSameValuesSearchUIModel, StaticSearchUIModel

public class DefaultSearchUIModel
extends DefaultSearchModel
implements SearchUIModel

Default implementation of a SearchUIModel.

Field Summary

Fields

Modifier and Type	Field	Description
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
DefaultSearchUIModel()	Default constructor
DefaultSearchUIModel(SearchUIModel searchUIModelToCopy, Map<String,Object> contextualParameters)	Constructor by copying an existing SearchUIModel.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_getAdvancedCriteriaListInfo(ViewItemAccessor criteria)	Return information on a list of advanced SearchModelCriterionViewItem, serialized as a Map.
void	addAdvancedCriteria(SearchModelCriterionDefinitionHelper criterionDefinitionHelper, Map<String,Object> contextualParameters, String... references)	Add criteria to the advanced criteria.
protected boolean	allowSortOnMultipleJoin()	Indicates if sorting on join columns which contain at least one multiple definition in its path (intermediate ones only) must be allowed.
ViewItemContainer	getAdvancedCriteria(Map<String,Object> contextualParameters)	Retrieves the criteria in advanced 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
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(ViewItemContainer criteria)	Set the advanced criteria
void	setAllowSortOnMultipleJoin(boolean sortOnMultipleJoin)	Set to true to allow sort on multiple join (default to false)
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	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
Map<String,Object>	toJSON(Map<String,Object> contextualParameters)	Converts the search model in a JSON map

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

_resultItemsToJSON, addCriteria, addFacetedCriteria, getContentTypes, getCriteria, getExcludedContentTypes, getFacetedCriteria, getResultItems, getWorkspace, resultItemsToJSON, setContentTypes, setCriteria, setExcludedContentTypes, setFacetedCriteria, setResultItems, 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.runtime.model.ModelItemAccessor

getChild, getModelItem, hasModelItem

Methods inherited from interface org.ametys.cms.search.model.SearchModel

getContentTypes, getCriteria, getCriterion, getExcludedContentTypes, getFacetedCriteria, getFacetedCriterion, getFamilyId, getId, getModelItems, getResultItem, getResultItems, getWorkspace, resultItemsToJSON

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

addAdvancedCriterion, addAdvancedCriterion, addCriterion, addCriterion, addFacetedCriterion, addFacetedCriterion, getAdvancedCriterion

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

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

getAdvancedCriteria

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

Description copied from interface: SearchUIModel

Retrieves the criteria in advanced mode

Specified by:

getAdvancedCriteria in interface SearchUIModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the criteria in advanced mode

addAdvancedCriteria

public void addAdvancedCriteria(SearchModelCriterionDefinitionHelper criterionDefinitionHelper,
 Map<String,Object> contextualParameters,
 String... references)

Add criteria to the advanced criteria. The created criteria reference the given paths

Parameters:

criterionDefinitionHelper - the criterion definition helper

contextualParameters - the contextual parameters

references - the paths to the items the criteria will reference

setAdvancedCriteria

public void setAdvancedCriteria(ViewItemContainer criteria)

Set the advanced criteria

Parameters:

criteria - The advanced criteria 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.

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

allowSortOnMultipleJoin

protected boolean allowSortOnMultipleJoin()

Indicates if sorting on join columns which contain at least one multiple definition in its path (intermediate ones only) must be allowed.
If the final definition of the path is multiple, the column will not be sortable though.

Returns:

true if sorting on join columns which contains at least one multiple item in its path (intermediate ones only) must be allowed.

setAllowSortOnMultipleJoin

public void setAllowSortOnMultipleJoin(boolean sortOnMultipleJoin)

Set to true to allow sort on multiple join (default to false)

Parameters:

sortOnMultipleJoin - true to allow sort on multiple join, false otherwise

toJSON

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

Description copied from interface: SearchModel

Converts the search model in a JSON map

Specified by:

toJSON in interface SearchModel

Overrides:

toJSON in class DefaultSearchModel

Parameters:

contextualParameters - The contextual parameters

Returns:

the search model as a JSON map

_getAdvancedCriteriaListInfo

protected Map<String,Object> _getAdvancedCriteriaListInfo(ViewItemAccessor criteria)

Return information on a list of advanced SearchModelCriterionViewItem, serialized as a Map.

Parameters:

criteria - A map of advanced criteria.

Returns:

the detailed information serialized in a Map.