Package org.ametys.plugins.explorer.resources.jcr

Class JCRResourcesCollection<F extends JCRResourcesCollectionFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.plugins.explorer.resources.jcr.JCRResourcesCollection<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

ExplorerNode, ModifiableExplorerNode, ModifiableResourceCollection, ResourceCollection, ACLAmetysObject, AmetysObject, CopiableAmetysObject, DataAwareAmetysObject, ModelLessDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, DataHolder, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder, JCRAmetysObject, JCRTraversableAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TrashableAmetysObject, TraversableAmetysObject

Direct Known Subclasses:

Folder

public class JCRResourcesCollection<F extends JCRResourcesCollectionFactory>
extends DefaultTraversableAmetysObject<F>
implements ModifiableResourceCollection, CopiableAmetysObject, ModifiableModelLessDataAwareAmetysObject, TrashableAmetysObject

ExplorerNode representing a collection of resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ID	application id for resources collections.
protected static final String	DATA_DESCRIPTION	Constants for description metadata

Constructor Summary

Constructors

Constructor	Description
JCRResourcesCollection(javax.jcr.Node node, String parentPath, F factory)	Constructor

Method Summary

Modifier and Type	Method	Description
AmetysObject	copyTo(ModifiableTraversableAmetysObject parent, String name)	Copy the current AmetysObject to the given object.
AmetysObject	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo)	Copy the current AmetysObject to the given object if it is not in the restriction list.
String	getApplicationId()	Returns the application id corresponding to this Node.
String	getCollectionType()	Get the type of child collection
ModifiableModelLessDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
String	getDescription()	Get the description of the application
String	getExplorerPath()	Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository). If this collection is the root explorer node, "" is returned.
String	getIconCls()	Returns the icon css class for this Node.
String	getResourcePath()	Returns the path of this resource collection in its hierarchy (which is a subset of the whole repository). If this collection is the root collection, "" is returned.
String	getResourceType()	Get the type of child resources
boolean	hasChildExplorerNodes()	Returns true if this explorer node contains child explorer nodes.
boolean	hasChildResources()	Returns true if this explorer node contains resources.
TrashElement	moveToTrash()	Move this AmetysObject to the trash.
JCRResourcesCollection	restoreFromTrash()	Restore this AmetysObject from the trash.
void	setDescription(String description)	Set the description of the application

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, createChild, disallowInheritance, getChild, getChildren, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, hasChild, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

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, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelLessDataAwareAmetysObject

dataToJSON, dataToSAX, getModelItemTypeExtensionPoint, getType, getValue, getValue, getValueOfType, getValueOfType, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

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

dataToJSON, dataToSAX, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelLessDataAwareAmetysObject

getComposite, getComposite, getParentDataHolder, getRepositoryData, getRootDataHolder, removeValue, setValue, setValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.ModifiableTraversableAmetysObject

createChild

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChild, getChildAt, getChildPosition, getChildren, hasChild

Field Details

APPLICATION_ID

public static final String APPLICATION_ID

application id for resources collections.

See Also:

• Constant Field Values

DATA_DESCRIPTION

protected static final String DATA_DESCRIPTION

Constants for description metadata

See Also:

• Constant Field Values

Constructor Details

JCRResourcesCollection

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

Constructor

Parameters:

node - The jcr node

parentPath - The parent path

factory - The factory

Method Details

getIconCls

public String getIconCls()

Description copied from interface: ExplorerNode

Returns the icon css class for this Node.

Specified by:

getIconCls in interface ExplorerNode

Returns:

the icon css class for this Node for rendering in the tree.

getApplicationId

public String getApplicationId()

Description copied from interface: ExplorerNode

Returns the application id corresponding to this Node.

Specified by:

getApplicationId in interface ExplorerNode

Returns:

the application id corresponding to this Node.

getCollectionType

public String getCollectionType()

Description copied from interface: ModifiableResourceCollection

Get the type of child collection

Specified by:

getCollectionType in interface ModifiableResourceCollection

Returns:

the type of child collection

getResourceType

public String getResourceType()

Description copied from interface: ModifiableResourceCollection

Get the type of child resources

Specified by:

getResourceType in interface ModifiableResourceCollection

Returns:

the type of child resources

getResourcePath

public String getResourcePath()
                       throws AmetysRepositoryException

Description copied from interface: ResourceCollection

Returns the path of this resource collection in its hierarchy (which is a subset of the whole repository).
If this collection is the root collection, "" is returned.

Specified by:

getResourcePath in interface ResourceCollection

Returns:

the path of this collection in its hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

getExplorerPath

public String getExplorerPath()

Description copied from interface: ExplorerNode

Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository).
If this collection is the root explorer node, "" is returned.

Specified by:

getExplorerPath in interface ExplorerNode

Returns:

the path of this node in its hierarchy.

hasChildResources

public boolean hasChildResources()
                          throws AmetysRepositoryException

Description copied from interface: ResourceCollection

Returns true if this explorer node contains resources.

Specified by:

hasChildResources in interface ResourceCollection

Returns:

true if this explorer node contains resources.

Throws:

AmetysRepositoryException - if an error occurs.

hasChildExplorerNodes

public boolean hasChildExplorerNodes()
                              throws AmetysRepositoryException

Description copied from interface: ExplorerNode

Returns true if this explorer node contains child explorer nodes.

Specified by:

hasChildExplorerNodes in interface ExplorerNode

Returns:

true if this explorer node contains child explorer nodes.

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public AmetysObject copyTo(ModifiableTraversableAmetysObject parent,
 String name)
                    throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

public AmetysObject copyTo(ModifiableTraversableAmetysObject parent,
 String name,
 List<String> restrictTo)
                    throws AmetysRepositoryException

Description copied from interface: CopiableAmetysObject

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Specified by:

copyTo in interface CopiableAmetysObject

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

getDescription

public String getDescription()

Description copied from interface: ExplorerNode

Get the description of the application

Specified by:

getDescription in interface ExplorerNode

Returns:

the description

setDescription

public void setDescription(String description)

Description copied from interface: ModifiableExplorerNode

Set the description of the application

Specified by:

setDescription in interface ModifiableExplorerNode

Parameters:

description - the description

getDataHolder

public ModifiableModelLessDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelLessDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelLessDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

moveToTrash

public TrashElement moveToTrash()

Description copied from interface: TrashableAmetysObject

Move this AmetysObject to the trash.

Specified by:

moveToTrash in interface TrashableAmetysObject

Returns:

the created trash element that represents the object in the trash

restoreFromTrash

public JCRResourcesCollection restoreFromTrash()
                                        throws UnknownParentException

Description copied from interface: TrashableAmetysObject

Restore this AmetysObject from the trash.

Specified by:

restoreFromTrash in interface TrashableAmetysObject

Returns:

the restored ametys object

Throws:

UnknownParentException - if it's not possible to determine a location to restore the object