Package org.ametys.plugins.repository.jcr

Class SimpleAmetysObject<F extends SimpleAmetysObjectFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

AmetysObject, DataHolder, ModifiableDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject

Direct Known Subclasses:

Activity, AmetysObjectCollection, CacheContentVersionChunk, DefaultAlias, DefaultDefinition, DefaultTheme, DefaultTheme, DefaultTraversableAmetysObject, DefaultZoneItem, SimpleModelAwareAmetysObject, Subscription, VersionAmetysObject

public class SimpleAmetysObject<F extends SimpleAmetysObjectFactory>
extends AbstractAmetysObject
implements JCRAmetysObject

Default implementation of an AmetysObject, backed by a JCR node.
This implementation heavily relies on its SimpleAmetysObjectFactory counterpart.

Constructor Summary

Constructors

Constructor	Description
SimpleAmetysObject(javax.jcr.Node node, String parentPath, F factory)	Creates an SimpleAmetysObject.

Method Summary

Modifier and Type	Method	Description
protected F	_getFactory()	Retrieves the factory.
protected void	_invalidateName()	Recompute the name from the Node. To be used when the node name changesd internally.
protected void	_invalidateParentPath()	Invalidates cached parent path.
ModifiableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
protected ModifiableDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
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>
ModifiableCompositeMetadata	getMetadataHolder()	Deprecated. use getRepositoryData instead
String	getName()	Retrieves the name of the current object.
javax.jcr.Node	getNode()	Gives access to the underlying JCR node.
<A extends AmetysObject> A	getParent()	Returns the parent object in the Ametys hierarchy.
Optional<? extends ModifiableDataHolder>	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.
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
boolean	needsSave()	Returns true if there is pending changes.
void	remove()	Removes this AmetysObject from the Ametys tree.
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	rename(String newName)	Rename the AmetysObject
void	revertChanges()	Discard pending changes and revert to the currently persisted version.
void	saveChanges()	Persists pending changes. If the underlying Node is new, the Session is globally saved.
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
void	setValue(String dataPath, Object value, String dataType)	Sets the value of the data at the given path
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Constructor Details

SimpleAmetysObject

public SimpleAmetysObject(javax.jcr.Node node,
 String parentPath,
 F factory)

Creates an SimpleAmetysObject.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the SimpleAmetysObjectFactory which created the AmetysObject

Method Details

_getFactory

protected F _getFactory()

Retrieves the factory.

Returns:

the factory.

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.

getMetadataHolder

@Deprecated
public ModifiableCompositeMetadata getMetadataHolder()

Deprecated.

use getRepositoryData instead

Returns the root CompositeMetadata of this AmetysObject.

Specified by:

getMetadataHolder in interface MetadataAwareAmetysObject

Specified by:

getMetadataHolder in interface ModifiableMetadataAwareAmetysObject

Returns:

the root CompositeMetadata of this AmetysObject

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.

_invalidateParentPath

protected void _invalidateParentPath()

Invalidates cached parent path.

_invalidateName

protected void _invalidateName()

Recompute the name from the Node.
To be used when the node name changesd internally.

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.

getNode

public javax.jcr.Node getNode()

Description copied from interface: JCRAmetysObject

Gives access to the underlying JCR node.

Specified by:

getNode in interface JCRAmetysObject

Returns:

the JCR node backing this AmetysObject.

getId

public String getId()

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

rename

public void rename(String newName)
            throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Rename the AmetysObject

Specified by:

rename in interface ModifiableAmetysObject

Parameters:

newName - the new name of the ametys object

Throws:

AmetysRepositoryException - if an error occurs.

remove

public void remove()
            throws AmetysRepositoryException,
RepositoryIntegrityViolationException

Description copied from interface: RemovableAmetysObject

Removes this AmetysObject from the Ametys tree.

Specified by:

remove in interface RemovableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if this AmetysObject is referenced by another objects.

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.

needsSave

public boolean needsSave()
                  throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Returns true if there is pending changes.

Specified by:

needsSave in interface ModifiableAmetysObject

Returns:

true if there is pending changes.

Throws:

AmetysRepositoryException - if an error occurs.

saveChanges

public void saveChanges()
                 throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Persists pending changes.
If the underlying Node is new, the Session is globally saved.

Specified by:

saveChanges in interface ModifiableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

revertChanges

public void revertChanges()
                   throws AmetysRepositoryException

Description copied from interface: ModifiableAmetysObject

Discard pending changes and revert to the currently persisted version.

Specified by:

revertChanges in interface ModifiableAmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getDataHolder

protected ModifiableDataHolder getDataHolder()

Description copied from class: AbstractAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in class AbstractAmetysObject

Returns:

the DataHolder of this AmetysObject

getComposite

public ModifiableComposite getComposite(String compositePath)
                                 throws IllegalArgumentException,
UnknownTypeException,
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 ModifiableDataHolder

Overrides:

getComposite in class AbstractAmetysObject

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

UnknownTypeException - if the type composite is not available for this data holder

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

getComposite

public ModifiableComposite getComposite(String compositePath,
 boolean createNew)
                                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

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

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UnknownTypeException - if the type composite is not available for this data holder

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

synchronizeValues

public <T extends SynchronizationResult> T synchronizeValues(Map<String,Object> values)
                                                      throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException

Description copied from interface: ModifiableDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

BadItemTypeException - if type of the a data doesn't match the corresponding given value to set

UndefinedItemPathException - if the data holder has a model and a key in the given Map refers to a data that is not defined by the model

setValue

public void setValue(String dataPath,
 Object value)
              throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use ModifiableDataHolder.setValue(String, Object, String) with a null value

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given the data path is composed of an non existing group

UnknownTypeException - if there is no available type compatible with the given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the given value for this data holder's type extension point

BadItemTypeException - if type of the data at the given path doesn't match the given value to set

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the 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

setValue

public void setValue(String dataPath,
 Object value,
 String dataType)
              throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

value - the value to set. Give null to empty the value.

dataType - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given data path is composed of an non existing group

UnknownTypeException - if the given type is not available for this data holder's type extension point

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the 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

removeValue

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

Description copied from interface: ModifiableDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the the data to remove is in a group and there is no available type compatible with this group

BadItemTypeException - if the value of the parent of the given path is not an item container

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the 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

getRepositoryData

public ModifiableRepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Specified by:

getRepositoryData in interface ModifiableDataHolder

Overrides:

getRepositoryData in class AbstractAmetysObject

Returns:

the repository data used by this DataHolder

getParentDataHolder

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

Overrides:

getParentDataHolder in class AbstractAmetysObject

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModifiableDataHolder 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 ModifiableDataHolder

Overrides:

getRootDataHolder in class AbstractAmetysObject

Returns:

the root DataHolder