Package org.ametys.cms.data.type.impl

Class DateTimeRepositoryElementType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.model.type.AbstractModelItemType

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

org.ametys.core.model.type.AbstractDateTimeElementType

org.ametys.cms.data.type.impl.DateTimeRepositoryElementType

All Implemented Interfaces:

RepositoryElementType<ZonedDateTime>, RepositoryModelItemType, ElementType<ZonedDateTime>, ModelItemType, LogEnabled, PluginAware, Component, Serviceable

public class DateTimeRepositoryElementType
extends AbstractDateTimeElementType
implements RepositoryElementType<ZonedDateTime>

Class for date time 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.RepositoryModelItemType

EMPTY_METADATA_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DateTimeRepositoryElementType()

Method Summary

Modifier and Type	Method	Description
protected ZonedDateTime	_singleValueFromXML(Element element, Optional<Object> additionalData)	Retrieves a single typed value from the given DOM node
protected void	_singleValueToSAX(ContentHandler contentHandler, String tagName, ZonedDateTime value, Optional<ViewItem> viewItem, DataContext context, AttributesImpl attributes)	Generates SAX events for the given single value
String	getRepositoryDataType()	Retrieves the type of repository data used for this type
boolean	hasNonEmptyValue(RepositoryData parentData, String name)	Check if there is a non empty value in the given repository data
boolean	hasValue(RepositoryData parentData, String name)	Check if there is a value, even empty, in the given repository data
Object	read(RepositoryData parentData, String name)	Read the value in the given repository data
void	remove(ModifiableRepositoryData parentData, String name)	Remove the value into the given repository data
void	write(ModifiableRepositoryData parentData, String name, Object value)	Write the value into the given repository data

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

_compareSingleValues, _singleValueToJSON, convertValue, fromJSONForClient, isSimple, toString

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

_compareMultipleValues, _getValueAttributes, _isValueFromXMLMultiple, _useJSONForEdition, _valueToSAX, _valueToSAX, _valueToSAXForEdition, castValue, compareValues, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, service, valueFromXML, valueToJSONForClient, 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.ElementType

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

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

isCompatible, isMultiple

Constructor Detail

DateTimeRepositoryElementType

public DateTimeRepositoryElementType()

Method Detail

read

public Object read(RepositoryData parentData,
                   String name)
            throws BadItemTypeException

Read the value in the given repository data The DateTime type retrieves a single or an array of ZonedDateTime. To convert a ZonedDateTime in Date and keep the TimeZone information, use the ChronoZonedDateTime.toEpochSecond() method.

Specified by:

read in interface RepositoryElementType<ZonedDateTime>

Parameters:

parentData - repository data containing the value

name - the name of the element to read

Returns:

the value. Can return a T or a T[]. That's why the return type is Object

Throws:

BadItemTypeException - if the reading value doesn't match this element type

hasValue

public boolean hasValue(RepositoryData parentData,
                        String name)
                 throws BadItemTypeException

Description copied from interface: RepositoryModelItemType

Check if there is a value, even empty, in the given repository data

Specified by:

hasValue in interface RepositoryModelItemType

Parameters:

parentData - repository data containing the value

name - the name of the element to check

Returns:

true if there is value, false otherwise

Throws:

BadItemTypeException - if the reading value doesn't match this element type

hasNonEmptyValue

public boolean hasNonEmptyValue(RepositoryData parentData,
                                String name)
                         throws BadItemTypeException

Description copied from interface: RepositoryModelItemType

Check if there is a non empty value in the given repository data

Specified by:

hasNonEmptyValue in interface RepositoryModelItemType

Parameters:

parentData - repository data containing the value

name - the name of the element to check

Returns:

true if there is a non empty value, false otherwise

Throws:

BadItemTypeException - if the reading value doesn't match this element type

write

public void write(ModifiableRepositoryData parentData,
                  String name,
                  Object value)
           throws BadItemTypeException

Description copied from interface: RepositoryElementType

Write the value into the given repository data

Specified by:

write in interface RepositoryElementType<ZonedDateTime>

Parameters:

parentData - repository where to store the value.

name - the name of the element to write

value - the value to write. Can be a T or a T[]. That's why it is an Object

Throws:

BadItemTypeException - If the given value doesn't match this element type

remove

public void remove(ModifiableRepositoryData parentData,
                   String name)
            throws UnknownDataException

Description copied from interface: RepositoryModelItemType

Remove the value into the given repository data

Specified by:

remove in interface RepositoryModelItemType

Parameters:

parentData - repository where the value to remove is stored.

name - the name of the element to remove

Throws:

UnknownDataException - if the value with the given name does not exist

getRepositoryDataType

public String getRepositoryDataType()

Description copied from interface: RepositoryModelItemType

Retrieves the type of repository data used for this type

Specified by:

getRepositoryDataType in interface RepositoryModelItemType

Returns:

the type of repository data used for this type

_singleValueFromXML

protected ZonedDateTime _singleValueFromXML(Element element,
                                            Optional<Object> additionalData)
                                     throws TransformerException,
                                            IOException

Description copied from class: AbstractElementType

Retrieves a single typed value from the given DOM node

Overrides:

_singleValueFromXML in class AbstractElementType<ZonedDateTime>

Parameters:

element - the DOM element containing the single value

additionalData - additional data needed to get the typed value

Returns:

the value

Throws:

TransformerException - if an error occurs while parsing the DOM node

IOException - if an error occurs while parsing a value using the I/O API

_singleValueToSAX

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

Description copied from class: AbstractElementType

Generates SAX events for the given single value

Overrides:

_singleValueToSAX in class AbstractElementType<ZonedDateTime>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

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

value - the single 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 event to generate

Throws:

SAXException - if an error occurs during the SAX events generation

IOException - if an error occurs while reading a value using the I/O API