All Superinterfaces:: Composite, DataHolder, ModelAwareDataHolder

All Known Subinterfaces:: IndexableComposite, IndexableRepeaterEntry, ModifiableIndexableComposite, ModifiableIndexableRepeaterEntry, ModifiableModelAwareComposite, ModifiableRepeaterEntry, RepeaterEntry

All Known Implementing Classes:: DefaultIndexableComposite, DefaultIndexableRepeaterEntry, DefaultModelAwareComposite, DefaultModifiableIndexableComposite, DefaultModifiableIndexableRepeaterEntry, DefaultModifiableModelAwareComposite, DefaultModifiableRepeaterEntry, DefaultRepeaterEntry

public interface ModelAwareComposite extends ModelAwareDataHolder, Composite

Interface for model aware composites

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder
ALTERNATIVE_SUFFIX, STATUS_SUFFIX
Method Summary

Modifier and Type

Method

Description

default Object

dataToJSON(String dataPath, DataContext context)

Convert the data at the given path into a JSON object

default Map<String,Object>

dataToJSON(DataContext context)

Convert the data contained in this DataHolder

default Map<String,Object>

dataToJSON(ViewItemAccessor viewItemAccessor, DataContext context)

Convert the data in the given view of the current DataHolder

default Map<String,Object>

dataToJSONForEdition(ViewItemAccessor viewItemAccessor, DataContext context)

Convert the data in the given view in edition mode in the current DataHolder

default Map<String,Object>

dataToMap(ViewItemAccessor viewItemAccessor, DataContext context)

Retrieves data of this DataHolder as a typed-values Map.

default void

dataToSAX(ContentHandler contentHandler, DataContext context)

Generates SAX events for data contained in this DataHolder

default void

dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)

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

default void

dataToSAXForEdition(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)

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

default ModelAwareComposite

getComposite(String compositePath)

Retrieves the composite at the given path

default Collection<String>

getDataNames()

Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data

ModelAwareDataHolder

getDefaultDataHolder()

Retrieves the default implementation of a DataHolder to use

default ModelItem

getDefinition(String path)

Retrieves the definition of the data at the given path

default Collection<ModelItem>

getDifferences(Map<String,Object> values)

Get the collection of model items where there are differences between the given values and the current ones

default Collection<ModelItem>

getDifferences(Map<String,Object> values, SynchronizationContext context)

Get the collection of model items where there are differences between the given values and the current ones

default Collection<ModelItem>

getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values)

Get the collection of model items where there are differences between the given values and the current ones

default Collection<ModelItem>

getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)

Get the collection of model items where there are differences between the given values and the current ones

default ModelAwareComposite

getExternalComposite(String compositePath)

Retrieves the external composite at the given path

default Repeater

getExternalRepeater(String repeaterPath)

Retrieves the external repeater at the given path

default <T> T

getExternalValue(String dataPath)

Retrieves the external value of the data at the given path

default ModelAwareComposite

getLocalComposite(String compositePath)

Retrieves the local composite at the given path

default Repeater

getLocalRepeater(String repeaterPath)

Retrieves the local repeater at the given path

default <T> T

getLocalValue(String dataPath)

Retrieves the local value of the data at the given path

default Collection<? extends ModelItemContainer>

getModel()

Retrieves the data holder's model

default ModelItemTypeExtensionPoint

getModelItemTypeExtensionPoint()

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

default Optional<? extends ModelAwareDataHolder>

getParentDataHolder()

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

default Repeater

getRepeater(String repeaterPath)

Retrieves the repeater at the given path

default ModelAwareDataHolder

getRootDataHolder()

Retrieves the DataHolder that is the root of the current one

default ExternalizableDataProvider.ExternalizableDataStatus

getStatus(String dataPath)

Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable.

default <X extends ModelItemType> X

getType(String path)

Retrieves the type of the data at the given path

default <T> T

getValueOfType(String dataPath, String dataTypeId)

Retrieves the value of the data at the given path

default <T> T

getValueOfTypeOrDefault(String dataPath, String dataTypeId, T defaultValue)

Retrieves the value of the data at the given path if exists and is not empty, or the given default value

default <T> T

getValueOrDefault(String dataPath)

