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

Interface ModelLessDataHolder

All Superinterfaces:

DataHolder

All Known Subinterfaces:

MetadataAwareSitemapElement, ModelLessComposite, ModelLessDataAwareAmetysObject, ModelLessJCRAmetysObject, ModifiableModelLessComposite, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, ModifiablePage, ModifiableZone, ModifiableZoneItem, Page, Zone, ZoneItem

All Known Implementing Classes:

AbstractLevelPage, AbstractOdfPage, AbstractSitemapElement, AbstractSurveyElement, Activity, CMISRootResourcesCollection, CoursePage, CourseZone, CourseZoneItem, DefaultLink, DefaultModelLessComposite, DefaultModelLessDataHolder, DefaultModifiableModelLessComposite, DefaultModifiableModelLessDataHolder, DefaultPage, DefaultZone, DefaultZoneItem, FirstLevelPage, FirstLevelZone, FirstLevelZoneItem, JCRProjectMember, JCRResourcesCollection, OrgUnitPage, OrgUnitZone, OrgUnitZoneItem, ProgramPage, ProgramZone, ProgramZoneItem, Project, RedirectPage, SecondLevelPage, SecondLevelZone, SecondLevelZoneItem, Sitemap, StaticZoneItem, Survey, SurveyPage, SurveyQuestion, TransitionalPage, TransitionalZone, TransitionalZoneItem, UGCPage, UGCTransitionalPage, UGCTransitionalZone, UGCTransitionalZoneItem, UGCZone, UGCZoneItem, UserPage, UserZone, UserZoneItem

public interface ModelLessDataHolder
extends DataHolder

Interface for data containers without models

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	dataToJSON()	Convert the data contained in this DataHolder
Map<String,Object>	dataToJSON(DataContext context)	Convert the data contained in this DataHolder
default void	dataToSAX(ContentHandler contentHandler)	Generates SAX events for data contained in this DataHolder
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
ModelLessComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModelItemTypeExtensionPoint	getModelItemTypeExtensionPoint()	Provide the ModelItemTypeExtensionPoint linked with the DataHolder
Optional<? extends ModelLessDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModelLessDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
RepositoryModelItemType	getType(String dataPath)	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 The type of the value will be deduced from the stored data.
<T> T	getValue(String dataPath, T defaultValue)	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 value
boolean	hasValue(String dataPath)	Checks if there is a non empty value for the data at the given path
boolean	hasValue(String dataPath, String dataTypeId)	Checks if there is a non empty value for the data at the given path
boolean	hasValueOrEmpty(String dataPath)	Checks if there is a value, even empty, for the data at the given path
boolean	isMultiple(String dataPath)	Checks if the value of the data at the given path is multiple
boolean	isMultiple(String dataPath, String dataTypeId)	Checks if the value of the data at the given path is multiple

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

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames, getRepositoryData

Method Details

getComposite

ModelLessComposite getComposite(String compositePath)
                         throws IllegalArgumentException,
BadItemTypeException,
BadDataPathCardinalityException

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

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

IllegalArgumentException - if the given composite path is null or empty

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

hasValue

boolean hasValue(String dataPath)
          throws IllegalArgumentException,
BadDataPathCardinalityException

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

Specified by:

hasValue in interface DataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is a non empty value for the data, false otherwise

Throws:

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

IllegalArgumentException - if the given data path is null or empty

hasValue

boolean hasValue(String dataPath,
 String dataTypeId)
          throws IllegalArgumentException,
UnknownTypeException,
BadDataPathCardinalityException

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

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

true if there is a non empty value for the data, false otherwise

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

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

hasValueOrEmpty

boolean hasValueOrEmpty(String dataPath)
                 throws IllegalArgumentException,
BadDataPathCardinalityException

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

Specified by:

hasValueOrEmpty in interface DataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value, even empty, for the data, false otherwise

Throws:

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

IllegalArgumentException - if the given data path is null or empty

getValue

<T> T getValue(String dataPath)
        throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
BadDataPathCardinalityException

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

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 empty

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

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

getValue

<T> T getValue(String dataPath,
 T defaultValue)
        throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
BadDataPathCardinalityException

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

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

defaultValue - 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 empty

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

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

getValueOfType

<T> T getValueOfType(String dataPath,
 String dataTypeId)
              throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
BadDataPathCardinalityException

Retrieves the value of the data at the given path

Type Parameters:

T - type of the value to retrieve. Should match the given data type

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

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

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

getValueOfType

<T> T getValueOfType(String dataPath,
 String dataTypeId,
 T defaultValue)
              throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
BadDataPathCardinalityException

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

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

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

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

isMultiple

boolean isMultiple(String dataPath)
            throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
BadDataPathCardinalityException

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

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

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

isMultiple

boolean isMultiple(String dataPath,
 String dataTypeId)
            throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException,
BadDataPathCardinalityException

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

Parameters:

dataPath - path of the data to check

dataTypeId - type identifier of the data

Returns:

true if the value of the data 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

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

getType

RepositoryModelItemType getType(String dataPath)
                         throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadDataPathCardinalityException

Retrieves the type of the data at the given path

Parameters:

dataPath - path of the data

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)

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

dataToSAX

default void dataToSAX(ContentHandler contentHandler)
                throws SAXException,
UnknownTypeException,
NotUniqueTypeException

Generates SAX events for data contained in this DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

Throws:

SAXException - if an error occurs during the SAX events generation

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

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

dataToSAX

void dataToSAX(ContentHandler contentHandler,
 DataContext context)
        throws SAXException,
UnknownTypeException,
NotUniqueTypeException

Generates SAX events for data contained in this DataHolder

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

dataToJSON

default Map<String,Object> dataToJSON()
                               throws UnknownTypeException,
NotUniqueTypeException

Convert the data contained in this DataHolder

Returns:

The data of the current 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

dataToJSON

Map<String,Object> dataToJSON(DataContext context)
                       throws UnknownTypeException,
NotUniqueTypeException

Convert the data contained in this DataHolder

Parameters:

context - The context of the data to convert

Returns:

The data of the current 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

getParentDataHolder

Optional<? extends ModelLessDataHolder> 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 DataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

ModelLessDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Returns:

the root DataHolder

getModelItemTypeExtensionPoint

ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

Returns:

the extension point