Package org.ametys.cms.search.content

Class ContentSearchHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.content.ContentSearchHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class ContentSearchHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Component which helps content searching by providing a simple way to access content properties (either attributes or properties).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ContentSearchHelper.JoinedPaths	Record representing the computed joined paths from a reference

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
ContentSearchHelper()

Method Summary

Modifier and Type	Method	Description
ContentSearchHelper.JoinedPaths	computeJoinedPaths(String dataPath, Set<String> contentTypeIds)	Retrieves the join paths from the given data path
void	contextualize(Context context)
SearcherFactory.FacetDefinition	getFacetDefinition(String referencePath, Set<String> contentTypeIds)	Retrieves the facet definition for the reference at the given path.
List<SearcherFactory.FacetDefinition>	getFacetDefinitions(List<String> referencedPaths, Set<String> contentTypeIds)	Retrieves the facet definitions for the references at the given paths.
List<SearcherFactory.FacetDefinition>	getFacetDefinitions(SearchModel searchModel, Map<String,Object> contextualParameters)	Retrieves the facet definitions for the given search model
ElementDefinition	getReferenceFromFieldPath(String referencePath, Set<String> contentTypeIds)	Retrieves the reference with the given path
SearcherFactory.SortDefinition	getSortDefinition(String referencePath, Set<String> contentTypeIds, SortOrder order)	Retrieves the sort definition for the reference at the given path.
boolean	isTitleMultilingual(ModelItem modelItem)	Determines if the given model item represents an attribute of type content with contents with multilingual titles
void	service(ServiceManager manager)
List<SearcherFactory.SortDefinition>	transformContentSearcherSorts(List<ContentSearcherFactory.ContentSearchSort> contentSearcherSorts, Set<String> contentTypeIds)	Transform the given ContentSearcherFactory.ContentSearchSorts to compute joins and get SearcherFactory.SortDefinition

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The component role.

Constructor Details

ContentSearchHelper

public ContentSearchHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

transformContentSearcherSorts

public List<SearcherFactory.SortDefinition> transformContentSearcherSorts(List<ContentSearcherFactory.ContentSearchSort> contentSearcherSorts,
 Set<String> contentTypeIds)
                                                                   throws IllegalArgumentException

Transform the given ContentSearcherFactory.ContentSearchSorts to compute joins and get SearcherFactory.SortDefinition

Parameters:

contentSearcherSorts - the sorts to transform

contentTypeIds - the identifiers of the content types where to search the field

Returns:

the sorts with computed joins to give to the SearcherFactory.Searcher

Throws:

IllegalArgumentException - if one of the given sort has not been found in the given content types

getSortDefinition

public SearcherFactory.SortDefinition getSortDefinition(String referencePath,
 Set<String> contentTypeIds,
 SortOrder order)
                                                 throws UndefinedItemPathException,
BadItemTypeException

Retrieves the sort definition for the reference at the given path.

Parameters:

referencePath - the reference path

contentTypeIds - the identifiers of content types defining the reference

order - The sort order

Returns:

the sort field name for the reference at the given path.

Throws:

UndefinedItemPathException - if there is no item defined at the given path in given content types

BadItemTypeException - if the definition of a part of the item path is not an item accessor

getFacetDefinition

public SearcherFactory.FacetDefinition getFacetDefinition(String referencePath,
 Set<String> contentTypeIds)
                                                   throws UndefinedItemPathException,
BadItemTypeException

Retrieves the facet definition for the reference at the given path.

Parameters:

referencePath - the reference path

contentTypeIds - the identifiers of content types defining the reference

Returns:

the facet definition for the reference at the given path.

Throws:

UndefinedItemPathException - if there is no item defined at the given path in given content types

BadItemTypeException - if the definition of a part of the item path is not an item accessor

getFacetDefinitions

public List<SearcherFactory.FacetDefinition> getFacetDefinitions(List<String> referencedPaths,
 Set<String> contentTypeIds)

Retrieves the facet definitions for the references at the given paths.

Parameters:

referencedPaths - the references paths

contentTypeIds - the identifiers of content types defining the references

Returns:

the facet definitions for the references at the given paths.

getFacetDefinitions

public List<SearcherFactory.FacetDefinition> getFacetDefinitions(SearchModel searchModel,
 Map<String,Object> contextualParameters)

Retrieves the facet definitions for the given search model

Parameters:

searchModel - the search model

contextualParameters - the contextual parameters

Returns:

the facet definitions for the given search model

getReferenceFromFieldPath

public ElementDefinition getReferenceFromFieldPath(String referencePath,
 Set<String> contentTypeIds)
                                            throws UndefinedItemPathException

Retrieves the reference with the given path

Parameters:

referencePath - the reference's path

contentTypeIds - the identifiers of the content types defining the reference

Returns:

the reference at the given path

Throws:

UndefinedItemPathException - if there is no model item in the given content types for the given path

BadItemTypeException - if the model item at the given path is not an element

computeJoinedPaths

public ContentSearchHelper.JoinedPaths computeJoinedPaths(String dataPath,
 Set<String> contentTypeIds)
                                                   throws UndefinedItemPathException,
BadItemTypeException

Retrieves the join paths from the given data path

Parameters:

dataPath - the data path

contentTypeIds - the ids of the content types containing the items of the given path

Returns:

the join paths

Throws:

UndefinedItemPathException - if there is no item defined at the given path in content types

BadItemTypeException - if the definition of a part of the data path is not an item accessor

isTitleMultilingual

public boolean isTitleMultilingual(ModelItem modelItem)

Determines if the given model item represents an attribute of type content with contents with multilingual titles

Parameters:

modelItem - The model item

Returns:

true if the given model item represents an attribute of type content with contents with multilingual titles