Package org.ametys.plugins.extraction.execution

Class ExtractionExecutor

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.extraction.execution.ExtractionExecutor

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ExtractionExecutor
extends AbstractLogEnabled
implements Component, Serviceable

Extracts query results form a XML definition file

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The Avalon role.

Constructor Summary

Constructors

Constructor	Description
ExtractionExecutor()

Method Summary

Modifier and Type	Method	Description
void	execute(String relativeFilePath, OutputStream resultOutputStream, String lang, Map<String,Object> parameters, PipelineDescriptor pipeline)	Executes the given extraction
Set<Path>	execute(String relativeFilePath, String defaultResultFileName, String lang, Map<String,Object> parameters, PipelineDescriptor pipeline)	Executes the given extraction
void	service(ServiceManager serviceManager)

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, toString, wait, wait, wait

Field Detail

ROLE

public static final String ROLE

The Avalon role.

Constructor Detail

ExtractionExecutor

public ExtractionExecutor()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

execute

public Set<Path> execute(String relativeFilePath,
                         String defaultResultFileName,
                         String lang,
                         Map<String,Object> parameters,
                         PipelineDescriptor pipeline)
                  throws Exception

Executes the given extraction

Parameters:

relativeFilePath - The path of the extraction file to execute

defaultResultFileName - The default file name for the result (it can be unused, for instance if resultSubFolder is a file, i.e. contains a '.' in its last element)

lang - The language

parameters - The parameters

pipeline - The execution pipeline

Returns:

The set of the result files path

Throws:

Exception - if an errors occurred

execute

public void execute(String relativeFilePath,
                    OutputStream resultOutputStream,
                    String lang,
                    Map<String,Object> parameters,
                    PipelineDescriptor pipeline)
             throws Exception

Executes the given extraction

Parameters:

relativeFilePath - The path of the extraction file to execute

resultOutputStream - The result output stream

lang - The language

parameters - The parameters

pipeline - The execution pipeline

Throws:

Exception - if an errors occurred