Package org.ametys.plugins.repository.data.holder.impl

Class DataHolderHelper

java.lang.Object

org.ametys.plugins.repository.data.holder.impl.DataHolderHelper

All Implemented Interfaces:

Disposable, Component, Serviceable

public final class DataHolderHelper
extends Object
implements Component, Serviceable, Disposable

Helper for implementations of data holder

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	REPEATER_ENTRY_PATTERN	Pattern for repeater entry : entryName[i]
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
DataHolderHelper()

Method Summary

Modifier and Type	Method	Description
static void	commentsToSAX(ModelAwareDataHolder dataHolder, ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, String dataPath)	Generates SAX events for the data comments in the given view
static Object	convertValue(ElementDefinition definition, Object value)	Converts the given value according to the given definition If the value is multiple, an array is retrieved with each value converted to the right type
static Map<String,Object>	convertValues(ViewItemContainer viewItemContainer, Map<String,Object> values)	Converts the given values according to the definitions in the given ViewItemContainer
static void	copyTo(DataHolder source, ModifiableDataHolder destination)	Copies the source DataHolder to the given ModifiableDataHolder destination.
static void	copyTo(DataHolder source, ModifiableDataHolder destination, String name)	Copy the data name of the source DataHolder to the given ModifiableDataHolder destination.
static ValueContext	createValueContextFromSynchronizationContext(ModelAwareDataHolder dataHolder, String dataPath, SynchronizationContext synchronizationContext)	Creates a value context from the given SynchronizationContext
static Map<String,Object>	dataToMap(ModelAwareDataHolder dataHolder, ViewItemAccessor viewItemAccessor, DataContext context)	Returns all data of the given DataHolder as a typed-values Map.
static void	dataToSAX(ModelAwareDataHolder dataHolder, ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context, boolean isEdition)	Generates SAX events for the data in the given view in the current DataHolder
static void	dataToSAX(ModelLessDataHolder dataHolder, ContentHandler contentHandler, String relativeDataPath, DataContext context)	Generates SAX events for data at the given relative path in this DataHolder
static void	dataToSAX(ModelLessDataHolder dataHolder, ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
void	dispose()
static <T> Map<String,T>	findItemsByType(ModelAwareDataHolder dataHolder, String type)	Find all data of the given type on a ModelAwareDataHolder, including in composite or repeater entries.
static <T> Map<String,T>	findItemsByType(ModelAwareDataHolder dataHolder, ViewItemAccessor viewItemAccessor, String type)	Find all data of the given type on a ModelAwareDataHolder, including in composite or repeater entries.
static ExternalizableDataProviderExtensionPoint	getExternalizableDataProviderExtensionPoint()	Retrieve the ExternalizableDataProviderExtensionPoint
static RepeaterEntry	getRepeaterEntry(ModelAwareDataHolder dataHolder, String repeaterName, int entryPosition)	Retrieves the repeater entry at the given position
static Pair<String,Integer>	getRepeaterNameAndEntryPosition(String pathSegment)	Retrieves the pair of repeater name and entry position of the given path segment Return null if the given path does not represent a repeater entry
static <T> T	getValue(String ametysObjectId, String dataPath)	Retrieves the value at the given path for the data aware ametys object with given id
static <T> T	getValue(ModelAwareDataHolder dataHolder, String dataPath, ValueContext context)	Retrieves the value of the data at the given path
static Object	getValueFromSynchronizableValue(Object value, ModelAwareDataHolder dataHolder, ModelItem modelItem, Optional<String> dataPath, SynchronizationContext context)	Returns the value of the synchronized value corresponding of the future status If the value is not a SynchronizableValue, the value itself is returned The future status is determined from the synchronizable value itself or from the context if needed.
static boolean	hasNonEmptyRepeaterEntry(ModelAwareDataHolder dataHolder, String repeaterName, int entryPosition)	Checks if there is a non empty repeater entry at the given position
static boolean	hasRepeaterEntry(ModelAwareDataHolder dataHolder, String repeaterName, int entryPosition)	Checks if there is a repeater entry at the given position
static boolean	hasValue(ModelAwareDataHolder dataHolder, String dataPath, ValueContext context)	Checks if there is a non empty value, for the data at the given path
static boolean	hasValueOrEmpty(ModelAwareDataHolder dataHolder, String dataPath, ValueContext context)	Checks if there is value, even empty, for the data at the given path
static boolean	isMultiple(ModelItem item)	Check if the given ModelItem is multivalued, either being itself mutlivalued or part of a repeater
static boolean	isRepeaterEntryPath(String path)	Test if the path is a repeater entry path (for example entries[1])
static void	removeValue(ModifiableModelAwareDataHolder dataHolder, String dataPath, ValueContext context)	Removes the stored value of the data at the given path
void	service(ServiceManager manager)
static void	setValue(ModifiableModelAwareDataHolder dataHolder, String dataPath, Object value, ValueContext context)	Sets the value of the data at the given path

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

REPEATER_ENTRY_PATTERN

public static final Pattern REPEATER_ENTRY_PATTERN

Pattern for repeater entry : entryName[i]

Constructor Detail

DataHolderHelper

public DataHolderHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

hasRepeaterEntry

public static boolean hasRepeaterEntry(ModelAwareDataHolder dataHolder,
                                       String repeaterName,
                                       int entryPosition)
                                throws BadItemTypeException

Checks if there is a repeater entry at the given position

Parameters:

dataHolder - data holder that contains the repeater entry. The data holder must be the direct parent of the repeater

repeaterName - the name of the repeater

entryPosition - the position of the entry

Returns:

true if there is an entry at the given position, false otherwise

Throws:

BadItemTypeException - if the value stored in the repository for the given repeater name is not a repeater

hasNonEmptyRepeaterEntry

public static boolean hasNonEmptyRepeaterEntry(ModelAwareDataHolder dataHolder,
                                               String repeaterName,
                                               int entryPosition)
                                        throws BadItemTypeException

Checks if there is a non empty repeater entry at the given position

Parameters:

dataHolder - data holder that contains the repeater entry. The data holder must be the direct parent of the repeater

repeaterName - the name of the repeater

entryPosition - the position of the entry

Returns:

true if there is a non empty entry at the given position, false otherwise

Throws:

BadItemTypeException - if the value stored in the repository for the given repeater name is not a repeater

getRepeaterEntry

public static RepeaterEntry getRepeaterEntry(ModelAwareDataHolder dataHolder,
                                             String repeaterName,
                                             int entryPosition)
                                      throws BadItemTypeException

Retrieves the repeater entry at the given position

Parameters:

dataHolder - data holder that contains the repeater entry. The data holder must be the direct parent of the repeater

repeaterName - the name of the repeater

entryPosition - the position of the entry

Returns:

the repeater entry

Throws:

BadItemTypeException - if the value stored in the repository for the given repeater name is not a repeater

isRepeaterEntryPath

public static boolean isRepeaterEntryPath(String path)

Test if the path is a repeater entry path (for example entries[1])

Parameters:

path - the path representing the repeater entry

Returns:

true if the pathSegment is a repeater entry path

getRepeaterNameAndEntryPosition

public static Pair<String,Integer> getRepeaterNameAndEntryPosition(String pathSegment)

Retrieves the pair of repeater name and entry position of the given path segment Return null if the given path does not represent a repeater entry

Parameters:

pathSegment - the path segment representing the repeater entry

Returns:

the pair of repeater name and entry position

hasValue

public static boolean hasValue(ModelAwareDataHolder dataHolder,
                               String dataPath,
                               ValueContext context)
                        throws IllegalArgumentException,
                               BadDataPathCardinalityException

Checks if there is a non empty value, for the data at the given path

Parameters:

dataHolder - the data holder

dataPath - path of the data

context - the context of the value to check

Returns:

true if the data at the given path is defined by the model, if there is a non empty value for the data, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasValueOrEmpty

public static boolean hasValueOrEmpty(ModelAwareDataHolder dataHolder,
                                      String dataPath,
                                      ValueContext context)
                               throws IllegalArgumentException,
                                      BadDataPathCardinalityException

Checks if there is value, even empty, for the data at the given path

Parameters:

dataHolder - the data holder

dataPath - path of the data

context - the context of the value to check

Returns:

true if the data at the given path is defined by the model, if there is a value, even empty, for the data, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getValue

public static <T> T getValue(String ametysObjectId,
                             String dataPath)
                      throws IllegalArgumentException,
                             UndefinedItemPathException,
                             BadItemTypeException,
                             BadDataPathCardinalityException

Retrieves the value at the given path for the data aware ametys object with given id

Type Parameters:

T - type of the value to retrieve

Parameters:

ametysObjectId - identifier of the data aware ametys object

dataPath - path of the data

Returns:

the value of the data or null if not exists or is empty.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getValue

public static <T> T getValue(ModelAwareDataHolder dataHolder,
                             String dataPath,
                             ValueContext context)
                      throws IllegalArgumentException,
                             UndefinedItemPathException,
                             BadItemTypeException,
                             BadDataPathCardinalityException

Retrieves the value of the data at the given path

Type Parameters:

T - type of the value to retrieve

Parameters:

dataHolder - the data holder

dataPath - path of the data

context - the context of the value to retrieve

Returns:

the value of the data or null if not exists or is empty.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

setValue

public static void setValue(ModifiableModelAwareDataHolder dataHolder,
                            String dataPath,
                            Object value,
                            ValueContext context)
                     throws IllegalArgumentException,
                            UndefinedItemPathException,
                            BadItemTypeException,
                            BadDataPathCardinalityException

Sets the value of the data at the given path

Parameters:

dataHolder - the data holder

dataPath - path of the data

value - the value to set. Give null to empty the value.

context - context of the data to set

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the given value to set

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

removeValue

public static void removeValue(ModifiableModelAwareDataHolder dataHolder,
                               String dataPath,
                               ValueContext context)
                        throws IllegalArgumentException,
                               UndefinedItemPathException,
                               BadItemTypeException,
                               UnknownDataException,
                               BadDataPathCardinalityException

Removes the stored value of the data at the given path

Parameters:

dataHolder - the data holder

dataPath - path of the data

context - context of the data to remove

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the value at the given data path does not exist

BadItemTypeException - if the value of the parent of the given path is not an item container

UndefinedItemPathException - if the given data path is not defined by the model

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

createValueContextFromSynchronizationContext

public static ValueContext createValueContextFromSynchronizationContext(ModelAwareDataHolder dataHolder,
                                                                        String dataPath,
                                                                        SynchronizationContext synchronizationContext)

Creates a value context from the given SynchronizationContext

Parameters:

dataHolder - the data holder

dataPath - the path of the value needing context

synchronizationContext - the SynchronizationContext

Returns:

the created ValueContext

copyTo

public static void copyTo(DataHolder source,
                          ModifiableDataHolder destination)

Copies the source DataHolder to the given ModifiableDataHolder destination.

Parameters:

source - the source DataHolder

destination - the ModifiableDataHolder destination

copyTo

public static void copyTo(DataHolder source,
                          ModifiableDataHolder destination,
                          String name)

Copy the data name of the source DataHolder to the given ModifiableDataHolder destination.

Parameters:

source - the source DataHolder

destination - the ModifiableDataHolder destination

name - the name of the data

dataToSAX

public static void dataToSAX(ModelAwareDataHolder dataHolder,
                             ContentHandler contentHandler,
                             ViewItemAccessor viewItemAccessor,
                             DataContext context,
                             boolean isEdition)
                      throws SAXException,
                             BadItemTypeException

Generates SAX events for the data in the given view in the current DataHolder

Parameters:

dataHolder - the ModelAwareDataHolder to SAX

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

isEdition - true if SAX events are generated in edition mode, false otherwise

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

commentsToSAX

public static void commentsToSAX(ModelAwareDataHolder dataHolder,
                                 ContentHandler contentHandler,
                                 ViewItemAccessor viewItemAccessor,
                                 String dataPath)
                          throws SAXException

Generates SAX events for the data comments in the given view

Parameters:

dataHolder - the ModelAwareDataHolder

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

dataPath - the data path corresponding of the current data holder. Can be null or empty.

Throws:

SAXException - if an error occurs during the SAX events generation

dataToSAX

public static void dataToSAX(ModelLessDataHolder dataHolder,
                             ContentHandler contentHandler,
                             DataContext context)
                      throws SAXException,
                             UnknownTypeException,
                             NotUniqueTypeException

Generates SAX events for data contained in this DataHolder

Parameters:

dataHolder - the ModelLessDataHolder to SAX

contentHandler - the ContentHandler that will receive the SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

dataToSAX

public static void dataToSAX(ModelLessDataHolder dataHolder,
                             ContentHandler contentHandler,
                             String relativeDataPath,
                             DataContext context)
                      throws SAXException,
                             UnknownTypeException,
                             NotUniqueTypeException

Generates SAX events for data at the given relative path in this DataHolder

Parameters:

dataHolder - the ModelLessDataHolder to SAX

contentHandler - the ContentHandler that will receive the SAX events

relativeDataPath - the path of the data to SAX, relative to the given data holder

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

dataToMap

public static Map<String,Object> dataToMap(ModelAwareDataHolder dataHolder,
                                                 ViewItemAccessor viewItemAccessor,
                                                 DataContext context)

Returns all data of the given DataHolder as a typed-values Map.

Parameters:

dataHolder - the DataHolder to export

viewItemAccessor - the ViewItemAccessor referencing the items to include in the resulting Map

context - The context of the data

Returns:

a Map containing all data.

findItemsByType

public static <T> Map<String,T> findItemsByType(ModelAwareDataHolder dataHolder,
                                                      String type)

Find all data of the given type on a ModelAwareDataHolder, including in composite or repeater entries.

Type Parameters:

T - the actual type of the requested data.

Parameters:

dataHolder - the data holder.

type - the type identifier.

Returns:

a Map with all data paths as keys and corresponding data as values.

findItemsByType

public static <T> Map<String,T> findItemsByType(ModelAwareDataHolder dataHolder,
                                                      ViewItemAccessor viewItemAccessor,
                                                      String type)

Find all data of the given type on a ModelAwareDataHolder, including in composite or repeater entries.

Type Parameters:

T - the actual type of the requested data.

Parameters:

dataHolder - the data holder.

viewItemAccessor - the view items to restrict to

type - the type identifier.

Returns:

a Map with all data paths as keys and corresponding data as values.

getExternalizableDataProviderExtensionPoint

public static ExternalizableDataProviderExtensionPoint getExternalizableDataProviderExtensionPoint()

Retrieve the ExternalizableDataProviderExtensionPoint

Returns:

the ExternalizableDataProviderExtensionPoint

getValueFromSynchronizableValue

public static Object getValueFromSynchronizableValue(Object value,
                                                     ModelAwareDataHolder dataHolder,
                                                     ModelItem modelItem,
                                                     Optional<String> dataPath,
                                                     SynchronizationContext context)

Returns the value of the synchronized value corresponding of the future status If the value is not a SynchronizableValue, the value itself is returned The future status is determined from the synchronizable value itself or from the context if needed. As the returned value is extracted from the synchronizable value, it can be an UntouchedValue

Parameters:

value - the synchronizable value

dataHolder - the data holder concerned by the value

modelItem - the model item corresponding to the value

dataPath - the current data path of the value. Can be empty if the data is in a repeater, in a not yet existing entry

context - the synchronization context, used to compute the future status of the value

Returns:

the value of the synchronized value corresponding of the future status

isMultiple

public static boolean isMultiple(ModelItem item)

Check if the given ModelItem is multivalued, either being itself mutlivalued or part of a repeater

Parameters:

item - the model item to check

Returns:

true if the model item is multivalued

convertValues

public static Map<String,Object> convertValues(ViewItemContainer viewItemContainer,
                                                     Map<String,Object> values)

Converts the given values according to the definitions in the given ViewItemContainer

Parameters:

viewItemContainer - the view item container

values - the values to convert

Returns:

the converted values

convertValue

public static Object convertValue(ElementDefinition definition,
                                  Object value)
                           throws BadItemTypeException

Converts the given value according to the given definition If the value is multiple, an array is retrieved with each value converted to the right type

Parameters:

definition - the definition

value - the value to convert

Returns:

the converted value

Throws:

BadItemTypeException - if the value to convert is not compatible with the data type