org.ametys.plugins.repository.data.holder

Interface ModelLessDataHolder

All Superinterfaces:

DataHolder

All Known Subinterfaces:

MetadataAwarePagesContainer, ModelLessDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, ModifiablePage, ModifiableZone, ModifiableZoneItem, Page, Zone, ZoneItem

All Known Implementing Classes:

AbstractBlogPage, AbstractLevelPage, AbstractOdfPage, CoursePage, CourseZone, CourseZoneItem, DefaultModelLessDataHolder, DefaultModifiableModelLessDataHolder, DefaultPage, DefaultZone, DefaultZoneItem, FirstLevelPage, FirstLevelZone, FirstLevelZoneItem, JCRProjectMember, ModelLessComposite, ModelLessRepeaterEntry, ModifiableModelLessComposite, ModifiableModelLessRepeaterEntry, OrgUnitPage, OrgUnitZone, OrgUnitZoneItem, PostListZone, PostListZoneItem, PostZone, PostZoneItem, ProgramPage, ProgramZone, ProgramZoneItem, Project, ProjectCategory, RedirectPage, SecondLevelPage, SecondLevelZone, SecondLevelZoneItem, Sitemap, StaticZone, StaticZoneItem, TransitionalPage, TransitionalZone, TransitionalZoneItem, UGCPage, UGCTransitionalPage, UGCTransitionalZone, UGCTransitionalZoneItem, UGCZone, UGCZoneItem, UserPage, UserZone, UserZoneItem, VirtualMonthPage, VirtualPostPage, VirtualPostsPage, VirtualTagPage, VirtualTagsPage, VirtualYearPage, VirtualYearsPage

public interface ModelLessDataHolder
extends DataHolder

Interface for data containers without models

Method Summary

Modifier and Type	Method and Description
ModelLessComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModelLessRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModelItemType	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, 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, or the default value
boolean	hasValue(String dataPath) Checks if there is a value for the data at the given path
boolean	isMultiple(String dataPath) Checks if the value of the data at the given path is multiple
default void	toSAX(ContentHandler contentHandler) Generates SAX events for current DataHolder
default void	toSAX(ContentHandler contentHandler, Locale locale) Generates SAX events for the current DataHolder

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames

Method Detail

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

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 value stored in the repository at the given path is not a composite

getRepeater

ModelLessRepeater getRepeater(String repeaterPath)
                       throws IllegalArgumentException,
                              BadItemTypeException,
                              BadDataPathCardinalityException

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

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

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

hasValue

boolean hasValue(String dataPath)
          throws IllegalArgumentException,
                 BadDataPathCardinalityException

Checks if there is a 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 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

getValue

<T> T getValue(String dataPath)
        throws IllegalArgumentException,
               UnknownTypeException,
               NotUniqueTypeException,
               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. 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)

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

Retrieves the value of the data at the given path, 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

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)

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

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

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

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

getType

ModelItemType 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 in the repository 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

toSAX

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

Generates SAX events for current DataHolder

Specified by:

toSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

Throws:

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

SAXException - if an error occurs during the SAX events generation

toSAX

default void toSAX(ContentHandler contentHandler,
                   Locale locale)
            throws SAXException,
                   UnknownTypeException,
                   NotUniqueTypeException

Generates SAX events for the current DataHolder

Specified by:

toSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

locale - The locale to use for localized data, such as MultilingualString. Can be null to generate SAX events for all existing Locales.

Throws:

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

SAXException - if an error occurs during the SAX events generation