Package org.ametys.plugins.extraction.edition

Class EditExtractionClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.extraction.edition.EditExtractionClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class EditExtractionClientSideElement
extends StaticClientSideElement

This client site element manages a button to create an extraction definition file

Nested Class Summary

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

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
private ContentDAO	_contentDAO
private ContentWorkflowHelper	_contentWorkflowHelper
private I18nUtils	_i18nUtils
private SourceResolver	_sourceResolver
static String	ROLE	The Avalon role name

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

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

Constructor Summary

Constructors

Constructor	Description
EditExtractionClientSideElement()

Method Summary

Modifier and Type	Method	Description
private void	_copyDefinitionFileAndInsertDescription(File definitionFile, OutputStream os, String descriptionId)
private void	_deleteTemporaryFile(String definitionFileName, Path temporaryFilePath)
private Stream<Element>	_getDescriptionsElements(Element extractionRoot)
private String	_getExtractionNameFromFileName(String fileName)
private Document	_parseDefinitionFile(File definitionFile)
Map<String,Object>	addDescription(String definitionFileName, String descriptionId)	Adds a description to an extraction.
Map<String,Object>	createExtraction(String definitionFileName, String language)	Creates an extraction definition file.
boolean	deleteExtraction(String definitionFileName)	Deletes an extraction definition file.
Map<String,Object>	renameExtraction(String definitionOldFileName, String definitionNewFileName)	Renames an extraction definition file.
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

Field Detail

ROLE

public static final String ROLE

The Avalon role name

_sourceResolver

private SourceResolver _sourceResolver

_contentWorkflowHelper

private ContentWorkflowHelper _contentWorkflowHelper

_i18nUtils

private I18nUtils _i18nUtils

_contentDAO

private ContentDAO _contentDAO

Constructor Detail

EditExtractionClientSideElement

public EditExtractionClientSideElement()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

createExtraction

public Map<String,Object> createExtraction(String definitionFileName,
                                                 String language)
                                          throws Exception

Creates an extraction definition file.

Parameters:

definitionFileName - The extraction definition name

language - the language used to create the description

Returns:

Map containing success boolean and error codes if one occurs

Throws:

Exception - if an error occurs

_getExtractionNameFromFileName

private String _getExtractionNameFromFileName(String fileName)

addDescription

public Map<String,Object> addDescription(String definitionFileName,
                                               String descriptionId)
                                        throws IllegalArgumentException,
                                               Exception

Adds a description to an extraction.

Parameters:

definitionFileName - The extraction definition file name

descriptionId - the identifier of the description

Returns:

true if extraction saving succeed, false otherwise

Throws:

IllegalArgumentException - if the definition file doesn't exist

Exception - if an error occurs

_copyDefinitionFileAndInsertDescription

private void _copyDefinitionFileAndInsertDescription(File definitionFile,
                                                     OutputStream os,
                                                     String descriptionId)
                                              throws Exception

Throws:

Exception

_deleteTemporaryFile

private void _deleteTemporaryFile(String definitionFileName,
                                  Path temporaryFilePath)

renameExtraction

public Map<String,Object> renameExtraction(String definitionOldFileName,
                                                 String definitionNewFileName)
                                          throws Exception

Renames an extraction definition file.

Parameters:

definitionOldFileName - The extraction definition old file name

definitionNewFileName - The extraction definition new file name

Returns:

Map containing success boolean and error codes if one occurs

Throws:

Exception - if an error occurs

deleteExtraction

public boolean deleteExtraction(String definitionFileName)
                         throws Exception

Deletes an extraction definition file.

Parameters:

definitionFileName - The extraction definition file to delete

Returns:

true if extraction deletion succeed, false otherwise

Throws:

Exception - if an error occurs

_parseDefinitionFile

private Document _parseDefinitionFile(File definitionFile)
                               throws Exception

Throws:

Exception

_getDescriptionsElements

private Stream<Element> _getDescriptionsElements(Element extractionRoot)