org.ametys.plugins.repository.metadata.jcr

Class JCRFolder

java.lang.Object

org.ametys.plugins.repository.metadata.jcr.JCRFolder

All Implemented Interfaces:

Folder, ModifiableFolder

public class JCRFolder
extends Object
implements ModifiableFolder

Java binding of a nt:folder JCR Node.

Text.escapeIllegalJcrChars(String) is used for escaping invalid JCR characters or character sequences.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_lockAlreadyChecked
private Node	_node

Constructor Summary

Constructors

Constructor and Description
JCRFolder(Node node) Constructor

Method Summary

Modifier and Type	Method and Description
private void	_checkLock()
ModifiableFile	addFile(String fileName) Add a file with the specified name in this folder.
ModifiableFolder	addFolder(String folderName) Add a folder with the specified name in this folder.
ModifiableFile	getFile(String fileName) Returns the file with the specified name.
Collection<ModifiableFile>	getFiles() Returns a Collection containing all files of this folder.
ModifiableFolder	getFolder(String folderName) Returns the folder with the specified name.
Collection<ModifiableFolder>	getFolders() Returns a Collection containing all subfolders of this folder.
String	getName() Returns the folder name.
Node	getNode() Retrieves the underlying node.
boolean	hasFile(String fileName) Tests the existence of a file.
void	remove(String name) Removes the sub-element represented by the specified name.
void	removeAll() Removes all files and folders in this folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_node

private Node _node

_lockAlreadyChecked

private boolean _lockAlreadyChecked

Constructor Detail

JCRFolder

public JCRFolder(Node node)

Constructor

Parameters:

node - the nt:folder Node

Method Detail

getNode

public Node getNode()

Retrieves the underlying node.

Returns:

the underlying node.

getName

public String getName()
               throws AmetysRepositoryException

Description copied from interface: Folder

Returns the folder name.

Specified by:

getName in interface Folder

Returns:

the folder name.

Throws:

AmetysRepositoryException - if an error occurs.

getFolders

public Collection<ModifiableFolder> getFolders()

Description copied from interface: Folder

Returns a Collection containing all subfolders of this folder.

Specified by:

getFolders in interface Folder

Specified by:

getFolders in interface ModifiableFolder

Returns:

a Collection containing all subfolders of this folder.

getFolder

public ModifiableFolder getFolder(String folderName)

Description copied from interface: Folder

Returns the folder with the specified name.

Specified by:

getFolder in interface Folder

Specified by:

getFolder in interface ModifiableFolder

Parameters:

folderName - the name of the folder.

Returns:

the folder with the specified name.

addFolder

public ModifiableFolder addFolder(String folderName)

Description copied from interface: ModifiableFolder

Add a folder with the specified name in this folder.

Specified by:

addFolder in interface ModifiableFolder

Parameters:

folderName - the folder name.

Returns:

the created folder.

getFiles

public Collection<ModifiableFile> getFiles()

Description copied from interface: Folder

Returns a Collection containing all files of this folder.

Specified by:

getFiles in interface Folder

Specified by:

getFiles in interface ModifiableFolder

Returns:

a Collection containing all files of this folder.

hasFile

public boolean hasFile(String fileName)
                throws AmetysRepositoryException

Description copied from interface: Folder

Tests the existence of a file.

Specified by:

hasFile in interface Folder

Parameters:

fileName - the name of the file.

Returns:

true if the specified file exists in this folder.

Throws:

AmetysRepositoryException - if an error occurs.

getFile

public ModifiableFile getFile(String fileName)

Description copied from interface: Folder

Returns the file with the specified name.

Specified by:

getFile in interface Folder

Specified by:

getFile in interface ModifiableFolder

Parameters:

fileName - the name of the file.

Returns:

the file with the specified name.

addFile

public ModifiableFile addFile(String fileName)

Description copied from interface: ModifiableFolder

Add a file with the specified name in this folder.

Specified by:

addFile in interface ModifiableFolder

Parameters:

fileName - the file name.

Returns:

the created file.

remove

public void remove(String name)
            throws AmetysRepositoryException

Description copied from interface: ModifiableFolder

Removes the sub-element represented by the specified name.

Specified by:

remove in interface ModifiableFolder

Parameters:

name - the name of the folder or file to be removed.

Throws:

UnknownMetadataException - if no folder nor file does exists.

AmetysRepositoryException - if an error occurs.

removeAll

public void removeAll()
               throws AmetysRepositoryException

Description copied from interface: ModifiableFolder

Removes all files and folders in this folder.

Specified by:

removeAll in interface ModifiableFolder

Throws:

AmetysRepositoryException - if an error occurs.

_checkLock

private void _checkLock()
                 throws RepositoryException

Throws:

RepositoryException