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, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject

Direct Known Subclasses:

AmetysObjectCollection, Catalog, DefaultAlias, DefaultAmetysObject, DefaultDefinition, DefaultTheme, DefaultTraversableAmetysObject, DefaultZoneItem

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.

Field Summary

Fields

Modifier and Type	Field and Description
private F	_factory The corresponding SimpleAmetysObjectFactory
private String	_name
private Node	_node
private String	_parentPath

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
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() Returns the root CompositeMetadata of this AmetysObject.
String	getName() Retrieves the name of the current object.
Node	getNode() Gives access to the underlying JCR node.
<A extends AmetysObject> A	getParent() Returns the parent object in the Ametys hierarchy.
String	getParentPath() Returns the path of the parent object in the Ametys hierarchy.
String	getPath() Retrieves the path of the current object.
boolean	needsSave() Returns true if there is pending changes.
void	remove() Removes this AmetysObject from the Ametys tree.
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.

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

equals, hashCode, 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

Field Detail

_factory

private F extends SimpleAmetysObjectFactory _factory

The corresponding SimpleAmetysObjectFactory

_node

private Node _node

_name

private String _name

_parentPath

private String _parentPath

Constructor Detail

SimpleAmetysObject

public SimpleAmetysObject(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 DefaultTraversableAmetysObjectFactory which created the AmetysObject

Method Detail

_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

public ModifiableCompositeMetadata getMetadataHolder()

Description copied from interface: MetadataAwareAmetysObject

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