Package org.ametys.cms.search.model

Class DefaultSearchModel

java.lang.Object

org.ametys.cms.search.model.DefaultSearchModel

All Implemented Interfaces:

SearchModel, Model, ModelItemAccessor, ModelItemContainer

Direct Known Subclasses:

DefaultSearchUIModel

public class DefaultSearchModel
extends Object
implements SearchModel

Default implementation of a SearchModel.

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
protected List<Object>	_resultItemsToJSON(ViewItemAccessor viewItemAccessor, DefinitionContext context)	Converts the search model's result items on a JSON map
void	addCriteria(SearchModelCriterionDefinitionHelper criterionDefinitionHelper, Map<String,Object> contextualParameters, String... references)	Add criteria to the simple criteria.
void	addFacetedCriteria(SearchModelCriterionDefinitionHelper criterionDefinitionHelper, Map<String,Object> contextualParameters, String... references)	Add criteria to the faceted criteria.
Set<String>	getContentTypes(Map<String,Object> contextualParameters)	Get the list of content types.
ViewItemContainer	getCriteria(Map<String,Object> contextualParameters)	Retrieves the criteria in simple mode
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters)	Get the list of excluded content types.
ViewItemContainer	getFacetedCriteria(Map<String,Object> contextualParameters)	Retrieves the faceted criteria.
ViewItemContainer	getResultItems(Map<String,Object> contextualParameters)	Retrieves the search result items
String	getWorkspace(Map<String,Object> contextualParameters)	Get the specific workspace to use.
List<Object>	resultItemsToJSON(Map<String,Object> contextualParameters)	Converts the search model's result items on a JSON list
void	setContentTypes(Set<String> cTypes)	Set the content types of the models
void	setCriteria(ViewItemContainer criteria)	Set the criteria
void	setExcludedContentTypes(Set<String> cTypes)	Set the content types to exclude
void	setFacetedCriteria(ViewItemContainer criteria)	Set the faceted criteria
void	setResultItems(ViewItemContainer resultItems)	Set the result items
void	setWorkspace(String workspace)	Set the workspace
Map<String,Object>	toJSON(Map<String,Object> contextualParameters)	Converts the search model in a JSON map

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

addCriterion, addFacetedCriterion, getCriterion, getFacetedCriterion, getFamilyId, getId, getModelItems, getResultItem

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 ViewItemContainer getCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Retrieves the criteria in simple mode

Specified by:

getCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the criteria in simple mode

addCriteria

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

Add criteria to the simple 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

setCriteria

public void setCriteria(ViewItemContainer criteria)

Set the criteria

Parameters:

criteria - The criteria to set

getFacetedCriteria

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

Description copied from interface: SearchModel

Retrieves the faceted criteria.

Specified by:

getFacetedCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the faceted criteria.

addFacetedCriteria

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

Add criteria to the faceted 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

setFacetedCriteria

public void setFacetedCriteria(ViewItemContainer criteria)

Set the faceted criteria

Parameters:

criteria - The faceted criteria to set

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

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

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

Parameters:

contextualParameters - The contextual parameters

Returns:

the search model as a JSON map

resultItemsToJSON

public List<Object> resultItemsToJSON(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Converts the search model's result items on a JSON list

Specified by:

resultItemsToJSON in interface SearchModel

Parameters:

contextualParameters - The contextual parameters

Returns:

the result items as a JSON list

_resultItemsToJSON

protected List<Object> _resultItemsToJSON(ViewItemAccessor viewItemAccessor,
 DefinitionContext context)

Converts the search model's result items on a JSON map

Parameters:

viewItemAccessor - The result items

context - The definition context

Returns:

the result items as a JSON map