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

public class ContentSearchHelper
extends AbstractLogEnabled
implements Component, Serviceable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentHelper	_contentHelper The content helper.
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point.
protected ContentTypesHelper	_cTypeHelper The content type helper.
protected AmetysObjectResolver	_resolver The ametys object resolver.
protected SystemPropertyExtensionPoint	_sysPropEP The system property extension point.
static String	ROLE The component role.

Constructor Summary

Constructors

Constructor and Description
ContentSearchHelper()

Method Summary

Modifier and Type	Method and Description
private boolean	_isSimple(Content content)
protected List<Map<String,Object>>	getContentValues(List<Object> values) Get information for UI on a content metadata
protected List<Map<String,Object>>	getEnumeratedValues(List<Object> values, Enumerator enumerator) Transform the list of enumerated values into a list of info (as Maps).
protected SearchField	getIndexingModelSearchField(String fieldPath, Collection<String> contentTypes) Get the SearchField corresponding to the indexing field at the given path in the indexing model.
MetadataDefinition	getMetadataDefinition(MetadataIndexingField indexingField, String[] remainingPathSegments, List<String> joinPaths, boolean addLast) Get the metadata definition from the indexing field and compute the join paths.
SearchField	getMetadataSearchField(String metadataPath, MetadataType metadataType) Get a SearchField corresponding to a metadata.
Object	getMetadataValues(Content content, String fullMetadataPath, MetadataType type, boolean multiple, Enumerator enumerator, boolean full) Get the values of a Content's metadata (can be in another content).
SearchField	getSearchField(Collection<String> contentTypes, String fieldPath) Get a SearchField from a field name in a batch of content types.
MetadataIndexingField	getTitleMetadataIndexingField() Get the metadata indexing field for the "title" standard metadata.
void	service(ServiceManager manager)

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 Detail

ROLE

public static final String ROLE

The component role.

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The content type helper.

_contentHelper

protected ContentHelper _contentHelper

The content helper.

_sysPropEP

protected SystemPropertyExtensionPoint _sysPropEP

The system property extension point.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

Constructor Detail

ContentSearchHelper

public ContentSearchHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getTitleMetadataIndexingField

public MetadataIndexingField getTitleMetadataIndexingField()

Get the metadata indexing field for the "title" standard metadata.

Returns:

The standard title metadata indexing field.

getMetadataSearchField

public SearchField getMetadataSearchField(String metadataPath,
                                          MetadataType metadataType)

Get a SearchField corresponding to a metadata.

Parameters:

metadataPath - The metadata path.

metadataType - The metadata type.

Returns:

the search field.

getSearchField

public SearchField getSearchField(Collection<String> contentTypes,
                                  String fieldPath)

Get a SearchField from a field name in a batch of content types.

Parameters:

contentTypes - The content types, can be empty to search on any content type. In that case, only the title metadata and system properties will be usable in sort and facets specs.

fieldPath - The field path, can be either a system property ID or a indexing field name or path (not joined).

Returns:

The SearchField corresponding to the

getIndexingModelSearchField

protected SearchField getIndexingModelSearchField(String fieldPath,
                                                  Collection<String> contentTypes)

Get the SearchField corresponding to the indexing field at the given path in the indexing model.

Parameters:

fieldPath - The field path.

contentTypes - The target content types.

Returns:

The corresponding search field.

getMetadataDefinition

public MetadataDefinition getMetadataDefinition(MetadataIndexingField indexingField,
                                                String[] remainingPathSegments,
                                                List<String> joinPaths,
                                                boolean addLast)

Get the metadata definition from the indexing field and compute the join paths. Can be null if the last indexing field is a custom indexing field.

Parameters:

indexingField - The initial indexing field

remainingPathSegments - The path to access the metadata or an another indexing field from the initial indexing field

joinPaths - The consecutive's path in case of joint to access the field/metadata

addLast - true to add the last join path element to the list, false otherwise.

Returns:

The metadata definition or null if not found

getMetadataValues

public Object getMetadataValues(Content content,
                                String fullMetadataPath,
                                MetadataType type,
                                boolean multiple,
                                Enumerator enumerator,
                                boolean full)

Get the values of a Content's metadata (can be in another content).

Parameters:

content - The Content.

fullMetadataPath - The full metadata path, can represent a metadata in a joined content.

type - The metadata type.

multiple - If the metadata is multiple.

enumerator - The metadata enumerator.

full - True to generate full representation of metadata, false otherwise.

Returns:

The values of the content metadata.

getEnumeratedValues

protected List<Map<String,Object>> getEnumeratedValues(List<Object> values,
                                                       Enumerator enumerator)

Transform the list of enumerated values into a list of info (as Maps).

Parameters:

values - The original list of values.

enumerator - The enumerator.

Returns:

The list of info (value + label) for each value.

getContentValues

protected List<Map<String,Object>> getContentValues(List<Object> values)

Get information for UI on a content metadata

Parameters:

values - The list of content IDs.

Returns:

The informations

_isSimple

private boolean _isSimple(Content content)