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

Class DefaultModelAwareDataHolder

java.lang.Object

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

All Implemented Interfaces:

DataHolder, ModelAwareDataHolder

Direct Known Subclasses:

DefaultModifiableModelAwareDataHolder

public class DefaultModelAwareDataHolder
extends Object
implements ModelAwareDataHolder

Default implementation for data holder with model

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<? extends ModelItemContainer>	_itemContainers Model containers to use to get information about definitions
protected RepositoryData	_repositoryData Repository data to use to store data in the repository

Constructor Summary

Constructors

Constructor and Description
DefaultModelAwareDataHolder(RepositoryData repositoryData, Collection<? extends ModelItemContainer> itemContainers) Creates a default model aware data holder
DefaultModelAwareDataHolder(RepositoryData repositoryData, ModelItemContainer... itemContainers) Creates a default model aware data holder

Method Summary

Modifier and Type	Method and Description
protected ModelAwareComposite	_getComposite(String name, CompositeDefinition compositeDefinition) Retrieves the composite with the given name
protected ModelAwareRepeater	_getRepeater(String name, RepeaterDefinition repeaterDefinition) Retrieves the repeater with the given name
ModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
Collection<String>	getDataNames() Retrieves the names of data contained by this data holder
ModelAwareRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModelItemType	getType(String path) Retrieves the type of the data at the given path
<T> T	getValue(String dataPath) Retrieves the value of the data at the given path
<T> T	getValue(String dataPath, boolean useDefaultFromModel, T defaultValue) Retrieves the value of the data at the given path, or the default value
boolean	hasValue(String dataPath) Checks if there is a value for the data at the given path
boolean	isMultiple(String path) Checks if the definition of the element at the given path is multiple

Methods inherited from class java.lang.Object

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

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

toSAX, toSAX

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX

Field Detail

_repositoryData

protected RepositoryData _repositoryData

Repository data to use to store data in the repository

_itemContainers

protected Collection<? extends ModelItemContainer> _itemContainers

Model containers to use to get information about definitions

Constructor Detail

DefaultModelAwareDataHolder

public DefaultModelAwareDataHolder(RepositoryData repositoryData,
                                   ModelItemContainer... itemContainers)

Creates a default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

DefaultModelAwareDataHolder

public DefaultModelAwareDataHolder(RepositoryData repositoryData,
                                   Collection<? extends ModelItemContainer> itemContainers)

Creates a default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

Method Detail

getComposite

public ModelAwareComposite getComposite(String compositePath)
                                 throws IllegalArgumentException,
                                        UndefinedItemPathException,
                                        BadItemTypeException,
                                        BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the composite at the given path

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

BadItemTypeException - if the value stored in the repository at the given path is not a composite

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

getRepeater

public ModelAwareRepeater getRepeater(String repeaterPath)
                               throws IllegalArgumentException,
                                      UndefinedItemPathException,
                                      BadItemTypeException,
                                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

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

getValue

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

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

Returns:

the value of the data or null if not exists. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

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 value stored in the repository

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

getValue

public <T> T getValue(String dataPath,
                      boolean useDefaultFromModel,
                      T defaultValue)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, or the default value

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

useDefaultFromModel - true to use the default value from the model, false to use the given default value

defaultValue - default value used if value is null and useDefaultFromModel is false, or if there is no default value on model

Returns:

the value of the data or null if not exists.

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 value stored in the repository

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

_getComposite

protected ModelAwareComposite _getComposite(String name,
                                            CompositeDefinition compositeDefinition)
                                     throws BadItemTypeException

Retrieves the composite with the given name

Parameters:

name - name of the composite to retrieve

compositeDefinition - the definition of the composite to retrieve

Returns:

the composite

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a composite

_getRepeater

protected ModelAwareRepeater _getRepeater(String name,
                                          RepeaterDefinition repeaterDefinition)
                                   throws BadItemTypeException

Retrieves the repeater with the given name

Parameters:

name - name of the repeater to retrieve

repeaterDefinition - the definition of the repeater to retrieve

Returns:

the repeater

Throws:

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

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException,
                        BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasValue in interface DataHolder

Specified by:

hasValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value for the data, 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

isMultiple

public boolean isMultiple(String path)
                   throws IllegalArgumentException,
                          UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

isMultiple in interface ModelAwareDataHolder

Parameters:

path - 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 path is null or empty

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

getType

public ModelItemType getType(String path)
                      throws IllegalArgumentException,
                             UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieves the type of the data at the given path

Specified by:

getType 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 type of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

getDataNames

public Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder

Specified by:

getDataNames in interface DataHolder

Returns:

the paths of all data contained by this data holder