org.ametys.plugins.repository.data.holder

Interface ModelAwareDataHolder

All Superinterfaces:

DataHolder

All Known Subinterfaces:

CommentableContent, Content, ModelAwareDataAwareAmetysObject, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, ModifiableWebContent, ModifiableWorkflowAwareContent, SharedContent, WebContent, WorkflowAwareContent

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, ContentValue, Course, CourseList, CoursePart, DefaultContent, DefaultModelAwareDataHolder, DefaultModifiableModelAwareDataHolder, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, ModelAwareComposite, ModelAwareRepeaterEntry, ModifiableDefaultContent, ModifiableDefaultWebContent, ModifiableModelAwareComposite, ModifiableModelAwareRepeaterEntry, OrgUnit, Person, Program, Site, SubProgram

public interface ModelAwareDataHolder
extends DataHolder

Interface for data containers with models

Method Summary

Modifier and Type	Method and Description
ModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
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
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

ModelAwareComposite getComposite(String compositePath)
                          throws IllegalArgumentException,
                                 UndefinedItemPathException,
                                 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:

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

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

ModelAwareRepeater getRepeater(String repeaterPath)
                        throws IllegalArgumentException,
                               UndefinedItemPathException,
                               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:

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

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 definition 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,
               UndefinedItemPathException,
               BadItemTypeException,
               BadDataPathCardinalityException

Retrieves the value of the data at the given path

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

<T> T getValue(String dataPath,
               boolean useDefaultFromModel,
               T defaultValue)
        throws IllegalArgumentException,
               UndefinedItemPathException,
               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

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

isMultiple

boolean isMultiple(String path)
            throws IllegalArgumentException,
                   UndefinedItemPathException

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

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

ModelItemType getType(String path)
               throws IllegalArgumentException,
                      UndefinedItemPathException

Retrieves the type of the data at the given path

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

toSAX

default void toSAX(ContentHandler contentHandler)
            throws SAXException,
                   UndefinedItemPathException,
                   BadItemTypeException

Generates SAX events for current DataHolder

Specified by:

toSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

Throws:

UndefinedItemPathException - if the saxed value's path is not defined by the model

BadItemTypeException - if the saxed value's type does not matches the stored data

SAXException - if an error occurs during the SAX events generation

toSAX

default void toSAX(ContentHandler contentHandler,
                   Locale locale)
            throws SAXException,
                   UndefinedItemPathException,
                   BadItemTypeException

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:

UndefinedItemPathException - if the saxed value's path is not defined by the model

BadItemTypeException - if the saxed value's type does not matches the stored data

SAXException - if an error occurs during the SAX events generation