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

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_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

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

TAG_PUBLIC

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
I18nizableText	getDescription()	Retrieves the description.
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
I18nizableText	getLabel()	Retrieves the label.
String	getName()	Get the name.
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.
Set<String>	getTags()	Get the registered tags for this search model
boolean	hasTag(String tagName)	Determines if the search model has the given tag
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	setDescription(I18nizableText description)	Set the description of the model
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	setLabel(I18nizableText label)	Set the label of the model
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
void	setTags(Set<String> tags)	Set the tags of this search model
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, isPublic

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_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

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Returns:

the label.

setLabel

public void setLabel(I18nizableText label)

Set the label of the model

Parameters:

label - the label

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Returns:

the description.

setDescription

public void setDescription(I18nizableText description)

Set the description of the model

Parameters:

description - the description

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

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.

setTags

public void setTags(Set<String> tags)

Set the tags of this search model

Parameters:

tags - the set of tags to set

hasTag

public boolean hasTag(String tagName)

Description copied from interface: SearchUIModel

Determines if the search model has the given tag

Specified by:

hasTag in interface SearchUIModel

Parameters:

tagName - The tag name

Returns:

true if the search model is tagged with the given tag name

getTags

public Set<String> getTags()

Description copied from interface: SearchUIModel

Get the registered tags for this search model

Specified by:

getTags in interface SearchUIModel

Returns:

the tags