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

Class MetadataSearchUIColumn

java.lang.Object

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

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

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

All Implemented Interfaces:

Field, MetadataResultField, ResultField, SearchUIColumn, Configurable, Serviceable

public class MetadataSearchUIColumn
extends AbstractSearchUIColumn
implements MetadataResultField, Serviceable, Configurable

This class is a search column on a metadata of a content

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_contentTypeId The ID of the content type which contains the metadata.
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
MetadataSearchUIColumn()

Method Summary

Modifier and Type	Method and Description
private List<MetadataDefinition>	_configureMetadataDefinitions()
private boolean	_isSortableMetadata(MetadataDefinition metadataDefinition)
void	configure(Configuration configuration)
protected void	configureConverter(Configuration configuration, MetadataType type) Configure the column converter.
protected void	configureRenderer(Configuration configuration, MetadataType type) Configure the column renderer.
String	getFieldPath() Get the path of metadata (separated by '/')
Object	getFullValue(Content content) 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) Get the value represented by this field in the given result content.
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.

_contentTypeId

protected String _contentTypeId

The ID of the content type which contains the metadata.

Constructor Detail

MetadataSearchUIColumn

public MetadataSearchUIColumn()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

_configureMetadataDefinitions

private List<MetadataDefinition> _configureMetadataDefinitions()
                                                        throws ConfigurationException

Throws:

ConfigurationException

configureRenderer

protected void configureRenderer(Configuration configuration,
                                 MetadataType type)

Configure the column renderer.

Parameters:

configuration - The column configuration.

type - The metadata type.

configureConverter

protected void configureConverter(Configuration configuration,
                                  MetadataType type)

Configure the column converter.

Parameters:

configuration - The column configuration.

type - The metadata type.

_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)

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.

Returns:

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

getFullValue

public Object getFullValue(Content content)

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.

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.