Package org.ametys.plugins.repository.data.ametysobject

Interface DataAwareAmetysObject

All Superinterfaces:

AmetysObject, DataHolder

All Known Subinterfaces:

CommentableContent, Content, MetadataAwarePagesContainer, ModelAwareDataAwareAmetysObject, ModelAwareJCRAmetysObject, ModelLessDataAwareAmetysObject, ModelLessJCRAmetysObject, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, ModifiablePage, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem, Page, ProgramPart, SharedContent, TraversableProgramPart, WebContent, WorkflowAwareContent, Zone, ZoneItem

All Known Implementing Classes:

AbstractBlogPage, AbstractLevelPage, AbstractOdfPage, AbstractProgram, AbstractProgramPart, AbstractSurveyElement, AbstractTraversableProgramPart, Catalog, Container, ContentBackupAmetysObject, Course, CourseList, CoursePage, CoursePart, CourseZone, CourseZoneItem, DefaultContent, DefaultLink, DefaultPage, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, DefaultZone, DefaultZoneItem, FirstLevelPage, FirstLevelZone, FirstLevelZoneItem, JCRProjectMember, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, OrgUnitPage, OrgUnitZone, OrgUnitZoneItem, Person, PostListZone, PostListZoneItem, PostZone, PostZoneItem, Program, ProgramPage, ProgramZone, ProgramZoneItem, Project, RedirectPage, SecondLevelPage, SecondLevelZone, SecondLevelZoneItem, Site, Sitemap, StaticZone, StaticZoneItem, SubProgram, Survey, SurveyPage, SurveyQuestion, TransitionalPage, TransitionalZone, TransitionalZoneItem, UGCPage, UGCTransitionalPage, UGCTransitionalZone, UGCTransitionalZoneItem, UGCZone, UGCZoneItem, UserPage, UserZone, UserZoneItem, VirtualMonthPage, VirtualPostPage, VirtualPostsPage, VirtualTagPage, VirtualTagsPage, VirtualYearPage, VirtualYearsPage

public interface DataAwareAmetysObject
extends AmetysObject, DataHolder

AmetysObject that can handle data.

Method Summary

Modifier and Type	Method	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, DataContext context)	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 Composite	getComposite(String compositePath)	Retrieves the composite at the given path
DataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
default Collection<String>	getDataNames()	Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data
default Optional<? extends DataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default RepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
default DataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default boolean	hasNonEmptyValue(String dataPath)	Checks if there is a non empty value for the data at the given path
default boolean	hasValue(String dataPath)	Checks if there is a value for the data at the given path

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Method Detail

getDataHolder

DataHolder getDataHolder()

Returns the DataHolder of this AmetysObject.

Returns:

the DataHolder of this AmetysObject

getComposite

default Composite getComposite(String compositePath)
                        throws IllegalArgumentException,
                               BadItemTypeException

Description copied from interface: DataHolder

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:

IllegalArgumentException - if the given composite path is null or empty

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

hasValue

default boolean hasValue(String dataPath)
                  throws IllegalArgumentException

Description copied from interface: DataHolder

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 (even empty) for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

hasNonEmptyValue

default boolean hasNonEmptyValue(String dataPath)
                          throws IllegalArgumentException

Description copied from interface: DataHolder

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

Specified by:

hasNonEmptyValue in interface DataHolder

Parameters:

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

getDataNames

default Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data

Specified by:

getDataNames in interface DataHolder

Returns:

the names of all data contained by this data holder

copyTo

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

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableModelAwareDataHolder.

Specified by:

copyTo in interface DataHolder

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

dataToSAX

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

Description copied from interface: DataHolder

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

Specified by:

dataToSAX in interface DataHolder

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

IOException - if an error occurs while reading a value using the I/O API

dataToSAX

default 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 current DataHolder Do not generate any event if there is no values at the given path

Specified by:

dataToSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

IOException - if an error occurs while reading a value using the I/O API

getRepositoryData

default RepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

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

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