Retrieves the value of the data at the given path if exists and is not empty, or the default value from the model

default <T> T

getValueWithMultiValuedPathSegments(String dataPath)

Retrieves the value of the data at the given path, allowing multi-valued segments in the path (not necessarily at the last segment) if there is no indicated entry for a repeater, the values of all the entries are retrieved if there are multiple values, all data are retrieved in one array

default boolean

hasDefinition(String path)

Checks if there is a definition at the given path

default boolean

hasDifferences(Map<String,Object> values)

Check if there are differences between the given values and the current ones

default boolean

hasDifferences(Map<String,Object> values, SynchronizationContext context)

Check if there are differences between the given values and the current ones

default boolean

hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values)

Check if there are differences between the given values and the current ones

default boolean

hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)

Check if there are differences between the given values and the current ones

default boolean

hasExternalValue(String dataPath)

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

default boolean

hasExternalValueOrEmpty(String dataPath)

Checks if there is an external value for the data at the given path

default boolean

hasLocalValue(String dataPath)

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

default boolean

hasLocalValueOrEmpty(String dataPath)

Checks if there is a local value for the data at the given path

default boolean

hasValue(String dataPath, String dataTypeId)

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

default boolean

isMultiple(String dataPath)

Checks if the definition of the element at the given path is multiple
Checks if the definition of the element at the given path is multiple
Checks if the value of the data at the given path is multiple

default boolean

isMultiple(String dataPath, String dataTypeId)

Checks if the definition of the element at the given path is multiple
Checks if the definition of the element at the given path is multiple
Checks if the value of the data at the given path is multiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.Composite
dataToSAX, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder
copyTo, copyTo, dataToJSON, dataToSAX, getRepositoryData

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder
dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX

Method Details
- getComposite
  
  default ModelAwareComposite getComposite(String compositePath) throws IllegalArgumentException, UnknownTypeException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: DataHolder
  
  Retrieves the composite at the given path
  
  Specified by:
  
  getComposite in interface Composite
  
  Specified by:
  
  getComposite in interface DataHolder
  
  Specified by:
  
  getComposite in interface ModelAwareDataHolder
  
  Parameters:
  
  compositePath - path of the composite to retrieve
  
  Returns:
  
  the composite or null if not exists or is empty
  
  Throws:
  
  IllegalArgumentException - if the given composite path is null or empty
  
  UnknownTypeException - if the type composite is not available for this data holder
  
  BadItemTypeException - if the stored value at the given path is not a composite
  
  UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model
  
  BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple
