org.ametys.plugins.extraction.execution.pipeline

Interface PipelineDescriptor

All Known Implementing Classes:

ConfigurablePipelineDescriptor, NoOpPipelineDescriptor

public interface PipelineDescriptor

A descriptor which can provide a Pipeline with newPipeline method.

Method Summary

Modifier and Type	Method and Description
String	getDefaultExtension() Gets the default extension of the file result(s) The default extension is used when getResultSubfolder() is a folder and not a file.
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

Method Detail

getLabel

I18nizableText getLabel()

Gets the label

Returns:

the label

getStylesheets

List<String> getStylesheets()

Gets the XSLT file names to chain

Returns:

the XSLT file names to chain

getSerializerModel

PipelineSerializerModel getSerializerModel()

Gets the serializer model

Returns:

the serializer model

getResultSubfolder

String getResultSubfolder()

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 getDefaultExtension());

Returns:

the result subfolder (or file)

getDefaultExtension

String getDefaultExtension()

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

Returns:

the default extension of the file result(s)

newPipeline

Pipeline newPipeline(OutputStream out)

Provides a new Pipeline

Parameters:

out - the output stream to write on

Returns:

the built Pipeline

getOutputParameters

Map<String,String> getOutputParameters()

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

Returns:

The output parameters