Package org.ametys.plugins.workspaces.calendars.task

Class TaskCalendarEvent

java.lang.Object

org.ametys.plugins.workspaces.calendars.task.TaskCalendarEvent

All Implemented Interfaces:

IndexableAmetysObject, IndexableDataHolder, AmetysObject, ModelAwareAmetysObject, DataHolder, ModelAwareDataHolder, TagAwareAmetysObject, TaggableAmetysObject, CalendarEvent

public class TaskCalendarEvent
extends Object
implements CalendarEvent

Object for a task calendar event

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
TaskCalendarEvent(Calendar calendar, Task task)	The constructor

Method Summary

Modifier and Type	Method	Description
void	copyTo(ModifiableDataHolder dataHolder)	Copies the current DataHolder to the given ModifiableDataHolder.
void	copyTo(ModifiableDataHolder dataHolder, DataContext context)	Copies the current DataHolder to the given ModifiableDataHolder.
Object	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
Map<String,Object>	dataToJSON(ViewItemAccessor viewItemAccessor, DataContext context)	Convert the data in the given view of the current DataHolder
Map<String,Object>	dataToJSONForEdition(ViewItemAccessor viewItemAccessor, DataContext context)	Convert the data in the given view in edition mode in the current DataHolder
Map<String,Object>	dataToMap(ViewItemAccessor viewItemAccessor, DataContext context)	Retrieves data of this DataHolder as a typed-values Map.
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
void	dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in the current DataHolder
void	dataToSAXForEdition(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in edition mode in the current DataHolder
Calendar	getCalendar()	Get the calendar holding the event
IndexableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ZonedDateTime	getCreationDate()	Retrieves the creation date.
UserIdentity	getCreator()	Retrieves the the creator.
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
String	getDescription()	Get the description of the event
Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values)	Get the collection of model items where there are differences between the given values and the current ones
Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the current ones
ZonedDateTime	getEndDate()	Get the date of the end of the event
List<ZonedDateTime>	getExcludedOccurences()	Retrieves the list of excluded event date.
IndexableComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
IndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
<T> T	getExternalValue(String dataPath)	Retrieves the external value of the data at the given path
Optional<CalendarEventOccurrence>	getFirstOccurrence(ZonedDateTime date)	Retrieves the start date of the first Event which end after the date
Boolean	getFullDay()	Get if the event last all the day
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
UserIdentity	getLastContributor()	Retrieves the last contributor.
ZonedDateTime	getLastModified()	Retrieves the last modification date.
IndexableComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
IndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
<T> T	getLocalValue(String dataPath)	Retrieves the local value of the data at the given path
String	getLocation()	Get the location of the event
Collection<? extends Model>	getModel()	Retrieves the data holder's model
String	getName()	Retrieves the name of the current object.
Optional<CalendarEventOccurrence>	getNextOccurrence(CalendarEventOccurrence occurrence)	Retrieves the date of the next event after the date
List<CalendarEventOccurrence>	getOccurrences(ZonedDateTime startDate, ZonedDateTime endDate)	Retrieves the list of all event date between startDate and endDate.
UserIdentity	getOrganiser()	Retrieves the organiser.
<A extends AmetysObject> A	getParent()	Returns the parent object in the Ametys hierarchy.
Optional<? extends IndexableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPath()	Retrieves the path of the current object.
EventRecurrenceTypeEnum	getRecurrenceType()	Retrieves the recurrence type.
IndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ZonedDateTime	getRepeatUntil()	Retrieves the upper bound of the recurrence This bound is inclusive, meaning that if it is synchronized (ie on a recurrence day at the event starting hour) with the recurrence, it represents the starting date of the last occurrence
RepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
List<String>	getResources()	Retrieves the resource list.
IndexableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
ZonedDateTime	getStartDate()	Get the date of the begin of the event
ExternalizableDataProvider.ExternalizableDataStatus	getStatus(String dataPath)	Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable.
Set<String>	getTags()	Retrieves current tags.
Task	getTask()	Return the task link to the calendar event
String	getTitle()	Get the title of the event
<X extends ModelItemType> X	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
<T> T	getValueOfType(String dataPath, String dataTypeId)	Retrieves the value of the data at the given path
<T> T	getValueOfTypeOrDefault(String dataPath, String dataTypeId, T defaultValue)	Retrieves the value of the data at the given path if exists and is not empty, or the given default value
<T> T	getValueOrDefault(String dataPath)	Retrieves the value of the data at the given path if exists and is not empty, or the default value from the model
<T> T	getValueOrDefault(String dataPath, T defaultValue)	Retrieves the value of the data at the given path if exists and is not empty, or the given default value
<T> T	getValueWithMultiValuedPathSegments(String dataPath)	Retrieves the value of the data at the given path, allowing multi-valued segments in the path (not necessarily at the last segment) if there is no indicated entry for a repeater, the values of all the entries are retrieved if there are multiple values, all data are retrieved in one array
ZoneId	getZone()	Get the date zone of the event
boolean	hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values)	Check if there are differences between the given values and the current ones
boolean	hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)	Check if there are differences between the given values and the current ones
boolean	hasExternalValue(String dataPath)	Checks if there is a non empty external value for the data at the given path
boolean	hasExternalValueOrEmpty(String dataPath)	Checks if there is an external value for the data at the given path
boolean	hasLocalValue(String dataPath)	Checks if there is a non empty local value for the data at the given path
boolean	hasLocalValueOrEmpty(String dataPath)	Checks if there is a local value for the data at the given path
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
List<org.apache.solr.common.SolrInputDocument>	indexData(org.apache.solr.common.SolrInputDocument document, CMSDataContext context)	Indexes all data and properties of this AmetysObject
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
Boolean	isRecurrent()	Retrieves if the event is recurrent.
void	tag(String tag)	Tags.
void	untag(String tag)	Untags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

