Package org.ametys.cms.data.type

Class AbstractContentElementType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.model.type.AbstractModelItemType

org.ametys.core.model.type.AbstractElementType<ContentValue>

org.ametys.cms.data.type.AbstractContentElementType

All Implemented Interfaces:

ElementType<ContentValue>, ModelItemType, LogEnabled, PluginAware, Component, Serviceable

Direct Known Subclasses:

ContentRepositoryElementType

public abstract class AbstractContentElementType
extends AbstractElementType<ContentValue>

Abstract class for content type of elements

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypesHelper	_contentTypesHelper	Helper for content types
protected AmetysObjectResolver	_resolver	Ametys object resolver

Fields inherited from class org.ametys.core.model.type.AbstractElementType

_jsonUtils

Constructor Summary

Constructors

Constructor	Description
AbstractContentElementType()

Method Summary

Modifier and Type	Method	Description
protected boolean	_isMultiple(Object value)	Checks if the given value is considered as multiple for this element type
protected boolean	_isSingle(Object value)	Checks if the given value is considered as single for this element type
protected ContentValue	_singleValueFromXML(Element element, Optional<Object> additionalData)	Retrieves a single typed value from the given DOM node
protected boolean	_useJSONForEdition()	Determine if the JSON format has to be used in edition mode for this element type
protected Object	_valueToJSON(Object value, DataContext context, BiFunction<String,DataContext,Object> singleStringToJSONFunction, BiFunction<Content,DataContext,Object> singleContentToJSONFunction, BiFunction<ContentValue,DataContext,Object> singleContentValueToJSONFunction)	Convert the value into a JSON object using the given functions
protected void	_valueToSAX(ContentHandler contentHandler, String tagName, Object value, Optional<ViewItem> viewItem, DataContext context, AttributesImpl attributes)	Generates SAX events for the given value
ContentValue	convertValue(Object value)	Try to convert the given value, that is not of the managed type
Object	fromJSONForClient(Object json, DataContext context)	Convert the given client side JSON object to the types value
boolean	isCompatible(Object value)	Checks if the value is compatible with the element type
boolean	isSimple()	Determines if this type is simple or not.
void	service(ServiceManager manager)
String	toString(ContentValue value)	Cast a typed value to a String
Object	valueToJSONForClient(Object value, DataContext context)	Convert the value into a JSON object to use client side
Object	valueToJSONForEdition(Object value, DataContext context)	Convert the value into a JSON object to use in edition mode

Methods inherited from class org.ametys.core.model.type.AbstractElementType

_compareMultipleValues, _compareSingleValues, _getValueAttributes, _isValueFromXMLMultiple, _singleValueToJSON, _singleValueToJSONForEdition, _singleValueToSAX, _valueToJSON, _valueToSAX, _valueToSAXForEdition, castValue, compareValues, getManagedClass, getManagedClassArray, parseConfiguration, valueFromXML, valueToSAX, valueToSAXForEdition

Methods inherited from class org.ametys.core.model.type.AbstractModelItemType

_getContextAttributes, getId, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.type.ModelItemType

getId, valueToSAX

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Field Details

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

Helper for content types

Constructor Details

AbstractContentElementType

public AbstractContentElementType()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractElementType<ContentValue>

Throws:

ServiceException

convertValue

public ContentValue convertValue(Object value)
                          throws BadItemTypeException

Description copied from class: AbstractElementType

Try to convert the given value, that is not of the managed type

Overrides:

convertValue in class AbstractElementType<ContentValue>

Parameters:

value - the value to convert

Returns:

the converted value or null if it's not possible.

Throws:

BadItemTypeException - if the given value is not compatible with the current type

toString

public String toString(ContentValue value)

Description copied from interface: ElementType

Cast a typed value to a String

Specified by:

toString in interface ElementType<ContentValue>

Overrides:

toString in class AbstractElementType<ContentValue>

Parameters:

value - the value to cast

Returns:

the String representation of the value

fromJSONForClient

public Object fromJSONForClient(Object json,
 DataContext context)

Description copied from interface: ElementType

Convert the given client side JSON object to the types value

Parameters:

json - the JSON object to convert

context - the context of the data to retrieve

