org.ametys.cms.search.content

Class ContentValuesExtractorFactory.SimpleContentValuesExtractor

java.lang.Object

org.ametys.cms.search.content.ContentValuesExtractorFactory.SimpleContentValuesExtractor

Enclosing class:

ContentValuesExtractorFactory

public class ContentValuesExtractorFactory.SimpleContentValuesExtractor
extends Object

A simple ContentValuesExtractor on a list of content types.

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	_contentTypes
private Map<String,Object>	_fields
private boolean	_fullValues

Constructor Summary

Constructors

Constructor and Description
SimpleContentValuesExtractor(Collection<String> contentTypes, List<String> fieldNames) Build a simple ContentValuesExtractor on a list of content types.

Method Summary

Modifier and Type	Method and Description
protected void	addAllFields(Map<String,Object> fields) Add all possible fields to the map.
protected void	addAllMetadatas(Map<String,Object> fields, MetadataDefinitionHolder defHolder, String prefix, boolean parentIsMultiple) Add all the metadata present in a holder.
protected void	addFields(Map<String,Object> fields, List<String> fieldNames) Add the given fields to the map.
protected Object	getValue(Content content, String fieldName, Object field, Locale defaultLocale) Get a value from the Content.
Map<String,Object>	getValues(Content content, Locale defaultLocale) Get the values from the given content.
Map<String,Object>	getValues(Content content, Locale defaultLocale, Map<String,Object> contextualParameters) Get the values from the given content.
protected Map<String,Object>	initializeFields(List<String> fieldNames) Initialize the fields from the field names.
protected boolean	isMultiple(List<MetadataDefinition> metaDefs) Test if any metadata definition in a chain is multiple or a repeater.
ContentValuesExtractorFactory.SimpleContentValuesExtractor	setFullValues(boolean fullValues) Whether to return full values or not.

Methods inherited from class java.lang.Object

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

Field Detail

_contentTypes

private Set<String> _contentTypes

_fields

private Map<String,Object> _fields

_fullValues

private boolean _fullValues

Constructor Detail

SimpleContentValuesExtractor

public SimpleContentValuesExtractor(Collection<String> contentTypes,
                                    List<String> fieldNames)

Build a simple ContentValuesExtractor on a list of content types.

Parameters:

contentTypes - The content types, can be empty.

fieldNames - The field names.

Method Detail

initializeFields

protected Map<String,Object> initializeFields(List<String> fieldNames)

Initialize the fields from the field names.

Parameters:

fieldNames - The field names.

Returns:

The fields definitions (either MetadataDefinition or SystemProperty), indexed by field name.

addAllFields

protected void addAllFields(Map<String,Object> fields)

Add all possible fields to the map.

Parameters:

fields - The map of field definitions to fill.

addFields

protected void addFields(Map<String,Object> fields,
                         List<String> fieldNames)

Add the given fields to the map.

Parameters:

fields - The map of field definitions to fill.

fieldNames - The fields to add.

addAllMetadatas

protected void addAllMetadatas(Map<String,Object> fields,
                               MetadataDefinitionHolder defHolder,
                               String prefix,
                               boolean parentIsMultiple)

Add all the metadata present in a holder.

Parameters:

fields - The field map to fill.

defHolder - The definition holder.

prefix - The metadata path prefix.

parentIsMultiple - true if the parent is multiple.

setFullValues

public ContentValuesExtractorFactory.SimpleContentValuesExtractor setFullValues(boolean fullValues)

Whether to return full values or not.

Parameters:

fullValues - true to return full values, false otherwise.

Returns:

The ContentValuesExtractor itself.

getValues

public Map<String,Object> getValues(Content content,
                                    Locale defaultLocale)

Get the values from the given content.

Parameters:

content - The content.

defaultLocale - The default locale for localized values if the content's language is null. Can be null.

Returns:

the extracted values.

getValues

public Map<String,Object> getValues(Content content,
                                    Locale defaultLocale,
                                    Map<String,Object> contextualParameters)

Get the values from the given content.

Parameters:

content - The content.

defaultLocale - The default locale for localized values if the content's language is null. Can be null.

contextualParameters - The search contextual parameters.

Returns:

the extracted values.

getValue

protected Object getValue(Content content,
                          String fieldName,
                          Object field,
                          Locale defaultLocale)

Get a value from the Content.

Parameters:

content - The content.

fieldName - The field name.

field - The field definition.

defaultLocale - The default locale for localized values if the content's language is null. Can be null.

Returns:

The value.

isMultiple

protected boolean isMultiple(List<MetadataDefinition> metaDefs)

Test if any metadata definition in a chain is multiple or a repeater.

Parameters:

metaDefs - The metadata definition chain.

Returns:

true if any metadata definition in a chain is multiple or a repeater.