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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DataHolderHelper.SynchronizableValuesStatusInfos	Stores informations needed to choose status of created SynchronizableValue

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTERNAL_DISABLE_CONDITIONS_VALUES	The constant to use to send values of external disable conditions
static final Pattern	REPEATER_ENTRY_PATTERN	Pattern for repeater entry : entryName[i]

Constructor Summary

Constructors

Constructor	Description
DataHolderHelper()

Method Summary

Modifier and Type	Method	Description
static DataContext	addObjectInfoToContext(ModelAwareDataHolder dataHolder, DataContext context)	Enriches the given DataContext with object-level information from the root data holder (e.g.
static <T> T	aggregateMultipleValues(List<? extends ModelAwareDataHolder> dataHolders, String dataPath, Class managedClass)	Aggregates multiple values of the data holders at the given path
static Object	appendValuesInArray(Object originalValues, Object valuesToAppend, ElementType elementType)	Append some values to the given original ones
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 Object	convertValueIgnoringIncompatibleOnes(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 If the value is not compatible whit the data type, no exception is thrown and the value is converted to an UntouchedValue in order to be ignored
static Map<String,Object>	convertValues(ViewItemAccessor viewItemAccessor, Map<String,Object> values)	Converts the given values according to the definitions in the given ViewItemAccessor
static Map<String,Object>	convertValues(ViewItemAccessor viewItemAccessor, Map<String,Object> values, BiFunction<ElementDefinition,Object,Object> convertValueFunction)	Converts the given values according to the definitions in the given ViewItemAccessor
static Map<String,Object>	convertValuesWithSynchronizableValues(ViewItemAccessor viewItemAccessor, Map<String,Object> values, BiFunction<ElementDefinition,Object,Object> convertValueFunction, Optional<DataHolderHelper.SynchronizableValuesStatusInfos> synchronizableValuesStatusInfos)	Converts the given values according to the definitions in the given ViewItemAccessor
static void	copyTo(DataHolder source, ModifiableDataHolder destination, String name, DataContext context)	Copy the data name of the source DataHolder to the given ModifiableDataHolder destination.
static void	copyTo(DataHolder source, ModifiableDataHolder destination, DataContext context)	Copies 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 ViewItemAccessor	createViewItemAccessorFromValues(Collection<? extends ModelItemAccessor> modelItemAccessors, Map<String,Object> values)	Create a ViewItemAccessor for the items corresponding to the given values
static Object	dataToJSON(DataHolder dataHolder, String relativeDataPath, DataContext context)	Convert the data at the given relative path into a JSON object
static Map<String,Object>	dataToJSON(DataHolder dataHolder, DataContext context)	Convert the data contained in the given DataHolder
static Map<String,Object>	dataToJSON(ModelAwareDataHolder dataHolder, ViewItemAccessor viewItemAccessor, DataContext context, boolean isEdition)	Convert the data in the given view of the given DataHolder
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(DataHolder dataHolder, ContentHandler contentHandler, String relativeDataPath, DataContext context)	Generates SAX events for data at the given relative path in this DataHolder
static void	dataToSAX(DataHolder dataHolder, ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
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 given DataHolder
void	dispose()
static void	externalDisableConditionsToSAX(ModelAwareDataHolder dataHolder, ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext dataContext)	Generates SAX events for external disable conditions of the items in the given view
static <T> Map<String,T>	findEditableItemsByType(ModelAwareDataHolder dataHolder, String type)	Find all modifiable data of the given type on a ModelAwareDataHolder, including in composite or repeater entries.
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 Object	getArrayValuesFromSynchronizableValue(SynchronizableValue synchronizableValue, ValueContext valueContext)	Retrieves an array of values from the given SynchronizableValue.
static I18nizableText	getDataFullLabel(String dataPath, Collection<? extends ModelItemAccessor> itemAccessors)	Get the label for the path in the item accessors.
static Map<String,Boolean>	getExternalDisableConditionsValues(ModelAwareDataHolder dataHolder, ViewItemAccessor viewItemAccessor, DataContext dataContext)	Retrieves the values of the disable conditions of the items in the given view for the given data holder
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	hasValue(ModelAwareDataHolder dataHolder, String dataPath, DataContext context)	Check if there is a value to render 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	isExternalDisableConditionsAware(ViewItemAccessor viewItemAccessor, boolean isEdition)	Determines if the given ViewItemAccessor can have external disabled conditions itself
static boolean	isMultiple(ModelItemAccessor parent, String attributePath)	Check if at least one element in the attribute path is multiple from the given parent accessor.
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
static Object	removeValuesInArray(Object originalValues, Object valuesToRemove, ElementType elementType)	Removes some values from the given original ones
static boolean	renderValue(ModelAwareDataHolder dataHolder, String dataPath, DataContext context, boolean isEdition)	Check if the value at the given path should be rendered
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
static void	setValue(ModifiableModelAwareDataHolder dataHolder, String dataPath, Object value, ValueContext context, boolean forceStatus)	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 Details

REPEATER_ENTRY_PATTERN

public static final Pattern REPEATER_ENTRY_PATTERN

Pattern for repeater entry : entryName[i]

EXTERNAL_DISABLE_CONDITIONS_VALUES

public static final String EXTERNAL_DISABLE_CONDITIONS_VALUES

The constant to use to send values of external disable conditions

See Also:

• Constant Field Values

Constructor Details

DataHolderHelper

public DataHolderHelper()

Method Details

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 IllegalArgumentException,
UndefinedItemPathException,
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:

IllegalArgumentException - if the given repeater name is null or empty

UndefinedItemPathException - if the given repeater name is not defined by the data holder's model

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

getDataFullLabel

public static I18nizableText getDataFullLabel(String dataPath,
 Collection<? extends ModelItemAccessor> itemAccessors)
                                       throws UndefinedItemPathException

Get the label for the path in the item accessors. If the provided path is an item path, a label will also be generated but without any indexes for repeater entries

Parameters:

dataPath - the data path

itemAccessors - the list of item accessors where the item should be retrieved

Returns:

the label of the path

Throws:

IllegalArgumentException - if the given path is null or empty

UndefinedItemPathException - if no item exists for the given path

BadItemTypeException - if the given path is not coherent with the accessors

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

hasValue

public static boolean hasValue(ModelAwareDataHolder dataHolder,
 String dataPath,
 DataContext context)

Check if there is a value to render at the given path

Parameters:

dataHolder - the data holder containing the data to check

dataPath - the path of the data to check

context - the data context

Returns:

true if there is a value to render, false otherwise

renderValue

public static boolean renderValue(ModelAwareDataHolder dataHolder,
 String dataPath,
 DataContext context,
 boolean isEdition)

Check if the value at the given path should be rendered

Parameters:

dataHolder - the data holder containing the data to check

dataPath - the path of the data to check

context - the data context

isEdition - true if values are rendered in edition mode, false otherwise

Returns:

true if the value has to be rendered, false otherwise

getValue

public static <T> T getValue(String ametysObjectId,
 String dataPath)
                      throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

getValue

public static <T> T getValue(ModelAwareDataHolder dataHolder,
 String dataPath,
 ValueContext context)
                      throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

setValue

public static void setValue(ModifiableModelAwareDataHolder dataHolder,
 String dataPath,
 Object value,
 ValueContext context)
                     throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

setValue

public static void setValue(ModifiableModelAwareDataHolder dataHolder,
 String dataPath,
 Object value,
 ValueContext context,
 boolean forceStatus)
                     throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

forceStatus - true to force the status to the given status context if defined

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

removeValue

public static void removeValue(ModifiableModelAwareDataHolder dataHolder,
 String dataPath,
 ValueContext context)
                        throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

copyTo

public static void copyTo(DataHolder source,
 ModifiableDataHolder destination,
 DataContext context)
                   throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException

Copies the source DataHolder to the given ModifiableDataHolder destination.

Parameters:

source - the source DataHolder

destination - the ModifiableDataHolder destination

context - The context of the data to copy

Throws:

UnknownTypeException - for data holder without model, if there is no available type compatible with the copied value

NotUniqueTypeException - for data holder without model, if there is more than one available types compatibles with the copied value

BadItemTypeException - if there is an error of data teype while copying the value in the destination

UndefinedItemPathException - for model aware data holders, if a data to copy doesn't match the model in the destination

copyTo

public static void copyTo(DataHolder source,
 ModifiableDataHolder destination,
 String name,
 DataContext context)
                   throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException

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

context - The context of the data to copy

Throws:

IllegalArgumentException - if the given data name is null or empty

UnknownDataException - if there is no data with the given name in the source data holder

UnknownTypeException - for data holder without model, if there is no available type compatible with the copied value

NotUniqueTypeException - for data holder without model, if there is more than one available types compatibles with the copied value

BadItemTypeException - if there is an error of data teype while copying the value in the destination

UndefinedItemPathException - for model aware data holders, if a data to copy doesn't match the model in the destination

dataToSAX

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

Generates SAX events for data contained in this DataHolder

Parameters:

dataHolder - the DataHolder 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

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

dataToSAX

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

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

Parameters:

dataHolder - the DataHolder 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

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

UndefinedItemPathException - if the given data holder has a model and the given relative path is not defined in this model

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 given 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

dataToJSON

public static Map<String,Object> dataToJSON(DataHolder dataHolder,
 DataContext context)
                                     throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Convert the data contained in the given DataHolder

Parameters:

dataHolder - the DataHolder

context - The context of the data to convert

Returns:

The data of the given DataHolder as JSON

Throws:

UnknownTypeException - if there is no compatible type with the value to convert

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

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

dataToJSON

public static Object dataToJSON(DataHolder dataHolder,
 String relativeDataPath,
 DataContext context)
                         throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException

Convert the data at the given relative path into a JSON object

Parameters:

dataHolder - the DataHolder

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

context - The context of the data to convert

Returns:

The value as JSON

Throws:

UnknownTypeException - if there is no compatible type with the value to convert

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

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

UndefinedItemPathException - if the given data holder has a model and the given relative path is not defined in this model

dataToJSON

public static Map<String,Object> dataToJSON(ModelAwareDataHolder dataHolder,
 ViewItemAccessor viewItemAccessor,
 DataContext context,
 boolean isEdition)
                                     throws BadItemTypeException

Convert the data in the given view of the given DataHolder

Parameters:

dataHolder - the ModelAwareDataHolder containing the data to convert

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

isEdition - true to convert in edition mode, false otherwise

Returns:

The data of the given view as JSON

Throws:

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

dataToMap

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

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.

Throws:

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

addObjectInfoToContext

public static DataContext addObjectInfoToContext(ModelAwareDataHolder dataHolder,
 DataContext context)

Enriches the given DataContext with object-level information from the root data holder (e.g. the AmetysObject) of the given data holder

Parameters:

dataHolder - the data holder

context - the original context

Returns:

a new context enriched with object information

findEditableItemsByType

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

Find all modifiable data of the given type on a ModelAwareDataHolder, including in composite or repeater entries. Properties are not modifiables, so they are excluded from the result

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,
 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

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

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

getArrayValuesFromSynchronizableValue

public static Object getArrayValuesFromSynchronizableValue(SynchronizableValue synchronizableValue,
 ValueContext valueContext)

Retrieves an array of values from the given SynchronizableValue. If the value is not an array, create one with a single entry

Parameters:

synchronizableValue - the SynchronizableValue

valueContext - the ValueContext to choose the value to retrieve (local or external)

Returns:

an array containing the values of the SynchronizableValue

isMultiple

public static boolean isMultiple(ModelItemAccessor parent,
 String attributePath)
                          throws UndefinedItemPathException

Check if at least one element in the attribute path is multiple from the given parent accessor.

Parameters:

parent - The parent accessor

attributePath - The attribute path to explore

Returns:

false if all elements in the path are single, otherwise true (can be a repeater or a multiple attribute)

Throws:

UndefinedItemPathException - if the given attribute path is not defined by the model item accessor

convertValues

public static Map<String,Object> convertValues(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values)

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

Parameters:

viewItemAccessor - the view item accessor

values - the values to convert

Returns:

the converted values

convertValues

public static Map<String,Object> convertValues(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 BiFunction<ElementDefinition,Object,Object> convertValueFunction)

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

Parameters:

viewItemAccessor - the view item accessor

values - the values to convert

convertValueFunction - The function to use to convert single values

Returns:

the converted values

convertValuesWithSynchronizableValues

public static Map<String,Object> convertValuesWithSynchronizableValues(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 BiFunction<ElementDefinition,Object,Object> convertValueFunction,
 Optional<DataHolderHelper.SynchronizableValuesStatusInfos> synchronizableValuesStatusInfos)

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

Parameters:

viewItemAccessor - the view item accessor

values - the values to convert

convertValueFunction - The function to use to convert single values

synchronizableValuesStatusInfos - informations needed to choose status of created SynchronizableValue. If empty, the status is set to ExternalizableDataProvider.ExternalizableDataStatus.LOCAL

Returns:

the converted values

convertValueIgnoringIncompatibleOnes

public static Object convertValueIgnoringIncompatibleOnes(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 If the value is not compatible whit the data type, no exception is thrown and the value is converted to an UntouchedValue in order to be ignored

Parameters:

definition - the definition

value - the value to convert

Returns:

the converted value

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

createViewItemAccessorFromValues

public static ViewItemAccessor createViewItemAccessorFromValues(Collection<? extends ModelItemAccessor> modelItemAccessors,
 Map<String,Object> values)

Create a ViewItemAccessor for the items corresponding to the given values

Parameters:

modelItemAccessors - the model containing the items corresponding to the values

values - the values

Returns:

the created ViewItemAccessor

aggregateMultipleValues

public static <T> T aggregateMultipleValues(List<? extends ModelAwareDataHolder> dataHolders,
 String dataPath,
 Class managedClass)

Aggregates multiple values of the data holders at the given path

Type Parameters:

T - type of the value to retrieve

Parameters:

dataHolders - the data holding the values

dataPath - the path of the data to retrieve

managedClass - class of the retrieved values

Returns:

aggregated multiple values

removeValuesInArray

public static Object removeValuesInArray(Object originalValues,
 Object valuesToRemove,
 ElementType elementType)

Removes some values from the given original ones

Parameters:

originalValues - the original values

valuesToRemove - the values to remove from the original ones

elementType - the type of the element concerned by the values

Returns:

an array containing the original values, less the ones to remove

appendValuesInArray

public static Object appendValuesInArray(Object originalValues,
 Object valuesToAppend,
 ElementType elementType)

Append some values to the given original ones

Parameters:

originalValues - the original values

valuesToAppend - the values to append to the original ones

elementType - the type of the element concerned by the values

Returns:

an array containing the original values, and the ones to append

externalDisableConditionsToSAX

public static void externalDisableConditionsToSAX(ModelAwareDataHolder dataHolder,
 ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext dataContext)
                                           throws SAXException,
BadItemTypeException,
UndefinedItemPathException

Generates SAX events for external disable conditions of the items in the given view

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

dataContext - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

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

UndefinedItemPathException - if an item in the view is not part of the model

getExternalDisableConditionsValues

public static Map<String,Boolean> getExternalDisableConditionsValues(ModelAwareDataHolder dataHolder,
 ViewItemAccessor viewItemAccessor,
 DataContext dataContext)

Retrieves the values of the disable conditions of the items in the given view for the given data holder

Parameters:

dataHolder - the ModelAwareDataHolder containing the data

viewItemAccessor - the ViewItemAccessor referencing the items

dataContext - The context of the data

Returns:

the disable conditions values

isExternalDisableConditionsAware

public static boolean isExternalDisableConditionsAware(ViewItemAccessor viewItemAccessor,
 boolean isEdition)

Determines if the given ViewItemAccessor can have external disabled conditions itself

Parameters:

viewItemAccessor - the view item accessor

isEdition - true in edition mode, false otherwise

Returns:

true if the gicen accessor can have external disable conditions, false otherwise