Class ModelLessComposite
java.lang.Object
org.ametys.plugins.repository.data.holder.group.impl.AbstractComposite
org.ametys.plugins.repository.data.holder.group.impl.ModelLessComposite
- All Implemented Interfaces:
DataHolder
,Composite
,ModelLessDataHolder
- Direct Known Subclasses:
ModifiableModelLessComposite
Class for model free composites
-
Field Summary
Modifier and TypeFieldDescriptionprotected ModelLessDataHolder
the default implementation of aModelLessDataHolder
to useFields inherited from class org.ametys.plugins.repository.data.holder.group.impl.AbstractComposite
_repositoryData
-
Constructor Summary
ConstructorDescriptionModelLessComposite
(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, RepositoryData repositoryData, ModelLessDataHolder parent, ModelLessDataHolder root) Creates a model free composite -
Method Summary
Modifier and TypeMethodDescriptionvoid
dataToSAX
(ContentHandler contentHandler, String dataPath, DataContext context) Generates SAX events for the data at the given data path in the currentDataHolder
Do not generate any event if there is no values at the given pathvoid
dataToSAX
(ContentHandler contentHandler, DataContext context) Generates SAX events for data contained in thisDataHolder
getComposite
(String compositePath) Retrieves the composite at the given pathprotected ModelLessDataHolder
Retrieves the default implementation of aDataHolder
to useOptional<? extends ModelLessDataHolder>
Retrieves the optional parent of the currentDataHolder
There can be no parent if the currentDataHolder
is the rootRetrieves theDataHolder
that is the root of the current oneRetrieves the type of the data at the given path<T> T
Retrieves the value of the data at the given path The type of the value will be deduced from the stored data.<T> T
Retrieves the value of the data at the given path if exists and is not empty, or the default value<T> T
getValueOfType
(String dataPath, String dataTypeId) Retrieves the value of the data at the given path<T> T
getValueOfType
(String dataPath, String dataTypeId, T defaultValue) Retrieves the value of the data at the given path if exists and is not empty, or the default valueboolean
isMultiple
(String dataPath) Checks if the value of the data at the given path is multipleMethods inherited from class org.ametys.plugins.repository.data.holder.group.impl.AbstractComposite
copyTo, dataToSAX, getDataNames, getRepositoryData, hasNonEmptyValue, hasValue
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.DataHolder
copyTo, dataToSAX, getDataNames, getRepositoryData
Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder
dataToSAX, hasNonEmptyValue, hasValue
-
Field Details
-
_defaultDataHolder
the default implementation of aModelLessDataHolder
to use
-
-
Constructor Details
-
ModelLessComposite
public ModelLessComposite(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, RepositoryData repositoryData, ModelLessDataHolder parent, ModelLessDataHolder root) Creates a model free composite- Parameters:
typeExtensionPoint
- the extension point to use to get available element typesparent
- the parent of the createdDataHolder
root
- the rootDataHolder
repositoryData
- the repository data to use
-
-
Method Details
-
getComposite
public ModelLessComposite getComposite(String compositePath) throws IllegalArgumentException, BadItemTypeException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Retrieves the composite at the given path- Specified by:
getComposite
in interfaceDataHolder
- Specified by:
getComposite
in interfaceModelLessDataHolder
- 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 emptyBadItemTypeException
- if the stored value at the given path is not a compositeBadDataPathCardinalityException
- if the value 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, UnknownTypeException, NotUniqueTypeException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Retrieves the value of the data at the given path The type of the value will be deduced from the stored data. In some cases, the type can be wrong. For example, it is impossible to know if a stored date is a date or a date time- Specified by:
getValue
in interfaceModelLessDataHolder
- Type Parameters:
T
- type of the value to retrieve. Should match the given data type- Parameters:
dataPath
- path of the data- Returns:
- the value of the data or
null
if not exists or is empty. The object returned may be of a generic class defined by the storage. For example, an url may be returned as a String. Use the 2 arguments version to ensure to get the right kind of Object. - Throws:
IllegalArgumentException
- if the given data path is null or emptyUnknownTypeException
- if there is no compatible type with the data at the given data pathNotUniqueTypeException
- if there are many compatible types (there is no way to determine which type is the good one)BadDataPathCardinalityException
- if the value of a part of the data path is multiple. Only the last part can be multiple
-
getValue
public <T> T getValue(String dataPath, T defaultValue) throws IllegalArgumentException, UnknownTypeException, NotUniqueTypeException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Retrieves the value of the data at the given path if exists and is not empty, or the default value- Specified by:
getValue
in interfaceModelLessDataHolder
- Type Parameters:
T
- type of the value to retrieve. Should match the given data type- Parameters:
dataPath
- path of the datadefaultValue
- default value- Returns:
- the value of the data,
null
if the data exists but is empty, or the given default value - Throws:
IllegalArgumentException
- if the given data path is null or emptyUnknownTypeException
- if there is no compatible type with the data at the given data pathNotUniqueTypeException
- if there are many compatible types (there is no way to determine which type is the good one)BadDataPathCardinalityException
- if the value of a part of the data path is multiple. Only the last part can be multiple
-
getValueOfType
public <T> T getValueOfType(String dataPath, String dataTypeId) throws IllegalArgumentException, UnknownTypeException, BadItemTypeException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Retrieves the value of the data at the given path- Specified by:
getValueOfType
in interfaceModelLessDataHolder
- Type Parameters:
T
- type of the value to retrieve. Should match the given data type- Parameters:
dataPath
- path of the datadataTypeId
- type identifier 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 emptyUnknownTypeException
- if the given type isn't available for this data holder's type extension pointBadItemTypeException
- if the given type doesn't match the type of the stored value at the given pathBadDataPathCardinalityException
- if the value of a part of the data path is multiple. Only the last part can be multiple
-
getValueOfType
public <T> T getValueOfType(String dataPath, String dataTypeId, T defaultValue) throws IllegalArgumentException, UnknownTypeException, BadItemTypeException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Retrieves the value of the data at the given path if exists and is not empty, or the default value- Specified by:
getValueOfType
in interfaceModelLessDataHolder
- Type Parameters:
T
- type of the value to retrieve. Should match the given data type- Parameters:
dataPath
- path of the datadataTypeId
- type identifier of the datadefaultValue
- default value- Returns:
- the value of the data,
null
if the data exists but is empty, or the given default value - Throws:
IllegalArgumentException
- if the given data path is null or emptyUnknownTypeException
- if the given type isn't available for this data holder's type extension pointBadItemTypeException
- if the given type doesn't match the type of the stored value at the given pathBadDataPathCardinalityException
- if the value of a part of the data path is multiple. Only the last part can be multiple
-
isMultiple
public boolean isMultiple(String dataPath) throws IllegalArgumentException, UnknownDataException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Checks if the value of the data at the given path is multiple- Specified by:
isMultiple
in interfaceModelLessDataHolder
- Parameters:
dataPath
- path of the data to check- Returns:
true
if the value of the data is multiple,false
otherwise- Throws:
IllegalArgumentException
- if the given data path is null or emptyUnknownDataException
- the data at the given path does not existBadDataPathCardinalityException
- if the value of a part of the data path is multiple. Only the last part can be multiple
-
getType
public RepositoryModelItemType getType(String dataPath) throws IllegalArgumentException, UnknownDataException, UnknownTypeException, NotUniqueTypeException, BadDataPathCardinalityException Description copied from interface:ModelLessDataHolder
Retrieves the type of the data at the given path- Specified by:
getType
in interfaceModelLessDataHolder
- Parameters:
dataPath
- path of the data- Returns:
- the type of the data
- Throws:
IllegalArgumentException
- if the given data path is null or emptyUnknownDataException
- if there is no data stored at the given pathUnknownTypeException
- 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 availableNotUniqueTypeException
- if there are many compatible types (there is no way to determine which type is the good one)BadDataPathCardinalityException
- if the value of a part of the data path is multiple. Only the last part can be multiple
-
dataToSAX
public void dataToSAX(ContentHandler contentHandler, String dataPath, DataContext context) throws SAXException, IOException Description copied from interface:DataHolder
Generates SAX events for the data at the given data path in the currentDataHolder
Do not generate any event if there is no values at the given path- Specified by:
dataToSAX
in interfaceDataHolder
- Parameters:
contentHandler
- theContentHandler
that will receive the SAX eventsdataPath
- the path of the data to SAXcontext
- The context of the data to SAX- Throws:
SAXException
- if an error occurs during the SAX events generationIOException
- if an error occurs while reading a value using the I/O API
-
dataToSAX
public void dataToSAX(ContentHandler contentHandler, DataContext context) throws SAXException, IOException, UnknownTypeException, NotUniqueTypeException Description copied from interface:ModelLessDataHolder
Generates SAX events for data contained in thisDataHolder
- Specified by:
dataToSAX
in interfaceModelLessDataHolder
- Parameters:
contentHandler
- theContentHandler
that will receive the SAX eventscontext
- The context of the data to SAX- Throws:
SAXException
- if an error occurs during the SAX events generationIOException
- if an error occurs while reading a value using the I/O APIUnknownTypeException
- if there is no compatible type with the saxed valueNotUniqueTypeException
- if there are many compatible types (there is no way to determine which type is the good one) with the saxed value
-
getParentDataHolder
Description copied from interface:DataHolder
Retrieves the optional parent of the currentDataHolder
There can be no parent if the currentDataHolder
is the root- Specified by:
getParentDataHolder
in interfaceDataHolder
- Specified by:
getParentDataHolder
in interfaceModelLessDataHolder
- Returns:
- the parent of the current
DataHolder
-
getRootDataHolder
Description copied from interface:DataHolder
Retrieves theDataHolder
that is the root of the current one- Specified by:
getRootDataHolder
in interfaceDataHolder
- Specified by:
getRootDataHolder
in interfaceModelLessDataHolder
- Returns:
- the root
DataHolder
-
getDefaultDataHolder
Description copied from class:AbstractComposite
Retrieves the default implementation of aDataHolder
to use- Specified by:
getDefaultDataHolder
in classAbstractComposite
- Returns:
- the
DataHolder
-