Package org.ametys.cms.data.type.impl
Class MultilingualStringRepositoryElementType
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.core.model.type.AbstractModelItemType
org.ametys.core.model.type.AbstractElementType<MultilingualString>
org.ametys.cms.data.type.AbstractMultilingualStringElementType
org.ametys.cms.data.type.impl.MultilingualStringRepositoryElementType
- All Implemented Interfaces:
ComplexRepositoryElementType<MultilingualString>
,RepositoryElementType<MultilingualString>
,RepositoryModelItemType
,ElementType<MultilingualString>
,ModelItemType
,LogEnabled
,PluginAware
,Component
,Serviceable
public class MultilingualStringRepositoryElementType
extends AbstractMultilingualStringElementType
implements ComplexRepositoryElementType<MultilingualString>
Class for multilingual string type of elements stored in the repository
-
Field Summary
Fields inherited from class org.ametys.core.model.type.AbstractElementType
_jsonUtils
Fields inherited from interface org.ametys.plugins.repository.data.type.ComplexRepositoryElementType
TYPE_ID_DATA_NAME
Fields inherited from interface org.ametys.plugins.repository.data.type.RepositoryModelItemType
EMPTY_METADATA_SUFFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
_isAValidLocale
(String candidate) Checks if the given string is an availableLocale
Retrieves the type of repository data used for this typeboolean
isSingleValueEmpty
(RepositoryData multilingualStringData) Checks if the single value is emptyreadSingleValue
(RepositoryData multilingualStringData) Read the single value in the given repository datavoid
writeSingleValue
(ModifiableRepositoryData parentData, String name, MultilingualString value) Write the single value into the given repository data This method is called by theComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object)
method, once for each value if the value is an arrayMethods inherited from class org.ametys.cms.data.type.AbstractMultilingualStringElementType
_compareMultipleValues, _compareSingleValues, _singleValueFromXML, _singleValueToJSON, _singleValueToSAX, _useJSONForEdition, convertValue, fromJSONForClient, isSimple, toString
Methods inherited from class org.ametys.core.model.type.AbstractElementType
_getValueAttributes, _isMultiple, _isSingle, _isValueFromXMLMultiple, _singleValueToJSONForEdition, _valueToJSON, _valueToSAX, _valueToSAX, _valueToSAXForEdition, castValue, compareValues, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, service, valueFromXML, valueToJSONForClient, valueToJSONForEdition, 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.plugins.repository.data.type.ComplexRepositoryElementType
emptySingleValue, hasNonEmptyValue, isCompatible, read, removeValueBeforeWritingIt, write
Methods inherited from interface org.ametys.runtime.model.type.ElementType
castValue, compareValues, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueFromXML, valueToJSONForClient, valueToJSONForEdition
Methods inherited from interface org.ametys.runtime.model.type.ModelItemType
getId, valueToSAX, valueToSAX, valueToSAXForEdition
Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware
setPluginInfo
Methods inherited from interface org.ametys.plugins.repository.data.type.RepositoryElementType
externalizableValueToSAX
Methods inherited from interface org.ametys.plugins.repository.data.type.RepositoryModelItemType
hasValue, isMultiple, remove
-
Constructor Details
-
MultilingualStringRepositoryElementType
-
-
Method Details
-
isSingleValueEmpty
Description copied from interface:ComplexRepositoryElementType
Checks if the single value is empty- Specified by:
isSingleValueEmpty
in interfaceComplexRepositoryElementType<MultilingualString>
- Parameters:
multilingualStringData
- repository data containing the value to check- Returns:
true
if the value is empty,false
otherwise
-
readSingleValue
Description copied from interface:ComplexRepositoryElementType
Read the single value in the given repository data- Specified by:
readSingleValue
in interfaceComplexRepositoryElementType<MultilingualString>
- Parameters:
multilingualStringData
- repository data containing the value- Returns:
- the value. Can return null if the given data does not contain the necessary elements
-
writeSingleValue
public void writeSingleValue(ModifiableRepositoryData parentData, String name, MultilingualString value) Description copied from interface:ComplexRepositoryElementType
Write the single value into the given repository data This method is called by theComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object)
method, once for each value if the value is an array- Specified by:
writeSingleValue
in interfaceComplexRepositoryElementType<MultilingualString>
- Parameters:
parentData
- repository where to store the single value.name
- the name of the element to writevalue
- the single value to write. Can be null. In this case, an empty data must be created
-
getRepositoryDataType
Description copied from interface:RepositoryModelItemType
Retrieves the type of repository data used for this type- Specified by:
getRepositoryDataType
in interfaceRepositoryModelItemType
- Returns:
- the type of repository data used for this type
-
_isAValidLocale
Checks if the given string is an availableLocale
- Parameters:
candidate
- the string to check- Returns:
true
if the given string is an available locale,false
otherwise
-