Package org.ametys.odf.content.code

Class DisplayCodeProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<String>

org.ametys.cms.model.properties.AbstractProperty<String,Content>

org.ametys.odf.content.code.DisplayCodeProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<String,Content>, CriterionDefinitionAwareElementDefinition<String>, IndexationAwareElementDefinition<String,Content>, ElementDefinition<String>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

public class DisplayCodeProperty
extends AbstractProperty<String,Content>
implements CriterionDefinitionAwareElementDefinition<String>, IndexationAwareElementDefinition<String,Content>

Property for the computed display code of a ProgramItem.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_NAME	The property name for display code

Fields inherited from class org.ametys.cms.model.properties.AbstractProperty

_availableTypesExtensionPoint, _context, _manager

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
DisplayCodeProperty()

Method Summary

Modifier and Type	Method	Description
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the element's value
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.cms.model.properties.AbstractProperty

_getNameConfigurationAttribute, _parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters, toSAX

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

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

convertQueryValue, getDefaultCriterionEnumerator, getDefaultCriterionOperator, getDefaultCriterionWidget, getDefaultCriterionWidgetParameters, getQuery, getType

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

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

getSolrFacetFieldName, getSolrFieldName, getSortValue, getType, indexValue, isFacetable, isSortable

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.cms.model.properties.Property

initializeAfterModelItemsInitialization, valueToJSON, valueToSAX

Field Details

PROPERTY_NAME

public static final String PROPERTY_NAME

The property name for display code

See Also:

• Constant Field Values

Constructor Details

DisplayCodeProperty

public DisplayCodeProperty()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProperty<String,Content>

Throws:

ServiceException

getValue

public Object getValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Specified by:

getValue in interface IndexationAwareElementDefinition<String,Content>

Specified by:

getValue in interface Property<String,Content>

Parameters:

content - the ametysObject containing the element

Returns:

the values to index.

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<String,Content>

Returns:

the id of the property's type

getDefaultCriterionType

public IndexableElementType getDefaultCriterionType()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the type to use when rendering the element as a criterion

Specified by:

getDefaultCriterionType in interface CriterionDefinitionAwareElementDefinition<String>

Returns:

the type to use for a criterion

getSolrSortFieldName

public String getSolrSortFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr sort field

Specified by:

getSolrSortFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr sort field