org.ametys.cms.data.type.impl

Class RichTextRepositoryElementType

java.lang.Object

org.ametys.core.model.type.AbstractModelItemType

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

org.ametys.cms.data.type.AbstractRichTextElementType

org.ametys.cms.data.type.impl.RichTextRepositoryElementType

All Implemented Interfaces:

ComplexRepositoryElementType<RichText>, RepositoryElementType<RichText>, RepositoryModelItemType, ElementType<RichText>, ModelItemType, PluginAware

public class RichTextRepositoryElementType
extends AbstractRichTextElementType
implements ComplexRepositoryElementType<RichText>

Class for rich text type of elements stored in the repository

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__ANNOTATIONS_IDENTIFIER
private static String	__FILE_CONTENT_IDENTIFIER
private static String	__FOLDER_IDENTIFIER

Fields inherited from interface org.ametys.plugins.repository.data.type.ComplexRepositoryElementType

TYPE_ID_DATA_NAME

Constructor Summary

Constructors

Constructor and Description
RichTextRepositoryElementType()

Method Summary

Modifier and Type	Method and Description
private ModifiableRepositoryData	_getFileResourceRepositoryData(ModifiableRepositoryData folderData, String filename)
protected Object	_singleValueToJSON(RichText value) Convert the single value into a JSON object
protected void	_singleValueToSAX(ContentHandler contentHandler, String tagName, RichText richText, Locale locale) Generates SAX events for the given single value
private void	_writeAnnotations(ModifiableRepositoryData richTextData, Map<String,List<String>> annotations)
private void	_writeAttachments(ModifiableRepositoryData richTextData, RichText richText)
String	getNodeType() Retrieves the type of node used for this type
RichText	readSingleValue(RepositoryData singleValueData) Read the single value in the given repository data
boolean	removeValueBeforeWritingIt() Determines if the existing value has to be removed before writing the new one
void	writeSingleValue(ModifiableRepositoryData parentData, String name, RichText value) Write the single value into the given repository data This method is called by the ComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object) method, once for each value if the value is an array

Methods inherited from class org.ametys.cms.data.type.AbstractRichTextElementType

castValue, fromJSONForClient, isSimple, parseConfiguration, toString

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

getManagedClass, getManagedClassArray, isCompatible, valueToJSONForClient, valueToSAX

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

getId, setPluginInfo

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

isCompatible, read, write

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

castValue, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueToJSONForClient

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

getId, valueToSAX

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

setPluginInfo

Field Detail

__ANNOTATIONS_IDENTIFIER

private static final String __ANNOTATIONS_IDENTIFIER

See Also:

Constant Field Values

__FOLDER_IDENTIFIER

private static final String __FOLDER_IDENTIFIER

See Also:

Constant Field Values

__FILE_CONTENT_IDENTIFIER

private static final String __FILE_CONTENT_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

RichTextRepositoryElementType

public RichTextRepositoryElementType()

Method Detail

readSingleValue

public RichText readSingleValue(RepositoryData singleValueData)

Description copied from interface: ComplexRepositoryElementType

Read the single value in the given repository data

Specified by:

readSingleValue in interface ComplexRepositoryElementType<RichText>

Parameters:

singleValueData - 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,
                             RichText value)

Description copied from interface: ComplexRepositoryElementType

Write the single value into the given repository data This method is called by the ComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object) method, once for each value if the value is an array

Specified by:

writeSingleValue in interface ComplexRepositoryElementType<RichText>

Parameters:

parentData - repository where to store the single value.

name - the name of the element to write

value - the single value to write. Can be null. In this case, an empty data must be created

_writeAnnotations

private void _writeAnnotations(ModifiableRepositoryData richTextData,
                               Map<String,List<String>> annotations)

_writeAttachments

private void _writeAttachments(ModifiableRepositoryData richTextData,
                               RichText richText)

_getFileResourceRepositoryData

private ModifiableRepositoryData _getFileResourceRepositoryData(ModifiableRepositoryData folderData,
                                                                String filename)

removeValueBeforeWritingIt

public boolean removeValueBeforeWritingIt()

Description copied from interface: ComplexRepositoryElementType

Determines if the existing value has to be removed before writing the new one

Specified by:

removeValueBeforeWritingIt in interface ComplexRepositoryElementType<RichText>

Returns:

true if the previous value has to be removed, false otherwise

getNodeType

public String getNodeType()

Description copied from interface: ComplexRepositoryElementType

Retrieves the type of node used for this type

Specified by:

getNodeType in interface ComplexRepositoryElementType<RichText>

Returns:

the type of node used for this type

_singleValueToSAX

protected void _singleValueToSAX(ContentHandler contentHandler,
                                 String tagName,
                                 RichText richText,
                                 Locale locale)
                          throws SAXException

Description copied from class: AbstractElementType

Generates SAX events for the given single value

Overrides:

_singleValueToSAX in class AbstractElementType<RichText>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

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

richText - the single value to SAX

locale - The locale to use for localized data. Can be null to generate SAX events for all existing Locales.

Throws:

SAXException - if an error occurs during the SAX events generation

_singleValueToJSON

protected Object _singleValueToJSON(RichText value)

Description copied from class: AbstractElementType

Convert the single value into a JSON object

Overrides:

_singleValueToJSON in class AbstractElementType<RichText>

Parameters:

value - the value to convert

Returns:

The value as JSON