Package org.ametys.plugins.extraction.execution.pipeline.impl

Class ConfigurablePipelineDescriptor

java.lang.Object

org.ametys.plugins.extraction.execution.pipeline.impl.ConfigurablePipelineDescriptor

All Implemented Interfaces:

PipelineDescriptor, Configurable

public class ConfigurablePipelineDescriptor
extends Object
implements PipelineDescriptor, Configurable

Implementation of PipelineDescriptor which is Configurable.

Constructor Summary

Constructors

Constructor	Description
ConfigurablePipelineDescriptor(String id, SourceResolver resolver, PipelineSerializerModelExtensionPoint pipelineSerializers)	Default constructor

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getDefaultExtension()	Gets the default extension of the file result(s) The default extension is used when PipelineDescriptor.getResultSubfolder() is a folder and not a file.
ExtractionMatcher	getExtractionMatcher()	Gets the extraction matcher to check if the pipeline is able to handle a given extraction
I18nizableText	getLabel()	Gets the label
Map<String,String>	getOutputParameters()	Get the output parameters to add some specific features in each serializer.
String	getResultSubfolder()	Gets the result subfolder (or file).
PipelineSerializerModel	getSerializerModel()	Gets the serializer model
List<String>	getStylesheets()	Gets the XSLT file names to chain
Pipeline	newPipeline(OutputStream out)	Provides a new Pipeline
protected void	setOutputParameters(Configuration outputConf)	Set the output parameters to get the extension, path, encoding, etc.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurablePipelineDescriptor

public ConfigurablePipelineDescriptor(String id,
 SourceResolver resolver,
 PipelineSerializerModelExtensionPoint pipelineSerializers)

Default constructor

Parameters:

id - The id of the pipeline descriptor

resolver - The source resolver

pipelineSerializers - The extension point for pipeline serializers

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getLabel

public I18nizableText getLabel()

Description copied from interface: PipelineDescriptor

Gets the label

Specified by:

getLabel in interface PipelineDescriptor

Returns:

the label

getExtractionMatcher

public ExtractionMatcher getExtractionMatcher()

Description copied from interface: PipelineDescriptor

Gets the extraction matcher to check if the pipeline is able to handle a given extraction

Specified by:

getExtractionMatcher in interface PipelineDescriptor

Returns:

the extraction matcher of the pipeline

getStylesheets

public List<String> getStylesheets()

Description copied from interface: PipelineDescriptor

Gets the XSLT file names to chain

Specified by:

getStylesheets in interface PipelineDescriptor

Returns:

the XSLT file names to chain

getSerializerModel

public PipelineSerializerModel getSerializerModel()

Description copied from interface: PipelineDescriptor

Gets the serializer model

Specified by:

getSerializerModel in interface PipelineDescriptor

Returns:

the serializer model

getResultSubfolder

public String getResultSubfolder()

Description copied from interface: PipelineDescriptor

Gets the result subfolder (or file).
Can contain variables (see PathResolver), resolved against the extraction results.
If it returns

• a file path without variable, then all extraction results will be in this file;
• a file path with variables, then extraction results will be dispatched in the resolved file paths;
• a folder path without variable, then all extraction results will be in one file under this folder (the file name will be the one provided in defaultResultFileName parameter of ExtractionExecutor#execute method);
• a folder path with variables, then each first level content extraction result will be dispatched in one file under the resolved folders (the file name will be the title of the content, and the extension is the return of PipelineDescriptor.getDefaultExtension());

Specified by:

getResultSubfolder in interface PipelineDescriptor

Returns:

the result subfolder (or file)

getDefaultExtension

public String getDefaultExtension()

Description copied from interface: PipelineDescriptor

Gets the default extension of the file result(s)
The default extension is used when PipelineDescriptor.getResultSubfolder() is a folder and not a file.

Specified by:

getDefaultExtension in interface PipelineDescriptor

Returns:

the default extension of the file result(s)

newPipeline

public Pipeline newPipeline(OutputStream out)

Description copied from interface: PipelineDescriptor

Provides a new Pipeline

Specified by:

newPipeline in interface PipelineDescriptor

Parameters:

out - the output stream to write on

Returns:

the built Pipeline

getOutputParameters

public Map<String,String> getOutputParameters()

Description copied from interface: PipelineDescriptor

Get the output parameters to add some specific features in each serializer.

Specified by:

getOutputParameters in interface PipelineDescriptor

Returns:

The output parameters

setOutputParameters

protected void setOutputParameters(Configuration outputConf)
                            throws ConfigurationException

Set the output parameters to get the extension, path, encoding, etc.

Parameters:

outputConf - The output configuration

Throws:

ConfigurationException - throws an exception if an error occurs