equals, hashCode

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

dataToJSON, dataToSAX

Methods inherited from interface org.ametys.cms.data.ametysobject.IndexableAmetysObject

getSystemPropertyExtensionPoint, indexData

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

dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDefinition, getDifferences, getDifferences, getModelItemTypeExtensionPoint, hasDefinition, hasDifferences, hasDifferences

Constructor Details

TaskCalendarEvent

public TaskCalendarEvent(Calendar calendar,
 Task task)

The constructor

Parameters:

calendar - the calendar

task - the task

Method Details

getTask

public Task getTask()

Return the task link to the calendar event

Returns:

the task

tag

public void tag(String tag)
         throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Tags.

Specified by:

tag in interface TaggableAmetysObject

Parameters:

tag - the tag to add.

Throws:

AmetysRepositoryException - if an error occurs.

untag

public void untag(String tag)
           throws AmetysRepositoryException

Description copied from interface: TaggableAmetysObject

Untags.

Specified by:

untag in interface TaggableAmetysObject

Parameters:

tag - the tag to remove.

Throws:

AmetysRepositoryException - if an error occurs.

getTags

public Set<String> getTags()
                    throws AmetysRepositoryException

Description copied from interface: TagAwareAmetysObject

Retrieves current tags.

Specified by:

getTags in interface TagAwareAmetysObject

Returns:

the current tags.

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getParent

public <A extends AmetysObject> A getParent()
                                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Type Parameters:

A - the type of the parent AmetysObject.

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getCalendar

public Calendar getCalendar()

Description copied from interface: CalendarEvent

Get the calendar holding the event

Specified by:

getCalendar in interface CalendarEvent

Returns:

the calendar

getTitle

public String getTitle()

Description copied from interface: CalendarEvent

Get the title of the event

Specified by:

getTitle in interface CalendarEvent

Returns:

the title of the event

getDescription

public String getDescription()

Description copied from interface: CalendarEvent

Get the description of the event

Specified by:

getDescription in interface CalendarEvent

Returns:

the description of the event

getLocation

public String getLocation()

Description copied from interface: CalendarEvent

Get the location of the event

Specified by:

getLocation in interface CalendarEvent

Returns:

the location of the event

getStartDate

public ZonedDateTime getStartDate()

Description copied from interface: CalendarEvent

Get the date of the begin of the event

Specified by:

getStartDate in interface CalendarEvent

Returns:

the date of the event

getEndDate

public ZonedDateTime getEndDate()

Description copied from interface: CalendarEvent

Get the date of the end of the event

Specified by:

getEndDate in interface CalendarEvent

Returns:

the date of the event

getZone

public ZoneId getZone()

Description copied from interface: CalendarEvent

Get the date zone of the event

Specified by:

getZone in interface CalendarEvent

Returns:

the date zone of the event

getFullDay

public Boolean getFullDay()

Description copied from interface: CalendarEvent

Get if the event last all the day

Specified by:

getFullDay in interface CalendarEvent

Returns:

true if the event last all the day

getCreator

public UserIdentity getCreator()

Description copied from interface: CalendarEvent

Retrieves the the creator.

Specified by:

getCreator in interface CalendarEvent

Returns:

the creator.

getCreationDate

