Package org.ametys.odf.content.code

Class AttributeBasedDisplayCodeProvider

java.lang.Object

org.ametys.odf.content.code.AbstractStaticProgramItemDisplayCodeProvider

org.ametys.odf.content.code.AttributeBasedDisplayCodeProvider

All Implemented Interfaces:

DisplayCodeProvider, PluginAware, Supporter<Content>, Configurable, Serviceable

Direct Known Subclasses:

PegaseDisplayCodeProvider

public class AttributeBasedDisplayCodeProvider
extends AbstractStaticProgramItemDisplayCodeProvider
implements Serviceable

Implementation of a DisplayCodeProvider based on Content attributes.
Display code will be composed by attributes' values separated by '-' character.
Expected configuration is:

   <type id="CONTENT_TYPE_ID_1">
       <item ref="path/of/attribute1"/>
       <item ref="path/of/attribute2"/>
   </type>
   <type id="CONTENT_TYPE_ID_2">
       <item ref="path/of/attribute1"/>
       <item ref="path/of/attribute2"/>
   </type>
   

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<String>>	_attributesByTypes	The attributes composing the code by content types
protected ServiceManager	_smanager	The service manager

Constructor Summary

Constructors

Constructor	Description
AttributeBasedDisplayCodeProvider()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected ContentTypeExtensionPoint	getContentTypeExtensionPoint()	Get the content type extension point
protected ContentTypesHelper	getContentTypesHelper()	Get content types helper
Optional<String>	getDisplayCode(Content content)	Get the display code of this content
void	service(ServiceManager smanager)
boolean	supports(Content content)	Check if an element is supported

Methods inherited from class org.ametys.odf.content.code.AbstractStaticProgramItemDisplayCodeProvider

getId, getLabel, setPluginInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.odf.content.code.DisplayCodeProvider

isActive

Field Details

_smanager

protected ServiceManager _smanager

The service manager

_attributesByTypes

protected Map<String,List<String>> _attributesByTypes

The attributes composing the code by content types

Constructor Details

AttributeBasedDisplayCodeProvider

public AttributeBasedDisplayCodeProvider()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticProgramItemDisplayCodeProvider

Throws:

ConfigurationException

getContentTypeExtensionPoint

protected ContentTypeExtensionPoint getContentTypeExtensionPoint()

Get the content type extension point

Returns:

the content type extension point

getContentTypesHelper

protected ContentTypesHelper getContentTypesHelper()

Get content types helper

Returns:

the content types helper

getDisplayCode

public Optional<String> getDisplayCode(Content content)

Description copied from interface: DisplayCodeProvider

Get the display code of this content

Specified by:

getDisplayCode in interface DisplayCodeProvider

Parameters:

content - the content

Returns:

the display code

supports

public boolean supports(Content content)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<Content>

Parameters:

content - The element

Returns:

true if the element is supported, false otherwise