Package org.ametys.cms.search.model

Class DefaultSearchModel

java.lang.Object

org.ametys.cms.search.model.DefaultSearchModel

All Implemented Interfaces:

SearchModel

Direct Known Subclasses:

DefaultSearchUIModel

public class DefaultSearchModel
extends Object
implements SearchModel

Default implementation of a SearchModel.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,SearchCriterion>	_criteria	The simple search criteria, 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,SearchCriterion>	_facetedCriteria	The faceted search criteria, indexed by ID.
protected ViewItemContainer	_resultItems	The result items
protected String	_workspace	the workspace

Constructor Summary

Constructors

Constructor	Description
DefaultSearchModel()	Default constructor.
DefaultSearchModel(SearchModel searchModelToCopy, Map<String,Object> contextualParameters)	Constructor by copying an existing SearchModel.

Method Summary

Modifier and Type	Method	Description
void	addCriterion(SearchCriterion criterion)	Add a criterion
void	addFacetedCriterion(SearchCriterion criterion)	Add a faceted criterion
Set<String>	getContentTypes(Map<String,Object> contextualParameters)	Get the list of content types.
Map<String,? extends SearchCriterion>	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.
Map<String,? extends SearchCriterion>	getFacetedCriteria(Map<String,Object> contextualParameters)	Get the list of faceted search criteria.
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
String	getWorkspace(Map<String,Object> contextualParameters)	Get the specific workspace to use.
void	setContentTypes(Set<String> cTypes)	Set the content types of the models
void	setCriteria(Collection<? extends SearchCriterion> criteria)	Set the criteria
void	setExcludedContentTypes(Set<String> cTypes)	Set the content types to exclude
void	setFacetedCriteria(Collection<? extends SearchCriterion> criteria)	Set the faceted criteria
void	setResulItems(ViewItemContainer resultItems)	Set the result items
void	setWorkspace(String workspace)	Set the workspace

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

getCriterion, getFacetedCriterion, getResultItem

Field Details

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

_criteria

protected Map<String,SearchCriterion> _criteria

The simple search criteria, indexed by ID.

_facetedCriteria

protected Map<String,SearchCriterion> _facetedCriteria

The faceted search criteria, indexed by ID.

_resultItems

protected ViewItemContainer _resultItems

The result items

_workspace

protected String _workspace

the workspace

Constructor Details

DefaultSearchModel

public DefaultSearchModel()

Default constructor.

DefaultSearchModel

public DefaultSearchModel(SearchModel searchModelToCopy,
 Map<String,Object> contextualParameters)

Constructor by copying an existing SearchModel.

Parameters:

searchModelToCopy - The SearchModel to copy

contextualParameters - The contextual parameters

Method Details

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 of the models

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 content types to exclude

Parameters:

cTypes - The content types to exclude

getCriteria

public Map<String,? extends SearchCriterion> 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

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

addCriterion

public void addCriterion(SearchCriterion criterion)

Add a criterion

Parameters:

criterion - the criterion to add

setCriteria

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

Set the criteria

Parameters:

criteria - The criteria list

getFacetedCriteria

public Map<String,? extends SearchCriterion> getFacetedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of faceted search criteria.

Specified by:

getFacetedCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of faceted search criteria.

addFacetedCriterion

public void addFacetedCriterion(SearchCriterion criterion)

Add a faceted criterion

Parameters:

criterion - the faceted criterion to add

setFacetedCriteria

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

Set the faceted criteria

Parameters:

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

setResulItems

public void setResulItems(ViewItemContainer resultItems)

Set the result items

Parameters:

resultItems - The result items to set

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.

setWorkspace

public void setWorkspace(String workspace)

Set the workspace

Parameters:

workspace - The workspace to set