public ZonedDateTime getCreationDate()

Description copied from interface: CalendarEvent

Retrieves the creation date.

Specified by:

getCreationDate in interface CalendarEvent

Returns:

the creation date.

getLastContributor

public UserIdentity getLastContributor()

Description copied from interface: CalendarEvent

Retrieves the last contributor.

Specified by:

getLastContributor in interface CalendarEvent

Returns:

the last contributor.

getLastModified

public ZonedDateTime getLastModified()

Description copied from interface: CalendarEvent

Retrieves the last modification date.

Specified by:

getLastModified in interface CalendarEvent

Returns:

the last modification date.

getRecurrenceType

public EventRecurrenceTypeEnum getRecurrenceType()

Description copied from interface: CalendarEvent

Retrieves the recurrence type.

Specified by:

getRecurrenceType in interface CalendarEvent

Returns:

the recurrence type.

isRecurrent

public Boolean isRecurrent()

Description copied from interface: CalendarEvent

Retrieves if the event is recurrent.

Specified by:

isRecurrent in interface CalendarEvent

Returns:

true if the event is recurrent.

getRepeatUntil

public ZonedDateTime getRepeatUntil()

Description copied from interface: CalendarEvent

Retrieves the upper bound of the recurrence This bound is inclusive, meaning that if it is synchronized (ie on a recurrence day at the event starting hour) with the recurrence, it represents the starting date of the last occurrence

Specified by:

getRepeatUntil in interface CalendarEvent

Returns:

the last possible start instant of the recurrence.

getExcludedOccurences

public List<ZonedDateTime> getExcludedOccurences()

Description copied from interface: CalendarEvent

Retrieves the list of excluded event date.

Specified by:

getExcludedOccurences in interface CalendarEvent

Returns:

the list of excluded event date as ZonedDateTime representing midnight in event timezone. No guarantee is provided for the actual timezone of the returned date, only the instant it represents is guaranteed

getOccurrences

public List<CalendarEventOccurrence> getOccurrences(ZonedDateTime startDate,
 ZonedDateTime endDate)

Description copied from interface: CalendarEvent

Retrieves the list of all event date between startDate and endDate.

Specified by:

getOccurrences in interface CalendarEvent

Parameters:

startDate - the start date

endDate - the end date

Returns:

the list of all event date between startDate and endDate.

getFirstOccurrence

public Optional<CalendarEventOccurrence> getFirstOccurrence(ZonedDateTime date)

Description copied from interface: CalendarEvent

Retrieves the start date of the first Event which end after the date

Specified by:

getFirstOccurrence in interface CalendarEvent

Parameters:

date - the date

Returns:

the start date of the first Event which end after the date

getNextOccurrence

public Optional<CalendarEventOccurrence> getNextOccurrence(CalendarEventOccurrence occurrence)

Description copied from interface: CalendarEvent

Retrieves the date of the next event after the date

Specified by:

getNextOccurrence in interface CalendarEvent

Parameters:

occurrence - the current occurrence

Returns:

the occurrence of the next event after the date

getOrganiser

public UserIdentity getOrganiser()

Description copied from interface: CalendarEvent

Retrieves the organiser.

Specified by:

getOrganiser in interface CalendarEvent

Returns:

the organiser.

getResources

public List<String> getResources()

Description copied from interface: CalendarEvent

Retrieves the resource list.

Specified by:

getResources in interface CalendarEvent

Returns:

the resource list.

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 String dataPath,
 DataContext context)
               throws SAXException,
BadItemTypeException,
UndefinedItemPathException

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

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

dataToJSON

public Object dataToJSON(String dataPath,
 DataContext context)
                  throws BadItemTypeException,
UndefinedItemPathException

Description copied from interface: DataHolder

Convert the data at the given path into a JSON object

Specified by:

dataToJSON in interface DataHolder

Parameters:

dataPath - the path of the data to convert

context - The context of the data to convert

Returns:

The value as JSON

Throws:

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

getRepositoryData

public 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

indexData

public List<org.apache.solr.common.SolrInputDocument> indexData(org.apache.solr.common.SolrInputDocument document,
 CMSDataContext context)
                                                         throws BadItemTypeException

Description copied from interface: IndexableAmetysObject

Indexes all data and properties of this AmetysObject

Specified by:

indexData in interface IndexableAmetysObject

Parameters:

document - the solr document representing this AmetysObject

context - The context of the data to index

Returns:

additional solr documents that may have been created (ex: repeater entries)

Throws:

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

getModel

public Collection<? extends Model> getModel()

