org.ametys.cms.search.ui.model.impl

Class DefaultMetadataSearchUIColumn

java.lang.Object

org.ametys.runtime.parameter.Parameter<MetadataType>

org.ametys.cms.search.ui.model.impl.AbstractSearchUIColumn

org.ametys.cms.search.ui.model.impl.DefaultMetadataSearchUIColumn

All Implemented Interfaces:

Field, MetadataResultField, ResultField, SearchUIColumn, Serviceable

Direct Known Subclasses:

MetadataSearchUIColumn

public class DefaultMetadataSearchUIColumn
extends AbstractSearchUIColumn
implements MetadataResultField, Serviceable

Default implementation of a search ui column for the metadata of a content

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<String>	_contentTypes The content types of the contents on which this metadata column applies
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point.
protected ContentTypesHelper	_cTypeHelper The content type helper.
protected String	_fullMetadataPath The full metadata path.
protected boolean	_joinedMetadata True if the metadata is joined, false otherwise.
protected ContentSearchHelper	_searchHelper The search helper.

Constructor Summary

Constructors

Constructor and Description
DefaultMetadataSearchUIColumn() Default empty constructor
DefaultMetadataSearchUIColumn(MetadataDefinition metadataDefinition, String fullMetadataPath, Collection<String> contentTypes) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	_configure(MetadataDefinition metadataDefinition, I18nizableText label, I18nizableText description, int width, boolean hidden, boolean editable, boolean sortable, boolean multiple, boolean multiLevelMultiple, String defaultSorter, String renderer, String converter, Collection<String> contentTypes, boolean allowSortOnMultipleJoin) Configure the metadata search ui column
private boolean	_isSortableMetadata(MetadataDefinition metadataDefinition)
protected void	configureConverter(String converter, MetadataDefinition metadataDefinition) Configure the column converter.
protected void	configureRenderer(String renderer, MetadataDefinition metadataDefinition) Configure the column renderer.
String	getFieldPath() Get the path of metadata (separated by '/')
Object	getFullValue(Content content, Locale defaultLocale) Get the value represented by this field in the given result content.
SearchField	getSearchField() Get the SearchField representing this result field.
Object	getValue(Content content, Locale defaultLocale) Get the value represented by this field in the given result content.
protected boolean	isEditionAllowed(MetadataDefinition definition) Determines if the inline edition is allowed
void	service(ServiceManager manager)
void	setFieldPath(String metadataPath) Set the metadata path

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUIColumn

_configureI18nizableText, getContentTypeId, getConverter, getDefaultSorter, getRenderer, getWidth, isEditable, isHidden, isMultiple, isSortable, setContentTypeId, setConverter, setDefaultSorter, setEditable, setHidden, setMultiple, setRenderer, setSortable, setWidth

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.model.ResultField

getId

Methods inherited from interface org.ametys.cms.search.model.Field

getContentTypeId, getEnumerator, getType, isMultiple

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUIColumn

getDescription, getLabel, getValidator, getWidget, getWidgetParameters

Field Detail

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_cTypeHelper

protected ContentTypesHelper _cTypeHelper

The content type helper.

_searchHelper

protected ContentSearchHelper _searchHelper

The search helper.

_fullMetadataPath

protected String _fullMetadataPath

The full metadata path.

_joinedMetadata

protected boolean _joinedMetadata

True if the metadata is joined, false otherwise.

_contentTypes

protected Collection<String> _contentTypes

The content types of the contents on which this metadata column applies

Constructor Detail

DefaultMetadataSearchUIColumn

public DefaultMetadataSearchUIColumn()

Default empty constructor

DefaultMetadataSearchUIColumn

public DefaultMetadataSearchUIColumn(MetadataDefinition metadataDefinition,
                                     String fullMetadataPath,
                                     Collection<String> contentTypes)

Default constructor. Fill the search ui column from the metadata definition

Parameters:

metadataDefinition - The metadata definition

fullMetadataPath - The full metadata path

contentTypes - The content types of the contents on which this metadata column applies

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_configure

protected void _configure(MetadataDefinition metadataDefinition,
                          I18nizableText label,
                          I18nizableText description,
                          int width,
                          boolean hidden,
                          boolean editable,
                          boolean sortable,
                          boolean multiple,
                          boolean multiLevelMultiple,
                          String defaultSorter,
                          String renderer,
                          String converter,
                          Collection<String> contentTypes,
                          boolean allowSortOnMultipleJoin)

Configure the metadata search ui column

Parameters:

metadataDefinition - The definition

label - The column label

description - The column description

width - The column width

hidden - True if the column should be hidden

editable - True if the column is editable

sortable - True to allow sorting the column

multiple - True if the value is multiple

multiLevelMultiple - If the metadata path contains a multiple metadata or a repeater

defaultSorter - The default column sorter

renderer - A specific renderer to use. If null, it will be deduced from the metadata definition

converter - A specific converter to use. If null, it will be deduced from the metadata definition

contentTypes - The content types of the contents on which this metadata column applies

allowSortOnMultipleJoin - True to allow sort when the join path contains at least one mutliple metadata (intermediates only)

isEditionAllowed

protected boolean isEditionAllowed(MetadataDefinition definition)

Determines if the inline edition is allowed

Parameters:

definition - The metadata definition

Returns:

true if the metadata is editable

configureRenderer

protected void configureRenderer(String renderer,
                                 MetadataDefinition metadataDefinition)

Configure the column renderer.

Parameters:

renderer - A specific renderer. If null, it will be deduced from the metadata definition.

metadataDefinition - The metadata definition.

configureConverter

protected void configureConverter(String converter,
                                  MetadataDefinition metadataDefinition)

Configure the column converter.

Parameters:

converter - A specific converter. If null, it will be deduced from the metadata definition.

metadataDefinition - The metadata definition.

_isSortableMetadata

private boolean _isSortableMetadata(MetadataDefinition metadataDefinition)

setFieldPath

public void setFieldPath(String metadataPath)

Set the metadata path

Parameters:

metadataPath - the path to metadata

getFieldPath

public String getFieldPath()

Get the path of metadata (separated by '/')

Specified by:

getFieldPath in interface MetadataResultField

Returns:

the path of metadata

getValue

public Object getValue(Content content,
                       Locale defaultLocale)

Description copied from interface: ResultField

Get the value represented by this field in the given result content.

Specified by:

getValue in interface ResultField

Parameters:

content - the result content.

defaultLocale - the default locale for localized value if the content's language is null

Returns:

the content field value (cast to the appropriate object).

getFullValue

public Object getFullValue(Content content,
                           Locale defaultLocale)

Description copied from interface: ResultField

Get the value represented by this field in the given result content.

Specified by:

getFullValue in interface ResultField

Parameters:

content - the result content.

defaultLocale - the default locale for localized value if the content's language is null

Returns:

the content field value (cast to the appropriate object).

getSearchField

public SearchField getSearchField()

Description copied from interface: ResultField

Get the SearchField representing this result field.

Specified by:

getSearchField in interface ResultField

Overrides:

getSearchField in class AbstractSearchUIColumn

Returns:

The SearchField representing this result field.