Package org.ametys.cms.data.holder.impl

Class DefaultIndexableDataHolder

java.lang.Object

org.ametys.plugins.repository.data.holder.impl.DefaultModelAwareDataHolder

org.ametys.cms.data.holder.impl.DefaultIndexableDataHolder

All Implemented Interfaces:

IndexableDataHolder, DataHolder, ModelAwareDataHolder

public class DefaultIndexableDataHolder
extends DefaultModelAwareDataHolder
implements IndexableDataHolder

Default implementation for indexable data holder. Extends the repository-level DefaultModelAwareDataHolder and adds indexable-specific behaviour such as Property and system property support.

Field Summary

Fields inherited from class org.ametys.plugins.repository.data.holder.impl.DefaultModelAwareDataHolder

_itemContainers, _parent, _repositoryData, _root

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefaultIndexableDataHolder(RepositoryData repositoryData, Collection<? extends ModelItemContainer> itemContainers, Optional<? extends IndexableDataHolder> parent, Optional<? extends IndexableDataHolder> root)	Creates a default indexable data holder
DefaultIndexableDataHolder(RepositoryData repositoryData, ModelItemContainer itemContainer)	Creates a default indexable data holder
DefaultIndexableDataHolder(RepositoryData repositoryData, ModelItemContainer itemContainer, Optional<? extends IndexableDataHolder> parent, Optional<? extends IndexableDataHolder> root)	Creates a default indexable data holder

Method Summary

Modifier and Type	Method	Description
protected void	checkDefinition(String dataPath, boolean checkStatusAvailable, String errorMsg)	Check definition for data path
protected IndexableComposite	createCompositeInstance(RepositoryData compositeRepositoryData, CompositeDefinition compositeDefinition)	Creates an instance of composite
protected IndexableRepeater	createRepeaterInstance(RepositoryData repeaterRepositoryData, RepeaterDefinition repeaterDefinition)	Creates an instance of repeater
protected Object	dataToJSON(ModelItem modelItem, String dataPath, DataContext context)	Converts the value of the given model item at the given data path to a JSON-serializable object
protected void	dataToSAX(ContentHandler contentHandler, ModelItem modelItem, String dataPath, DataContext context)	Generates SAX events for the given model item at the given data path
IndexableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
protected Class	getCompositeClass()	Retrieves the class of the managed composites
ModelItem	getDefinition(String path)	Retrieves the definition of the data at the given path
protected <T> T	getElementValue(ElementDefinition definition, String dataName)	Retrieves the value of the given element definition
IndexableComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
IndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
IndexableComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
IndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
Optional<? extends IndexableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
IndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
protected Class	getRepeaterClass()	Retrieves the class of the managed repeaters
protected Class	getRepeaterEntryClass()	Retrieves the class of the managed repeater entries
IndexableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
protected boolean	hasValueForName(String dataName, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)	Checks if there is a non-empty value for the given simple data name (no path separator) with the given externalizable status
protected boolean	hasValueOrEmptyForName(String dataName, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)	Checks if there is a value (possibly empty) for the given simple data name (no path separator) with the given externalizable status

Methods inherited from class org.ametys.plugins.repository.data.holder.impl.DefaultModelAwareDataHolder

checkDefinition, checkElementDifferences, checkElementDifferencesInRemoveMode, checkStatusDifferences, createSynchronizationContextInstance, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, doesHaveDifferences, doGetDifferences, ensureNonNullItemContainers, getComposite, getCompositeFromValue, getDataNames, getDifferences, getDifferences, getDifferencesInGroup, getExternalValue, getFinalDataName, getGroupValue, getLocalValue, getManagedClass, getModel, getMultipleValues, getRepeater, getRepeaterFromValue, getRepositoryData, getStatus, getValue, getValue, getValueOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefaultValue, hasDifferences, hasDifferences, hasDifferencesInElement, hasDifferencesInGroup, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValue, hasValueOrEmpty, hasValueOrEmpty

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.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

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

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

Constructor Details

DefaultIndexableDataHolder

public DefaultIndexableDataHolder(RepositoryData repositoryData,
 ModelItemContainer itemContainer)

Creates a default indexable data holder

Parameters:

repositoryData - the repository data to use

itemContainer - the model container to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

DefaultIndexableDataHolder

public DefaultIndexableDataHolder(RepositoryData repositoryData,
 ModelItemContainer itemContainer,
 Optional<? extends IndexableDataHolder> parent,
 Optional<? extends IndexableDataHolder> root)

Creates a default indexable data holder

Parameters:

repositoryData - the repository data to use

itemContainer - the model container to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

parent - the optional parent of the created DataHolder, empty if the created DataHolder is the root DataHolder

root - the root IndexableDataHolder

DefaultIndexableDataHolder

public DefaultIndexableDataHolder(RepositoryData repositoryData,
 Collection<? extends ModelItemContainer> itemContainers,
 Optional<? extends IndexableDataHolder> parent,
 Optional<? extends IndexableDataHolder> root)

Creates a default indexable data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

parent - the optional parent of the created DataHolder, empty if the created DataHolder is the root DataHolder

root - the root IndexableDataHolder

Method Details

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

Overrides:

getComposite in class DefaultModelAwareDataHolder

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

Overrides:

getLocalComposite in class DefaultModelAwareDataHolder

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

Overrides:

getExternalComposite in class DefaultModelAwareDataHolder

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

Overrides:

getRepeater in class DefaultModelAwareDataHolder

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

