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

Class DefaultIndexableComposite

java.lang.Object

org.ametys.plugins.repository.data.holder.group.impl.DefaultModelAwareComposite

org.ametys.cms.data.holder.group.impl.DefaultIndexableComposite

All Implemented Interfaces:

IndexableComposite, IndexableDataHolder, DataHolder, Composite, ModelAwareComposite, ModelAwareDataHolder

public class DefaultIndexableComposite
extends DefaultModelAwareComposite
implements IndexableComposite

Class for indexable model aware composites

Field Summary

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

_defaultDataHolder, _definition, _repositoryData

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefaultIndexableComposite(RepositoryData repositoryData, ModelItemGroup definition, IndexableDataHolder parent, IndexableDataHolder root)	Creates a default indexable composite

Method Summary

Modifier and Type	Method	Description
IndexableDataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
IndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
IndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
IndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path

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

getRepositoryData

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.group.Composite

dataToSAX, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

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

copyTo, copyTo, dataToJSON, dataToSAX, getRepositoryData

Methods inherited from interface org.ametys.cms.data.holder.group.IndexableComposite

getComposite, getExternalComposite, getLocalComposite, getParentDataHolder, getRootDataHolder

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModelAwareComposite

dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, 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

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

dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX

Constructor Details

DefaultIndexableComposite

public DefaultIndexableComposite(RepositoryData repositoryData,
 ModelItemGroup definition,
 IndexableDataHolder parent,
 IndexableDataHolder root)

Creates a default indexable composite

Parameters:

repositoryData - the repository data of the composite

definition - the definition of the composite

parent - the parent of the created Composite

root - the root IndexableDataHolder

Method Details

getDefaultDataHolder

public IndexableDataHolder getDefaultDataHolder()

Description copied from interface: Composite

Retrieves the default implementation of a DataHolder to use

Specified by:

getDefaultDataHolder in interface Composite

Specified by:

getDefaultDataHolder in interface IndexableComposite

Specified by:

getDefaultDataHolder in interface ModelAwareComposite

Overrides:

getDefaultDataHolder in class DefaultModelAwareComposite

Returns:

the DataHolder

getRepeater

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

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface IndexableComposite

Specified by:

getRepeater in interface IndexableDataHolder

Specified by:

getRepeater in interface ModelAwareComposite

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

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

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

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

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface IndexableComposite

Specified by:

getLocalRepeater in interface IndexableDataHolder

Specified by:

getLocalRepeater in interface ModelAwareComposite

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

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

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

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

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface IndexableComposite

Specified by:

getExternalRepeater in interface IndexableDataHolder

Specified by:

getExternalRepeater in interface ModelAwareComposite

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

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

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

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