org.ametys.cms.data

Class ContentValue

java.lang.Object

org.ametys.cms.data.ContentValue

All Implemented Interfaces:

DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

public class ContentValue
extends Object
implements ModifiableModelAwareDataHolder

Content wrapper used by attributes of type content

See Also:

AbstractContentElementType

Field Summary

Fields

Modifier and Type	Field and Description
private ModifiableContent	_content
private String	_contentId
private AmetysObjectResolver	_resolver
private Session	_session

Constructor Summary

Constructors

Constructor and Description
ContentValue(AmetysObjectResolver resolver, String contentId) Constructor of the content wrapper
ContentValue(AmetysObjectResolver resolver, String contentId, Session session) Constructor of the content wrapper

Method Summary

Modifier and Type	Method and Description
ModifiableModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
ModifiableContent	getContent() Retrieves the content
String	getContentId() Retrieves the content's identifier
Collection<String>	getDataNames() Retrieves the names of data contained by this data holder
ModifiableModelAwareRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath, boolean createNew) Retrieves the repeater at the given path
ModelItemType	getType(String path) 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	getValue(String dataPath, boolean useDefaultFromModel, T defaultValue) Retrieves the value of the data at the given path, or the default value
boolean	hasValue(String dataPath) Checks if there is a value for the data at the given path
boolean	isMultiple(String path) Checks if the definition of the element at the given path is multiple
void	removeValue(String dataPath) Removes the value of the data stored in the repository at the given path
void	setValue(String dataPath, Object value) Sets the value of the data at the given path

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.ModelAwareDataHolder

toSAX, toSAX

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX

Field Detail

_resolver

private AmetysObjectResolver _resolver

_contentId

private String _contentId

_content

private ModifiableContent _content

_session

private Session _session

Constructor Detail

ContentValue

public ContentValue(AmetysObjectResolver resolver,
                    String contentId)

Constructor of the content wrapper

Parameters:

resolver - resolver used to get the content from its identifier

contentId - content identifier

ContentValue

public ContentValue(AmetysObjectResolver resolver,
                    String contentId,
                    Session session)

Constructor of the content wrapper

Parameters:

resolver - resolver used to get the content from its identifier

contentId - content identifier

session - the current session. If null, a new session will be used to retrieve the content

Method Detail

getContentId

public String getContentId()

Retrieves the content's identifier

Returns:

the content's identifier

getContent

public ModifiableContent getContent()
                             throws AmetysRepositoryException,
                                    UnknownAmetysObjectException

Retrieves the content

Returns:

the content

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if no content exists for the identifier

hasValue

public 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

Specified by:

hasValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

getDataNames

public Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder

Specified by:

getDataNames in interface DataHolder

Returns:

the paths of all data contained by this data holder

getValue

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

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

Returns:

the value of the data or null if not exists. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

getValue

public <T> T getValue(String dataPath,
                      boolean useDefaultFromModel,
                      T defaultValue)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, or the default value

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

useDefaultFromModel - true to use the default value from the model, false to use the given default value

defaultValue - default value used if value is null and useDefaultFromModel is false, or if there is no default value on model

Returns:

the value of the data or null if not exists.

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

isMultiple

public boolean isMultiple(String path)
                   throws IllegalArgumentException,
                          UndefinedItemPathException,
                          BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Checks if the definition of the element at the given path is multiple

Specified by:

isMultiple in interface ModelAwareDataHolder

Parameters:

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

Returns:

true if the element is multiple, false otherwise

Throws:

IllegalArgumentException - if the given path is null or empty

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

BadItemTypeException

getType

public ModelItemType getType(String path)
                      throws IllegalArgumentException,
                             UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieves the type of the data at the given path

Specified by:

getType 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 type of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

getComposite

public ModifiableModelAwareComposite getComposite(String compositePath)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  BadItemTypeException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

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

getRepeater

public ModifiableModelAwareRepeater getRepeater(String repeaterPath)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException

Description copied from interface: DataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

getComposite

public ModifiableModelAwareComposite getComposite(String compositePath,
                                                  boolean createNew)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the composite to retrieve

createNew - true to create the composite if it does not exist, false otherwise

Returns:

the composite

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

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

getRepeater

public ModifiableModelAwareRepeater getRepeater(String repeaterPath,
                                                boolean createNew)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

createNew - true to create the repeater if it does not exist, false otherwise

Returns:

the repeater

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

setValue

public void setValue(String dataPath,
                     Object value)
              throws IllegalArgumentException,
                     UndefinedItemPathException,
                     BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

value - the value to set. The type of this value will be given by the model, but if not model is associated to the path, an UnsupportedOperationException is thrown. Use the 3 arguments versions in that case.

Throws:

IllegalArgumentException - if the given data path is null or empty

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

BadItemTypeException - if the type defined by the model doesn't match the given value to set

removeValue

public void removeValue(String dataPath)
                 throws IllegalArgumentException,
                        UndefinedItemPathException,
                        BadItemTypeException

Description copied from interface: ModifiableModelAwareDataHolder

Removes the value of the data stored in the repository at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Specified by:

removeValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

BadItemTypeException