Returns:

the typed value corresponding to the JSON object

valueToJSONForClient

public Object valueToJSONForClient(Object value,
 DataContext context)

Description copied from interface: ElementType

Convert the value into a JSON object to use client side

Specified by:

valueToJSONForClient in interface ElementType<ContentValue>

Overrides:

valueToJSONForClient in class AbstractElementType<ContentValue>

Parameters:

value - the value to convert

context - The context of the data to convert. Can not be null.

Returns:

The value as JSON

valueToJSONForEdition

public Object valueToJSONForEdition(Object value,
 DataContext context)

Description copied from interface: ElementType

Convert the value into a JSON object to use in edition mode

Specified by:

valueToJSONForEdition in interface ElementType<ContentValue>

Overrides:

valueToJSONForEdition in class AbstractElementType<ContentValue>

Parameters:

value - the value to convert

context - The context of the data to convert. Can not be null.

Returns:

The value as JSON

_valueToJSON

protected Object _valueToJSON(Object value,
 DataContext context,
 BiFunction<String,DataContext,Object> singleStringToJSONFunction,
 BiFunction<Content,DataContext,Object> singleContentToJSONFunction,
 BiFunction<ContentValue,DataContext,Object> singleContentValueToJSONFunction)

Convert the value into a JSON object using the given functions

Parameters:

value - the value to convert

context - The context of the data to convert

singleStringToJSONFunction - the function to apply to each single string to convert it into a JSON object

singleContentToJSONFunction - the function to apply to each single content to convert it into a JSON object

singleContentValueToJSONFunction - the function to apply to each single content value to convert it into a JSON object

Returns:

The value as JSON

_singleValueFromXML

protected ContentValue _singleValueFromXML(Element element,
 Optional<Object> additionalData)

Description copied from class: AbstractElementType

Retrieves a single typed value from the given DOM node

Overrides:

_singleValueFromXML in class AbstractElementType<ContentValue>

Parameters:

element - the DOM element containing the single value

additionalData - additional data needed to get the typed value

Returns:

the value

_valueToSAX

protected void _valueToSAX(ContentHandler contentHandler,
 String tagName,
 Object value,
 Optional<ViewItem> viewItem,
 DataContext context,
 AttributesImpl attributes)
                    throws SAXException

Description copied from class: AbstractElementType

Generates SAX events for the given value

Overrides:

_valueToSAX in class AbstractElementType<ContentValue>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

tagName - the tag name of the SAX event to generate.

value - the value to SAX

viewItem - The optional view item corresponding item that is currently saxed. This view item gives context for the SAX event that will be generated here.

context - The context of the data to SAX

attributes - the attributes for the SAX events to generate

Throws:

SAXException - if an error occurs during the SAX events generation

isCompatible

public boolean isCompatible(Object value)

Description copied from interface: ElementType

Checks if the value is compatible with the element type

Specified by:

isCompatible in interface ElementType<ContentValue>

Overrides:

isCompatible in class AbstractElementType<ContentValue>

Parameters:

value - the value to check

Returns:

true if the value matches the current type, false otherwise

isSimple

public boolean isSimple()

Description copied from interface: ElementType

Determines if this type is simple or not. A simple element type is a type of elements that can be edited in a grid

Returns:

true if the type is simple, false otherwise

_useJSONForEdition

protected boolean _useJSONForEdition()

Description copied from class: AbstractElementType

Determine if the JSON format has to be used in edition mode for this element type

Overrides:

_useJSONForEdition in class AbstractElementType<ContentValue>

Returns:

true if the JSON format has to be used, false otherwise

_isMultiple

protected boolean _isMultiple(Object value)

Description copied from class: AbstractElementType

Checks if the given value is considered as multiple for this element type

Overrides:

_isMultiple in class AbstractElementType<ContentValue>

Parameters:

value - the value to check

Returns:

true if the value is multiple, false otherwise

_isSingle

protected boolean _isSingle(Object value)

Description copied from class: AbstractElementType

Checks if the given value is considered as single for this element type

Overrides:

_isSingle in class AbstractElementType<ContentValue>

Parameters:

value - the value to check

Returns:

true if the value is single, false otherwise