Package org.ametys.plugins.extraction.edition

Class ExtractionFilesClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.extraction.edition.ExtractionFilesClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class ExtractionFilesClientSideElement
extends StaticClientSideElement

Component for operations on extraction files

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
ExtractionFilesClientSideElement()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	addFolder(String parentRelPath, String name)	Add a new folder
Map<String,Object>	deleteFile(String relPath)	Remove a folder or a file
List<Map<String,Object>>	getDefinitionFiles(String path, String profileId)	Gets parameters files and folders contained in the given path.
List<Map<String,Object>>	getResultFiles(String path)	Gets the result files of extractions
Map<String,Object>	renameFile(String relPath, String name)	Rename a file or a folder
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractionFilesClientSideElement

public ExtractionFilesClientSideElement()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

getDefinitionFiles

public List<Map<String,Object>> getDefinitionFiles(String path,
 String profileId)
                                            throws IOException

Gets parameters files and folders contained in the given path.

Parameters:

path - the relative file's path from parameters files root directory

profileId - The extraction profile used to get the files

Returns:

the list of parameters files and folders

Throws:

IOException - If an error occurred while listing files

getResultFiles

public List<Map<String,Object>> getResultFiles(String path)
                                        throws IOException

Gets the result files of extractions

Parameters:

path - the relative file's path from the results root directory

Returns:

the results files

Throws:

IOException - If an error occurred while listing files

addFolder

public Map<String,Object> addFolder(String parentRelPath,
 String name)
                             throws IOException

Add a new folder

Parameters:

parentRelPath - the relative parent file's path from parameters files root directory

name - The name of folder to create

Returns:

a map containing the name of the created folder, its path and the path of its parent

Throws:

IOException - If an error occurred while creating folder

deleteFile

public Map<String,Object> deleteFile(String relPath)
                              throws IOException

Remove a folder or a file

Parameters:

relPath - the relative file's path from parameters files root directory

Returns:

the result map

Throws:

IOException - If an error occurs while removing the folder

renameFile

public Map<String,Object> renameFile(String relPath,
 String name)
                              throws IOException

Rename a file or a folder

Parameters:

relPath - the relative file's path from parameters files root directory

name - the new name of the file/folder

Returns:

the result map

Throws:

IOException - if an error occurs while renaming the file/folder