Description copied from interface: ModelAwareDataHolder

Retrieves the data holder's model

Specified by:

getModel in interface ModelAwareAmetysObject

Specified by:

getModel in interface ModelAwareDataHolder

Returns:

the data holder's model

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

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. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

hasLocalValue

public boolean hasLocalValue(String dataPath)
                      throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasLocalValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a non empty local value for the data and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasExternalValue

public boolean hasExternalValue(String dataPath)
                         throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasExternalValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a non empty external value for the data and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasValue

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

Description copied from interface: DataHolder

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

Specified by:

hasValue in interface DataHolder

Specified by:

hasValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

true if there is a non empty value for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. 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 data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

hasValueOrEmpty

public boolean hasValueOrEmpty(String dataPath)
                        throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

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. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

hasLocalValueOrEmpty

public boolean hasLocalValueOrEmpty(String dataPath)
                             throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasLocalValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a local value for the data, even empty, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasExternalValueOrEmpty

public boolean hasExternalValueOrEmpty(String dataPath)
                                throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Checks if there is an external value for the data at the given path

Specified by:

hasExternalValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is an external value for the data, even empty, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

getDataNames

public 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

Specified by:

getDataNames in interface ModelAwareDataHolder

Returns:

the names of all data contained by this data holder

getValue

public <T> T getValue(String dataPath)
               throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface DataHolder

Type Parameters:

T - type of the value to retrieve. If the data holder has a model, the type of the value is defined by this model. Otherwise, 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

Parameters:

dataPath - path of the data

Returns:

the value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the data holder has a model and the type defined by the model doesn't match the type of the stored value, or if value at the sub data path of the given one is not a composite

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

getLocalValue

public <T> T getLocalValue(String dataPath)
                    throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local value of the data at the given path

Specified by:

getLocalValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve. The type of the value is defined by the model.

Parameters:

dataPath - path of the externalizable data

Returns:

the local value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

UndefinedItemPathException - if the given data 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

getExternalValue

public <T> T getExternalValue(String dataPath)
                       throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external value of the data at the given path

Specified by:

getExternalValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve. The type of the value is defined by the model.

Parameters:

dataPath - path of the externalizable data

Returns:

the external value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

UndefinedItemPathException - if the given data 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

getValueOrDefault

public <T> T getValueOrDefault(String dataPath)
                        throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

getValueOrDefault in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve. The type of the value is defined by the model.

Parameters:

dataPath - path of the data

Returns:

the value of the data, or the default value from the model if the value does not exist or is empty

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

UndefinedItemPathException - if the given data 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

getValueOrDefault

public <T> T getValueOrDefault(String dataPath,
 T defaultValue)
                        throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

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

Specified by:

getValueOrDefault in interface DataHolder

Type Parameters:

T - type of the value to retrieve. If the data holder has a model, the type of the value is defined by this model. Otherwise, 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

Parameters:

dataPath - path of the data

defaultValue - default value

Returns:

the value of the data, or the given default value if the value does not exist or is empty

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if value at the sub data path of the given one is not a composite

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

getValueOfType

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

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValueOfType in interface DataHolder

Specified by:

getValueOfType in interface ModelAwareDataHolder

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. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given type doesn't match the type of the stored value at the given path

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

getValueOfTypeOrDefault

public <T> T getValueOfTypeOrDefault(String dataPath,
 String dataTypeId,
 T defaultValue)
                              throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

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

Specified by:

getValueOfTypeOrDefault in interface DataHolder

Specified by:

getValueOfTypeOrDefault in interface ModelAwareDataHolder

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, or the given default value if the value does not exist or is empty

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given type doesn't match the type of the stored value at the given path

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

getValueWithMultiValuedPathSegments

public <T> T getValueWithMultiValuedPathSegments(String dataPath)
                                          throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, allowing multi-valued segments in the path (not necessarily at the last segment) if there is no indicated entry for a repeater, the values of all the entries are retrieved if there are multiple values, all data are retrieved in one array

Specified by:

getValueWithMultiValuedPathSegments in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

Returns:

the value of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

UndefinedItemPathException - if the given data path is not defined by the model

BadDataPathCardinalityException - if the managesMultiples boolean is false and the definition of a part of the data path is multiple. Only the last part can be multiple

getStatus

public ExternalizableDataProvider.ExternalizableDataStatus getStatus(String dataPath)
                                                              throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable. But there is no sense to call it with a non externalizable data

Specified by:

getStatus in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