Overrides:

getLocalRepeater in class DefaultModelAwareDataHolder

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

Overrides:

getExternalRepeater in class DefaultModelAwareDataHolder

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

hasValueForName

protected boolean hasValueForName(String dataName,
 Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)

Description copied from class: DefaultModelAwareDataHolder

Checks if there is a non-empty value for the given simple data name (no path separator) with the given externalizable status

Overrides:

hasValueForName in class DefaultModelAwareDataHolder

Parameters:

dataName - the name of the data (no path separator)

status - the optional externalizable status to filter on, or empty to check the current value

Returns:

true if there is a non-empty value for the given name, false otherwise

hasValueOrEmptyForName

protected boolean hasValueOrEmptyForName(String dataName,
 Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)

Description copied from class: DefaultModelAwareDataHolder

Checks if there is a value (possibly empty) for the given simple data name (no path separator) with the given externalizable status

Overrides:

hasValueOrEmptyForName in class DefaultModelAwareDataHolder

Parameters:

dataName - the name of the data (no path separator)

status - the optional externalizable status to filter on, or empty to check the current value

Returns:

true if there is a value for the given name (even empty), false otherwise

getElementValue

protected <T> T getElementValue(ElementDefinition definition,
 String dataName)

Description copied from class: DefaultModelAwareDataHolder

Retrieves the value of the given element definition

Overrides:

getElementValue in class DefaultModelAwareDataHolder

Type Parameters:

T - the expected type of the value

Parameters:

definition - the definition of the element

dataName - the final name (possibly altered with a status suffix) to use to read the repository data

Returns:

the value read from the repository, possibly coerced from single to multiple or vice versa

createCompositeInstance

protected IndexableComposite createCompositeInstance(RepositoryData compositeRepositoryData,
 CompositeDefinition compositeDefinition)

Description copied from class: DefaultModelAwareDataHolder

Creates an instance of composite

Overrides:

createCompositeInstance in class DefaultModelAwareDataHolder

Parameters:

compositeRepositoryData - the repository data of the composite to create

compositeDefinition - the definition of the composite to create

Returns:

the created composite instance

createRepeaterInstance

protected IndexableRepeater createRepeaterInstance(RepositoryData repeaterRepositoryData,
 RepeaterDefinition repeaterDefinition)

Description copied from class: DefaultModelAwareDataHolder

Creates an instance of repeater

Overrides:

createRepeaterInstance in class DefaultModelAwareDataHolder

Parameters:

repeaterRepositoryData - the repository data of the repeater to create

repeaterDefinition - the definition of the repeater to create

Returns:

the created repeater instance

getCompositeClass

protected Class getCompositeClass()

Description copied from class: DefaultModelAwareDataHolder

Retrieves the class of the managed composites

Overrides:

getCompositeClass in class DefaultModelAwareDataHolder

Returns:

the class of the managed composites

getRepeaterClass

protected Class getRepeaterClass()

Description copied from class: DefaultModelAwareDataHolder

Retrieves the class of the managed repeaters

Overrides:

getRepeaterClass in class DefaultModelAwareDataHolder

Returns:

the class of the managed repeaters

getRepeaterEntryClass

protected Class getRepeaterEntryClass()

Description copied from class: DefaultModelAwareDataHolder

Retrieves the class of the managed repeater entries

Overrides:

getRepeaterEntryClass in class DefaultModelAwareDataHolder

Returns:

the class of the managed repeater entries

getDefinition

public ModelItem getDefinition(String path)
                        throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieves the definition of the data at the given path

Specified by:

getDefinition in interface ModelAwareDataHolder

Parameters:

path - path of the data. No matter if it is a definition or data path (with repeater entry positions)

Returns:

the definition of the data

Throws:

IllegalArgumentException - if the given path is null or empty

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

dataToSAX

protected void dataToSAX(ContentHandler contentHandler,
 ModelItem modelItem,
 String dataPath,
 DataContext context)
                  throws SAXException,
BadItemTypeException

Description copied from class: DefaultModelAwareDataHolder

Generates SAX events for the given model item at the given data path

Overrides:

dataToSAX in class DefaultModelAwareDataHolder

Parameters:

contentHandler - the content handler to use to generate SAX events

modelItem - the model item describing the data

dataPath - the path of the data

context - the context of the data

Throws:

SAXException - if an error occurs while generating SAX events

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

dataToJSON

protected Object dataToJSON(ModelItem modelItem,
 String dataPath,
 DataContext context)
                     throws BadItemTypeException

Description copied from class: DefaultModelAwareDataHolder

Converts the value of the given model item at the given data path to a JSON-serializable object

Overrides:

dataToJSON in class DefaultModelAwareDataHolder

Parameters:

modelItem - the model item describing the data

dataPath - the path of the data

context - the context of the data

Returns:

the JSON-serializable representation of the value, or null if there is no value

Throws:

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

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

Overrides:

getParentDataHolder in class DefaultModelAwareDataHolder

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

Overrides:

getRootDataHolder in class DefaultModelAwareDataHolder

Returns:

the root DataHolder

checkDefinition

protected void checkDefinition(String dataPath,
 boolean checkStatusAvailable,
 String errorMsg)

Description copied from class: DefaultModelAwareDataHolder

Check definition for data path

Overrides:

checkDefinition in class DefaultModelAwareDataHolder

Parameters:

dataPath - the data path

checkStatusAvailable - true to check if the definition supports externalizable data status

errorMsg - the error message to throw