Package org.ametys.cms.contenttype

Class ContentAttributeDefinition

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.contenttype.AttributeDefinition<ContentValue>

org.ametys.cms.contenttype.ContentAttributeDefinition

All Implemented Interfaces:

Comparable<ModelItem>, ContentElementDefinition, RestrictedModelItem<Content>, ElementDefinition<ContentValue>, ModelItem, ModelItemAccessor, Labelable, ModifiableLabelable

public class ContentAttributeDefinition
extends AttributeDefinition<ContentValue>
implements ContentElementDefinition

Definition of content types attributes of type Content

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_DEFAULT_VALUE_TYPE	attribute type for default values

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
ContentAttributeDefinition(ContentTypeExtensionPoint contentTypeExtensionPoint, ContentTypesHelper contentAttributeTypeExtensionPoint)	Defintion's constructor

Method Summary

Modifier and Type	Method	Description
protected List<ContentValue>	_getDefaultValues(String defaultValueType, Object parsedDefaultValue)	Retrieves the default values from the parsed one, according to the type of the default value There could be several values, depending on default value's type.
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
void	checkDefaultValue()	Checks the default value of this definition
String	getContentTypeId()	Get the element's content type identifier.
boolean	getForceInvert()	Returns true if mutual relationship should be set regardless of user's rights
String	getInvertRelationPath()	Get the element's mutual relationship path.
Collection<? extends ModelItem>	getModelItems()	Retrieves all the model items of this accessor
void	setContentTypeId(String contentTypeId)	Set the element's content type identifier.
void	setForceInvert(boolean force)	Force mutual relationship regardless of user's rights (only applicable for an element with invert relation path).
void	setInvertRelationPath(String invertRelationPath)	Set the element's mutual relationship path.
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item

Methods inherited from class org.ametys.cms.contenttype.AttributeDefinition

_getExternalizableDataProviderExtensionPoint, _getRestrictedModelItemHelper, _shouldJSONBeEmpty, _widgetToSAX, canRead, canWrite, setRestrictions

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

_getParsedDefaultValues, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getType, 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

_widgetParameterToSAX, 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.runtime.model.ElementDefinition

_getParsedDefaultValues, getCriterionEnumerator, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getType, 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, getCriterionWidget, getCriterionWidgetParameters, 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

Field Details

ATTRIBUTE_DEFAULT_VALUE_TYPE

public static final String ATTRIBUTE_DEFAULT_VALUE_TYPE

attribute type for default values

See Also:

• Constant Field Values

Constructor Details

ContentAttributeDefinition

public ContentAttributeDefinition(ContentTypeExtensionPoint contentTypeExtensionPoint,
 ContentTypesHelper contentAttributeTypeExtensionPoint)

Defintion's constructor

Parameters:

contentTypeExtensionPoint - the content type extension point

contentAttributeTypeExtensionPoint - the content attribute type extension point

Method Details

getContentTypeId

public String getContentTypeId()

Description copied from interface: ContentElementDefinition

Get the element's content type identifier.

Specified by:

getContentTypeId in interface ContentElementDefinition

Returns:

the element's content type identifier.

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.

checkDefaultValue

public void checkDefaultValue()
                       throws ConfigurationException

Checks the default value of this definition

Throws:

ConfigurationException - if there is a problem with default value declaration

_getDefaultValues

protected List<ContentValue> _getDefaultValues(String defaultValueType,
 Object parsedDefaultValue)

Description copied from class: DefaultElementDefinition

Retrieves the default values from the parsed one, according to the type of the default value There could be several values, depending on default value's type. By example, for a default value of type config, if the corresponding config parameter is multiple and multi-valued, all value of the parameter are retrieved

Overrides:

_getDefaultValues in class DefaultElementDefinition<ContentValue>

Parameters:

defaultValueType - the type of the default value

parsedDefaultValue - the parsed default value (can be an I18nizableText, a config parameter name, ... depending on the default value type)

Returns:

the default value.

getInvertRelationPath

public String getInvertRelationPath()

Get the element's mutual relationship path.

Returns:

the element's mutual relationship path.

setInvertRelationPath

public void setInvertRelationPath(String invertRelationPath)

Set the element's mutual relationship path.

Parameters:

invertRelationPath - the element's mutual relationship path, separated by slashes.

setForceInvert

public void setForceInvert(boolean force)

Force mutual relationship regardless of user's rights (only applicable for an element with invert relation path).

Parameters:

force - true to force mutual relationship regardless of user's rights

getForceInvert

public boolean getForceInvert()

Returns true if mutual relationship should be set regardless of user's rights

Returns:

true if mutual relationship should be set regardless of user's rights

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 AttributeDefinition<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 AttributeDefinition<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