the status of the externalizable data at the given path

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given data path is composed of an item with type defined by the model that doesn't match the type of the stored value

UndefinedItemPathException - if the given data 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

isMultiple

public boolean isMultiple(String dataPath)
                   throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: DataHolder

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

Specified by:

isMultiple in interface DataHolder

Specified by:

isMultiple in interface ModelAwareDataHolder

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

isMultiple

public boolean isMultiple(String dataPath,
 String dataTypeId)
                   throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: DataHolder

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

Specified by:

isMultiple in interface DataHolder

Specified by:

isMultiple in interface ModelAwareDataHolder

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

getType

public <X extends ModelItemType> X getType(String dataPath)
                                    throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: DataHolder

Retrieves the type of the data at the given path

Specified by:

getType in interface DataHolder

Specified by:

getType in interface ModelAwareDataHolder

Type Parameters:

X - type of the item type

Parameters:

dataPath - path of the data

Returns:

the type of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

copyTo

public void copyTo(ModifiableDataHolder dataHolder)
            throws BadItemTypeException,
UndefinedItemPathException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

Throws:

BadItemTypeException - if type of a data to copy doesn't match the data with same path in the destination ModifiableDataHolder

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

copyTo

public void copyTo(ModifiableDataHolder dataHolder,
 DataContext context)
            throws BadItemTypeException,
UndefinedItemPathException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

context - The context of the data to copy

Throws:

BadItemTypeException - if type of a data to copy doesn't match the data with same path in the destination ModifiableDataHolder

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
               throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Generates SAX events for the data in the given view in the current DataHolder

Specified by:

dataToSAX in interface ModelAwareDataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

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

dataToSAXForEdition

public void dataToSAXForEdition(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
                         throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Generates SAX events for the data in the given view in edition mode in the current DataHolder

Specified by:

dataToSAXForEdition in interface ModelAwareDataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

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

dataToJSON

public Map<String,Object> dataToJSON(ViewItemAccessor viewItemAccessor,
 DataContext context)
                              throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Convert the data in the given view of the current DataHolder

Specified by:

dataToJSON in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

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

dataToJSONForEdition

public Map<String,Object> dataToJSONForEdition(ViewItemAccessor viewItemAccessor,
 DataContext context)
                                        throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Convert the data in the given view in edition mode in the current DataHolder

Specified by:

dataToJSONForEdition in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

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

dataToMap

public Map<String,Object> dataToMap(ViewItemAccessor viewItemAccessor,
 DataContext context)
                             throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Retrieves data of this DataHolder as a typed-values Map.

Specified by:

dataToMap in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to include in the resulting Map

context - The context of the data

Returns:

a Map containing all data.

Throws:

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

hasDifferences

public boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values)
                       throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

Returns:

true if there are differences, false otherwise

Throws:

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

hasDifferences

public boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 SynchronizationContext context)
                       throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

getDifferences

public Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values)
                                     throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Get the collection of model items where there are differences between the given values and the current ones

Specified by:

getDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

Returns:

a collection of model items with differences

Throws:

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

getDifferences

public Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 SynchronizationContext context)
                                     throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Get the collection of model items where there are differences between the given values and the current ones

Specified by:

getDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

BadItemTypeException - if the type defined by the model of one of the Map's key doesn't match the corresponding value

getComposite

public IndexableComposite getComposite(String compositePath)
                                throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface IndexableDataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and the definition of a part of the data path is multiple. Only the last part can be multiple

getLocalComposite

public IndexableComposite getLocalComposite(String compositePath)
                                     throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface IndexableDataHolder

Specified by:

getLocalComposite in interface ModelAwareDataHolder

Parameters:

compositePath - path of the externalizable 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

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

getExternalComposite

public IndexableComposite getExternalComposite(String compositePath)
                                        throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface IndexableDataHolder

Specified by:

getExternalComposite in interface ModelAwareDataHolder

Parameters:

compositePath - path of the externalizable 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

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

getRepeater

public IndexableRepeater getRepeater(String repeaterPath)
                              throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface IndexableDataHolder

Specified by:

getRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

getLocalRepeater

public IndexableRepeater getLocalRepeater(String repeaterPath)
                                   throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface IndexableDataHolder

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

getExternalRepeater

public IndexableRepeater getExternalRepeater(String repeaterPath)
                                      throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface IndexableDataHolder

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

getParentDataHolder

public Optional<? extends IndexableDataHolder> 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

Specified by:

getParentDataHolder in interface IndexableDataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

public IndexableDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface IndexableDataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Returns:

the root DataHolder