org.ametys.plugins.repository.data.holder

Interface DataHolder

All Known Subinterfaces:

CommentableContent, Composite, Content, DataAwareAmetysObject, MetadataAwarePagesContainer, ModelAwareDataAwareAmetysObject, ModelAwareDataHolder, ModelLessDataAwareAmetysObject, ModelLessDataHolder, ModifiableComposite, ModifiableContent, ModifiableDataHolder, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, ModifiablePage, ModifiableRepeaterEntry, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem, Page, RepeaterEntry, SharedContent, WebContent, WorkflowAwareContent, Zone, ZoneItem

All Known Implementing Classes:

AbstractBlogPage, AbstractComposite, AbstractLevelPage, AbstractOdfPage, AbstractProgram, AbstractProgramPart, AbstractRepeaterEntry, AbstractTraversableProgramPart, Container, ContentValue, Course, CourseList, CoursePage, CoursePart, CourseZone, CourseZoneItem, DefaultContent, DefaultModelAwareDataHolder, DefaultModelLessDataHolder, DefaultModifiableModelAwareDataHolder, DefaultModifiableModelLessDataHolder, DefaultPage, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, DefaultZone, DefaultZoneItem, FirstLevelPage, FirstLevelZone, FirstLevelZoneItem, JCRProjectMember, ModelAwareComposite, ModelAwareRepeaterEntry, ModelLessComposite, ModelLessRepeaterEntry, ModifiableDefaultContent, ModifiableDefaultWebContent, ModifiableModelAwareComposite, ModifiableModelAwareRepeaterEntry, ModifiableModelLessComposite, ModifiableModelLessRepeaterEntry, OrgUnit, OrgUnitPage, OrgUnitZone, OrgUnitZoneItem, Person, PostListZone, PostListZoneItem, PostZone, PostZoneItem, Program, ProgramPage, ProgramZone, ProgramZoneItem, Project, ProjectCategory, RedirectPage, SecondLevelPage, SecondLevelZone, SecondLevelZoneItem, Site, Sitemap, StaticZone, StaticZoneItem, SubProgram, TransitionalPage, TransitionalZone, TransitionalZoneItem, UGCPage, UGCTransitionalPage, UGCTransitionalZone, UGCTransitionalZoneItem, UGCZone, UGCZoneItem, UserPage, UserZone, UserZoneItem, VirtualMonthPage, VirtualPostPage, VirtualPostsPage, VirtualTagPage, VirtualTagsPage, VirtualYearPage, VirtualYearsPage

public interface DataHolder

Interface for data containers

Method Summary

Modifier and Type	Method and Description
default void	copyTo(ModifiableDataHolder dataHolder) Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
default void	dataToSAX(ContentHandler contentHandler, String dataPath) Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
default void	dataToSAX(ContentHandler contentHandler, String dataPath, Locale locale) Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
default void	dataToSAX(ContentHandler contentHandler, String dataPath, String tagName) Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
default void	dataToSAX(ContentHandler contentHandler, String dataPath, String tagName, Locale locale) Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
Composite	getComposite(String compositePath) Retrieves the composite at the given path
Collection<String>	getDataNames() Retrieves the names of data contained by this data holder
Repeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
boolean	hasValue(String dataPath) Checks if there is a value for the data at the given path
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

Method Detail

getComposite

Composite getComposite(String compositePath)
                throws IllegalArgumentException,
                       BadItemTypeException

Retrieves the composite at the given path

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

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

getRepeater

Repeater getRepeater(String repeaterPath)
              throws IllegalArgumentException,
                     BadItemTypeException

Retrieves the repeater at the given path

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

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

hasValue

boolean hasValue(String dataPath)
          throws IllegalArgumentException

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

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

getDataNames

Collection<String> getDataNames()

Retrieves the names of data contained by this data holder

Returns:

the paths of all data contained by this data holder

copyTo

default void copyTo(ModifiableDataHolder dataHolder)
             throws UndefinedItemPathException,
                    BadItemTypeException,
                    UnknownTypeException,
                    NotUniqueTypeException

Copies the current DataHolder to the given ModifiableModelAwareDataHolder.

Parameters:

dataHolder - The destination dataHolder. Can not be null.

Throws:

UndefinedItemPathException - if one of the copied data is not defined by the model of the destination ModifiableModelAwareDataHolder

BadItemTypeException - if the type defined by the model of the destination ModifiableModelAwareDataHolder doesn't match the copied value

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableModelLessDataHolder

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableModelLessDataHolder

toSAX

default void toSAX(ContentHandler contentHandler)
            throws SAXException

Generates SAX events for current DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

Throws:

SAXException - if an error occurs during the SAX events generation

toSAX

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

Generates SAX events for the current 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:

SAXException - if an error occurs during the SAX events generation

dataToSAX

default void dataToSAX(ContentHandler contentHandler,
                       String dataPath)
                throws SAXException

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

dataToSAX

default void dataToSAX(ContentHandler contentHandler,
                       String dataPath,
                       String tagName)
                throws SAXException

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

tagName - the tag name of the SAX event to generate. If null the name of the data is used

Throws:

SAXException - if an error occurs during the SAX events generation

dataToSAX

default void dataToSAX(ContentHandler contentHandler,
                       String dataPath,
                       Locale locale)
                throws SAXException

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

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

Throws:

SAXException - if an error occurs during the SAX events generation

dataToSAX

default void dataToSAX(ContentHandler contentHandler,
                       String dataPath,
                       String tagName,
                       Locale locale)
                throws SAXException

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

tagName - the tag name of the SAX event to generate. If null the name of the data is used

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

Throws:

SAXException - if an error occurs during the SAX events generation