Package org.ametys.cms.model.properties

Class AbstractContentProperty<X extends ModelAwareDataAwareAmetysObject>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<ContentValue,X>

org.ametys.cms.model.properties.AbstractContentProperty<X>

Type Parameters:

X - type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, ContentElementDefinition, Property<ContentValue,X>, ElementDefinition<ContentValue>, ModelItem, ModelItemAccessor, PluginAware, Labelable, ModifiableLabelable, Configurable, Serviceable

Direct Known Subclasses:

OrgUnitAncestorProperty, ParentProgramsProperty, ParentSubProgramsProperty, ProgramSkillsProperty

public abstract class AbstractContentProperty<X extends ModelAwareDataAwareAmetysObject>
extends AbstractProperty<ContentValue,X>
implements ContentElementDefinition, Serviceable

Abstract class for content property

Field Summary

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

_availableTypesExtensionPoint

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

_logger

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

__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
AbstractContentProperty()

Method Summary

Modifier and Type	Method	Description
protected abstract Set<? extends ModifiableContent>	_getLinkedContents(X dataHolder)	Get the linked contents to index.
protected String	_getTypeId()	Retrieves the id of the property's type
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
String	getCriterionWidget()	Get the default widget to use when rendering this item as a criterion.
Collection<? extends ModelItem>	getModelItems()	Retrieves all the model items of this accessor
Object	getValue(X dataHolder)	Get the property's value
void	service(ServiceManager manager)
void	setContentTypeId(String contentTypeId)	Set the element's content type identifier.
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item

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

_getNameConfigurationAttribute, _parseI18nizableText, configure, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

_getDefaultValue, _getParsedDefaultValues, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters

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

_shouldJSONBeEmpty, _widgetParameterToSAX, _widgetToSAX, addItemChecker, compareTo, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, 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.model.ContentElementDefinition

getContentTypeId

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

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

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

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

getChild, getModelItem, hasModelItem

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

setDescription, setLabel, setName

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

getCriterionWidgetParameters, indexValue, valueToJSON, valueToJSON, valueToSAX, valueToSAX

Constructor Details

AbstractContentProperty

public AbstractContentProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_getTypeId

protected String _getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

_getTypeId in class AbstractProperty<ContentValue,X extends ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type

getCriterionWidget

public String getCriterionWidget()

Description copied from interface: ModelItem

Get the default widget to use when rendering this item as a criterion.

Specified by:

getCriterionWidget in interface ModelItem

Specified by:

getCriterionWidget in interface Property<ContentValue,X extends ModelAwareDataAwareAmetysObject>

Returns:

The default widget to use, or null if no specific widget is necessary.

setContentTypeId

public void setContentTypeId(String contentTypeId)

Description copied from interface: ContentElementDefinition

Set the element's content type identifier.

Specified by:

setContentTypeId in interface ContentElementDefinition

Parameters:

contentTypeId - the content type identifier to set.

getModelItems

public Collection<? extends ModelItem> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ContentElementDefinition

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

_toJSON

protected Map<String,Object> _toJSON(DefinitionContext context)
                              throws ProcessingException

Description copied from class: AbstractModelItem

Converts the model item in a JSON map

Overrides:

_toJSON in class DefaultElementDefinition<ContentValue>

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the model item

toSAX

public void toSAX(ContentHandler contentHandler,
 DefinitionContext context)
           throws SAXException

Description copied from interface: ModelItem

Generates SAX events for the model item

Specified by:

toSAX in interface ModelItem

Overrides:

toSAX in class DefaultElementDefinition<ContentValue>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

getValue

public Object getValue(X dataHolder)

Description copied from interface: Property

Get the property's value

Specified by:

getValue in interface Property<ContentValue,X extends ModelAwareDataAwareAmetysObject>

Parameters:

dataHolder - the ametysObject containing the property

Returns:

the values to index.

_getLinkedContents

protected abstract Set<? extends ModifiableContent> _getLinkedContents(X dataHolder)

Get the linked contents to index.

Parameters:

dataHolder - The data holder

Returns:

The linked contents