org.ametys.cms.search

Class GroupSearchContentHelper

java.lang.Object

org.ametys.cms.search.GroupSearchContentHelper

All Implemented Interfaces:

Component, Serviceable

public class GroupSearchContentHelper
extends Object
implements Component, Serviceable

Helper to group search contents

Field Summary

Fields

Modifier and Type	Field and Description
private ContentHelper	_contentHelper
private I18nUtils	_i18nUtils
private SystemPropertyExtensionPoint	_systemPropertyExtensionPoint
private UserManager	_userManager
static String	ROLE The Avalon role name

Constructor Summary

Constructors

Constructor and Description
GroupSearchContentHelper()

Method Summary

Modifier and Type	Method and Description
private String	_getGroupValueAsString(String fieldId, Object value, ContentType contentType, Locale locale)
private Map<Object,List<Content>>	_groupBy(Iterable<Content> contents, String fieldId, Locale locale) Group contents by given grouping field
private void	_organizeContents(GroupSearchContent parent, Iterable<Content> contents, List<String> groupingFields, ContentType contentType, Locale locale) Recursive function that create sub GroupSearchContent to organize the contents in a hierarchy according to a list of metadata Example Continent/Country/City
GroupSearchContent	organizeContentsInGroups(Iterable<Content> contents, List<String> groupingFields, ContentType contentType, Locale locale) Create GroupSearchContent to organize the contents in a hierarchy according to a list of metadata Example Continent/Country/City
void	service(ServiceManager serviceManager)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role name

_systemPropertyExtensionPoint

private SystemPropertyExtensionPoint _systemPropertyExtensionPoint

_contentHelper

private ContentHelper _contentHelper

_userManager

private UserManager _userManager

_i18nUtils

private I18nUtils _i18nUtils

Constructor Detail

GroupSearchContentHelper

public GroupSearchContentHelper()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

organizeContentsInGroups

public GroupSearchContent organizeContentsInGroups(Iterable<Content> contents,
                                                   List<String> groupingFields,
                                                   ContentType contentType,
                                                   Locale locale)

Create GroupSearchContent to organize the contents in a hierarchy according to a list of metadata Example Continent/Country/City

Parameters:

contents - contents that need to be sorted

groupingFields - list of metadata to group with (ordered)

contentType - the content type

locale - The locale for groups. Can be null. Only useful if grouping by multilingual contents or multilingual string

Returns:

the root group of contents

_organizeContents

private void _organizeContents(GroupSearchContent parent,
                               Iterable<Content> contents,
                               List<String> groupingFields,
                               ContentType contentType,
                               Locale locale)

Recursive function that create sub GroupSearchContent to organize the contents in a hierarchy according to a list of metadata Example Continent/Country/City

Parameters:

parent - parent group in which contents will be added, or in which new groups will be created

contents - contents that need to be sorted

groupingFields - list of metadata to group with (ordered)

contentType - the content type

locale - The local to get i18n titles

_groupBy

private Map<Object,List<Content>> _groupBy(Iterable<Content> contents,
                                           String fieldId,
                                           Locale locale)

Group contents by given grouping field

Parameters:

contents - list of content

fieldId - The id of grouping field. Can be the path of a metadata or the system property

locale - The local to get i18n titles

Returns:

a Map where the key will be the value of the metadata

_getGroupValueAsString

private String _getGroupValueAsString(String fieldId,
                                      Object value,
                                      ContentType contentType,
                                      Locale locale)