- getLocalComposite
  
  default ModelAwareComposite getLocalComposite(String compositePath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the local composite at the given path
  
  Specified by:
  
  getLocalComposite in interface ModelAwareDataHolder
  
  Parameters:
  
  compositePath - path of the externalizable composite to retrieve
  
  Returns:
  
  the composite or null if not exists or is empty
  
  Throws:
  
  IllegalArgumentException - if the given composite path is null or empty
  
  BadItemTypeException - if the stored value at the given path is not a composite
  
  UndefinedItemPathException - if the given composite 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
- getExternalComposite
  
  default ModelAwareComposite getExternalComposite(String compositePath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the external composite at the given path
  
  Specified by:
  
  getExternalComposite in interface ModelAwareDataHolder
  
  Parameters:
  
  compositePath - path of the externalizable composite to retrieve
  
  Returns:
  
  the composite or null if not exists or is empty
  
  Throws:
  
  IllegalArgumentException - if the given composite path is null or empty
  
  BadItemTypeException - if the stored value at the given path is not a composite
  
  UndefinedItemPathException - if the given composite 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
- getRepeater
  
  default Repeater getRepeater(String repeaterPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the repeater at the given path
  
  Specified by:
  
  getRepeater in interface ModelAwareDataHolder
  
  Parameters:
  
  repeaterPath - path of the repeater to retrieve
  
  Returns:
  
  the repeater or null if not exists or is empty
  
  Throws:
  
  IllegalArgumentException - if the given repeater path is null or empty
  
  BadItemTypeException - if the stored value at the given path is not a repeater
  
  UndefinedItemPathException - if the given repeater 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
- getLocalRepeater
  
  default Repeater getLocalRepeater(String repeaterPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the local repeater at the given path
  
  Specified by:
  
  getLocalRepeater in interface ModelAwareDataHolder
  
  Parameters:
  
  repeaterPath - path of the externalizable repeater to retrieve
  
  Returns:
  
  the repeater or null if not exists or is empty
  
  Throws:
  
  IllegalArgumentException - if the given repeater path is null or empty
  
  BadItemTypeException - if the stored value at the given path is not a repeater
  
  UndefinedItemPathException - if the given repeater 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
- getExternalRepeater
  
  default Repeater getExternalRepeater(String repeaterPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the external repeater at the given path
  
  Specified by:
  
  getExternalRepeater in interface ModelAwareDataHolder
  
  Parameters:
  
  repeaterPath - path of the externalizable repeater to retrieve
  
  Returns:
  
  the repeater or null if not exists or is empty
  
  Throws:
  
  IllegalArgumentException - if the given repeater path is null or empty
  
  BadItemTypeException - if the stored value at the given path is not a repeater
  
  UndefinedItemPathException - if the given repeater 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
- hasLocalValue
  
  default boolean hasLocalValue(String dataPath) throws IllegalArgumentException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if there is a non empty local value for the data at the given path
  
  Specified by:
  
  hasLocalValue in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  true if the data at the given path is defined by the model, if there is a non empty local 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
- hasExternalValue
  
  default boolean hasExternalValue(String dataPath) throws IllegalArgumentException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if there is a non empty external value for the data at the given path
  
  Specified by:
  
  hasExternalValue in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  true if the data at the given path is defined by the model, if there is a non empty external 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
- hasValue
  
  default boolean hasValue(String dataPath, String dataTypeId) throws IllegalArgumentException, BadDataPathCardinalityException
  
  Description copied from interface: DataHolder
  
  Checks if there is a non empty value for the data at the given path
  
  Specified by:
  
  hasValue in interface Composite
  
  Specified by:
  
  hasValue in interface DataHolder
  
  Specified by:
  
  hasValue in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the data
  
  dataTypeId - type identifier of the data
  
  Returns:
  
  true if there is a non empty value for the data. If the data holder has a model and the data at the given path is defined by the model and 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 data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple
- hasLocalValueOrEmpty
  
  default boolean hasLocalValueOrEmpty(String dataPath) throws IllegalArgumentException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if there is a local value for the data at the given path
  
  Specified by:
  
  hasLocalValueOrEmpty in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  true if the data at the given path is defined by the model, if there is a local value for the data, even empty, 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
- hasExternalValueOrEmpty
  
  default boolean hasExternalValueOrEmpty(String dataPath) throws IllegalArgumentException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if there is an external value for the data at the given path
  
  Specified by:
  
  hasExternalValueOrEmpty in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  true if the data at the given path is defined by the model, if there is an external value for the data, even empty, 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
- getDataNames
  
  default Collection<String> getDataNames()
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data
  
  Specified by:
  
  getDataNames in interface Composite
  
  Specified by:
  
  getDataNames in interface DataHolder
  
  Specified by:
  
  getDataNames in interface ModelAwareDataHolder
  
  Returns:
  
  the names of the data contained by this data holder and that are defined by the model
- getLocalValue
  
  default <T> T getLocalValue(String dataPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the local value of the data at the given path
  
  Specified by:
  
  getLocalValue in interface ModelAwareDataHolder
  
  Type Parameters:
  
  T - type of the value to retrieve. The type of the value is defined by the model.
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  the local value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data
  
  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
- getExternalValue
  
  default <T> T getExternalValue(String dataPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the external value of the data at the given path
  
  Specified by:
  
  getExternalValue in interface ModelAwareDataHolder
  
  Type Parameters:
  
  T - type of the value to retrieve. The type of the value is defined by the model.
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  the external value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data
  
  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
- getValueOrDefault
  
  default <T> T getValueOrDefault(String dataPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the value of the data at the given path if exists and is not empty, or the default value from the model
  
  Specified by:
  
  getValueOrDefault in interface ModelAwareDataHolder
  
  Type Parameters:
  
  T - type of the value to retrieve. The type of the value is defined by the model.
  
  Parameters:
  
  dataPath - path of the data
  
  Returns:
  
  the value of the data, or the default value from the model if the value does not exist 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
- getValueOfType
  
  default <T> T getValueOfType(String dataPath, String dataTypeId) throws IllegalArgumentException, UnknownTypeException, NotUniqueTypeException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the value of the data at the given path
  
  Specified by:
  
  getValueOfType in interface Composite
  
  Specified by:
  
  getValueOfType in interface DataHolder
  
  Specified by:
  
  getValueOfType in interface ModelAwareDataHolder
  
  Type Parameters:
  
  T - type of the value to retrieve. The type of the value is defined by the model.
  
  Parameters:
  
  dataPath - path of the data
  
  dataTypeId - type identifier of the data
  
  Returns:
  
  the value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data
  
  Throws:
  
  IllegalArgumentException - if the given data path is null or empty
  
  UnknownTypeException - if the given type isn't available for this data holder's type extension point
  
  BadItemTypeException - if the given type doesn't match the type of the stored value at the given path
  
  UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model
  
  BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple
  
  NotUniqueTypeException
- getValueOfTypeOrDefault
  
  default <T> T getValueOfTypeOrDefault(String dataPath, String dataTypeId, T defaultValue) throws IllegalArgumentException, UnknownTypeException, NotUniqueTypeException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the value of the data at the given path if exists and is not empty, or the given default value
  
  Specified by:
  
  getValueOfTypeOrDefault in interface Composite
  
  Specified by:
  
  getValueOfTypeOrDefault in interface DataHolder
  
  Specified by:
  
  getValueOfTypeOrDefault in interface ModelAwareDataHolder
  
  Type Parameters:
  
  T - type of the value to retrieve. The type of the value is defined by the model.
  
  Parameters:
  
  dataPath - path of the data
  
  dataTypeId - type identifier of the data
  
  defaultValue - default value
  
  Returns:
  
  the value of the data, or the given default value if the value does not exist or is empty
  
  Throws:
  
  IllegalArgumentException - if the given data path is null or empty
  
  UnknownTypeException - if the given type isn't available for this data holder's type extension point
  
  BadItemTypeException - if the given type doesn't match the type of the stored value at the given path
  
  UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model
  
  BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple
  
  NotUniqueTypeException
- getValueWithMultiValuedPathSegments
  
  default <T> T getValueWithMultiValuedPathSegments(String dataPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the value of the data at the given path, allowing multi-valued segments in the path (not necessarily at the last segment) if there is no indicated entry for a repeater, the values of all the entries are retrieved if there are multiple values, all data are retrieved in one array
  
  Specified by:
  
  getValueWithMultiValuedPathSegments in interface ModelAwareDataHolder
  
  Type Parameters:
  
  T - type of the value to retrieve
  
  Parameters:
  
  dataPath - path of the data
  
  Returns:
  
  the value of the data
  
  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 managesMultiples boolean is false and the definition of a part of the data path is multiple. Only the last part can be multiple
- getStatus
  
  default ExternalizableDataProvider.ExternalizableDataStatus getStatus(String dataPath) throws IllegalArgumentException, BadItemTypeException, UndefinedItemPathException, BadDataPathCardinalityException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable. But there is no sense to call it with a non externalizable data
  
  Specified by:
  
  getStatus in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the externalizable data
  
  Returns:
  
  the status of the externalizable data at the given path
  
  Throws:
  
  IllegalArgumentException - if the given data path is null or empty
  
  BadItemTypeException - if the given data path is composed of an item with type defined by the model that 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
- isMultiple
  
  default boolean isMultiple(String dataPath) throws IllegalArgumentException, UnknownDataException, UnknownTypeException, NotUniqueTypeException, BadItemTypeException, UndefinedItemPathException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if the definition of the element at the given path is multiple
  Checks if the value of the data at the given path is multiple
  
  Specified by:
  
  isMultiple in interface Composite
  
  Specified by:
  
  isMultiple in interface DataHolder
  
  Specified by:
  
  isMultiple in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the element. No matter if it is a definition or data path (with repeater entry positions)
  
  Returns:
  
  true if the element is multiple, false otherwise
  
  Throws:
  
  IllegalArgumentException - if the given data path is null or empty
  
  UnknownDataException - the data at the given path does not exist
  
  UnknownTypeException - if there is no compatible type with the data at the given data path
  
  NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)
  
  BadItemTypeException - if value at the sub data path of the given one is not a composite
  
  UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model
- isMultiple
  
  default boolean isMultiple(String dataPath, String dataTypeId) throws IllegalArgumentException, UnknownDataException, UnknownTypeException, BadItemTypeException, UndefinedItemPathException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if the definition of the element at the given path is multiple
  Checks if the value of the data at the given path is multiple
  
  Specified by:
  
  isMultiple in interface Composite
  
  Specified by:
  
  isMultiple in interface DataHolder
  
  Specified by:
  
  isMultiple in interface ModelAwareDataHolder
  
  Parameters:
  
  dataPath - path of the element. No matter if it is a definition or data path (with repeater entry positions)
  
  dataTypeId - type identifier of the data
  
  Returns:
  
  true if the element is multiple, false otherwise
  
  Throws:
  
  IllegalArgumentException - if the given data path is null or empty
  
  UnknownDataException - the data at the given path does not exist
  
  UnknownTypeException - if there is no compatible type with the data at the given data path
  
  BadItemTypeException - if value at the sub data path of the given one is not a composite
  
  UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model
- getType
  
  default <X extends ModelItemType> X getType(String path) throws IllegalArgumentException, UnknownDataException, UnknownTypeException, NotUniqueTypeException, UndefinedItemPathException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the type of the data at the given path
  
  Specified by:
  
  getType in interface Composite
  
  Specified by:
  
  getType in interface DataHolder
  
  Specified by:
  
  getType in interface ModelAwareDataHolder
  
  Type Parameters:
  
  X - type of the item type
  
  Parameters:
  
  path - path of the data. No matter if it is a definition or data path (with repeater entry positions)
  
  Returns:
  
  the type of the data
  
  Throws:
  
  IllegalArgumentException - if the given data path is null or empty
  
  UnknownDataException - if there is no data stored at the given path
  
  UnknownTypeException - if there is no compatible type with the data at the given data path or if the data is a repeater entry but the composite type is not available
  
  NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)
  
  UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model
- getModelItemTypeExtensionPoint
  
  default ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()
  
  Description copied from interface: DataHolder
  
  Provide the ModelItemTypeExtensionPoint linked with the DataHolder
  
  Specified by:
  
  getModelItemTypeExtensionPoint in interface Composite
  
  Specified by:
  
  getModelItemTypeExtensionPoint in interface DataHolder
  
  Specified by:
  
  getModelItemTypeExtensionPoint in interface ModelAwareDataHolder
  
  Returns:
  
  the extension point
- getModel
  
  default Collection<? extends ModelItemContainer> getModel()
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the data holder's model
  
  Specified by:
  
  getModel in interface ModelAwareDataHolder
  
  Returns:
  
  the data holder's model
- getDefinition
  
  default ModelItem getDefinition(String path) throws IllegalArgumentException, UndefinedItemPathException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves the definition of the data at the given path
  
  Specified by:
  
  getDefinition in interface ModelAwareDataHolder
  
  Parameters:
  
  path - path of the data. No matter if it is a definition or data path (with repeater entry positions)
  
  Returns:
  
  the definition of the data
  
  Throws:
  
  IllegalArgumentException - if the given path is null or empty
  
  UndefinedItemPathException - if the given path is not defined by the model
- hasDefinition
  
  default boolean hasDefinition(String path) throws IllegalArgumentException
  
  Description copied from interface: ModelAwareDataHolder
  
  Checks if there is a definition at the given path
  
  Specified by:
  
  hasDefinition in interface ModelAwareDataHolder
  
  Parameters:
  
  path - path of the data. No matter if it is a definition or data path (with repeater entry positions)
  
  Returns:
  
  true if there is definition at the given path, false otherwise
  
  Throws:
  
  IllegalArgumentException - if the given path is null or empty
- dataToSAX
  
  default void dataToSAX(ContentHandler contentHandler, DataContext context) throws SAXException, UnknownTypeException, NotUniqueTypeException, BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Generates SAX events for data contained in this DataHolder
  Generates SAX events only for the data in the model
  
  Specified by:
  
  dataToSAX in interface Composite
  
  Specified by:
  
  dataToSAX in interface DataHolder
  
  Specified by:
  
  dataToSAX in interface ModelAwareDataHolder
  
  Parameters:
  
  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
  
  default void dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context) throws SAXException, BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Generates SAX events for the data in the given view in the current DataHolder
  
  Specified by:
  
  dataToSAX in interface ModelAwareDataHolder
  
  Parameters:
  
  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
  
  Throws:
  
  SAXException - if an error occurs during the SAX events generation
  
  BadItemTypeException - if the saxed value's type does not matches the stored data
- dataToSAXForEdition
  
  default void dataToSAXForEdition(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context) throws SAXException, BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Generates SAX events for the data in the given view in edition mode in the current DataHolder
  
  Specified by:
  
  dataToSAXForEdition in interface ModelAwareDataHolder
  
  Parameters:
  
  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
  
  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
  
  default Map<String,Object> dataToJSON(DataContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Convert the data contained in this DataHolder
  Only converts the data in the model
  
  Specified by:
  
  dataToJSON in interface Composite
  
  Specified by:
  
  dataToJSON in interface DataHolder
  
  Specified by:
  
  dataToJSON in interface ModelAwareDataHolder
  
  Parameters:
  
  context - The context of the data to convert
  
  Returns:
  
  The data of the current DataHolder as JSON
  
  Throws:
  
  BadItemTypeException - if the value's type does not matches the stored data
- dataToJSON
  
  default Object dataToJSON(String dataPath, DataContext context) throws UndefinedItemPathException, BadItemTypeException
  
  Description copied from interface: DataHolder
  
  Convert the data at the given path into a JSON object
  
  Specified by:
  
  dataToJSON in interface Composite
  
  Specified by:
  
  dataToJSON in interface DataHolder
  
  Parameters:
  
  dataPath - the path of the data to convert
  
  context - The context of the data to convert
  
  Returns:
  
  The value as JSON
  
  Throws:
  
  UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model
  
  BadItemTypeException - if the value's type does not matches the stored data
- dataToJSON
  
  default Map<String,Object> dataToJSON(ViewItemAccessor viewItemAccessor, DataContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Convert the data in the given view of the current DataHolder
  
  Specified by:
  
  dataToJSON in interface ModelAwareDataHolder
  
  Parameters:
  
  viewItemAccessor - the ViewItemAccessor referencing the items to convert
  
  context - The context of the data to convert
  
  Returns:
  
  The data of the given view as JSON
  
  Throws:
  
  BadItemTypeException - if the value's type does not matches the stored data
- dataToJSONForEdition
  
  default Map<String,Object> dataToJSONForEdition(ViewItemAccessor viewItemAccessor, DataContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Convert the data in the given view in edition mode in the current DataHolder
  
  Specified by:
  
  dataToJSONForEdition in interface ModelAwareDataHolder
  
  Parameters:
  
  viewItemAccessor - the ViewItemAccessor referencing the items to convert
  
  context - The context of the data to convert
  
  Returns:
  
  The data of the given view as JSON
  
  Throws:
  
  BadItemTypeException - if the value's type does not matches the stored data
- dataToMap
  
  default Map<String,Object> dataToMap(ViewItemAccessor viewItemAccessor, DataContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Retrieves data of this DataHolder as a typed-values Map.
  
  Specified by:
  
  dataToMap in interface ModelAwareDataHolder
  
  Parameters:
  
  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
- hasDifferences
  
  default boolean hasDifferences(Map<String,Object> values) throws UnknownTypeException, NotUniqueTypeException, BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Check if there are differences between the given values and the current ones
  
  Specified by:
  
  hasDifferences in interface Composite
  
  Specified by:
  
  hasDifferences in interface DataHolder
  
  Specified by:
  
  hasDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  values - the values to check
  
  Returns:
  
  true if there are differences, false otherwise
  
  Throws:
  
  UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point
  
  NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- hasDifferences
  
  default boolean hasDifferences(Map<String,Object> values, SynchronizationContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Check if there are differences between the given values and the current ones
  
  Specified by:
  
  hasDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  values - the values to check
  
  context - the context of the synchronization
  
  Returns:
  
  true if there are differences, false otherwise
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- hasDifferences
  
  default boolean hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Check if there are differences between the given values and the current ones
  
  Specified by:
  
  hasDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  viewItemAccessor - The ViewItemAccessor for all items to check
  
  values - the values to check
  
  Returns:
  
  true if there are differences, false otherwise
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- hasDifferences
  
  default boolean hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Check if there are differences between the given values and the current ones
  
  Specified by:
  
  hasDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  viewItemAccessor - The ViewItemAccessor for all items to check
  
  values - the values to check
  
  context - the context of the synchronization
  
  Returns:
  
  true if there are differences, false otherwise
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- getDifferences
  
  default Collection<ModelItem> getDifferences(Map<String,Object> values) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Get the collection of model items where there are differences between the given values and the current ones
  
  Specified by:
  
  getDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  values - the values to check
  
  Returns:
  
  a collection of model items with differences
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- getDifferences
  
  default Collection<ModelItem> getDifferences(Map<String,Object> values, SynchronizationContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Get the collection of model items where there are differences between the given values and the current ones
  
  Specified by:
  
  getDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  values - the values to check
  
  context - the context of the synchronization
  
  Returns:
  
  a collection of model items with differences
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- getDifferences
  
  default Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Get the collection of model items where there are differences between the given values and the current ones
  
  Specified by:
  
  getDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  viewItemAccessor - The ViewItemAccessor for all items to check
  
  values - the values to check
  
  Returns:
  
  a collection of model items with differences
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- getDifferences
  
  default Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context) throws BadItemTypeException
  
  Description copied from interface: ModelAwareDataHolder
  
  Get the collection of model items where there are differences between the given values and the current ones
  
  Specified by:
  
  getDifferences in interface ModelAwareDataHolder
  
  Parameters:
  
  viewItemAccessor - The ViewItemAccessor for all items to check
  
  values - the values to check
  
  context - the context of the synchronization
  
  Returns:
  
  a collection of model items with differences
  
  Throws:
  
  BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value
- getParentDataHolder
  
  default Optional<? extends ModelAwareDataHolder> getParentDataHolder()
  
  Description copied from interface: DataHolder
  
  Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
  
  Specified by:
  
  getParentDataHolder in interface Composite
  
  Specified by:
  
  getParentDataHolder in interface DataHolder
  
  Specified by:
  
  getParentDataHolder in interface ModelAwareDataHolder
  
  Returns:
  
  the parent of the current DataHolder
- getRootDataHolder
  
  default ModelAwareDataHolder getRootDataHolder()
  
  Description copied from interface: DataHolder
  
  Retrieves the DataHolder that is the root of the current one
  
  Specified by:
  
  getRootDataHolder in interface Composite
  
  Specified by:
  
  getRootDataHolder in interface DataHolder
  
  Specified by:
  
  getRootDataHolder in interface ModelAwareDataHolder
  
  Returns:
  
  the root DataHolder
- getDefaultDataHolder
  
  ModelAwareDataHolder getDefaultDataHolder()
  
  Description copied from interface: Composite
  
  Retrieves the default implementation of a DataHolder to use
  
  Specified by:
  
  getDefaultDataHolder in interface Composite
  
  Returns:
  
  the DataHolder

Interface ModelAwareComposite

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

Method Summary

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.Composite

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

Method Details

getComposite

getLocalComposite

getExternalComposite

getRepeater

getLocalRepeater

getExternalRepeater

hasLocalValue

hasExternalValue

hasValue

hasLocalValueOrEmpty

hasExternalValueOrEmpty

getDataNames

getLocalValue

getExternalValue

getValueOrDefault

getValueOfType

getValueOfTypeOrDefault

getValueWithMultiValuedPathSegments

getStatus

isMultiple

isMultiple

getType

getModelItemTypeExtensionPoint

getModel

getDefinition

hasDefinition

dataToSAX

dataToSAX

dataToSAXForEdition

dataToJSON

dataToJSON

dataToJSON

dataToJSONForEdition

dataToMap

hasDifferences

hasDifferences

hasDifferences

hasDifferences

getDifferences

getDifferences

getDifferences

getDifferences

getParentDataHolder

getRootDataHolder

getDefaultDataHolder