Package org.ametys.plugins.extraction.execution

Class Extraction

java.lang.Object

org.ametys.plugins.extraction.execution.Extraction

public class Extraction
extends Object

Object representing the extraction definition file content

Field Summary

Fields

Modifier and Type	Field	Description
private String	_descriptionId
private List<String>	_displayOptionalColumnsNames
private List<ExtractionComponent>	_extractionComponents
private Map<String,String>	_queryVariablesNamesAndContentTypes

Constructor Summary

Constructors

Constructor	Description
Extraction()

Method Summary

Modifier and Type	Method	Description
void	addExtractionComponent(ExtractionComponent extractionComponent)	Add an extraction component
String	getDescriptionId()	Retrieves the identifier of the extraction's description
List<String>	getDisplayOptionalColumnsNames()	Retrieves the list of variables names controlling display of optional columns
List<ExtractionComponent>	getExtractionComponents()	Retrieves the list of the extraction components
Map<String,String>	getQueryVariablesNamesAndContentTypes()	Retrieves the list of variables names and content type to use in queries
void	setDescriptionId(String descriptionId)	Set the identifier of the extraction's description
void	setDisplayOptionalColumnsNames(List<String> displayOptionalColumnsNames)	Set variables names controlling display of optional columns
void	setQueryVariablesNamesAndContentTypes(Map<String,String> queryVariablesNamesAndContentTypes)	Set variables names and content types to use in queries

Methods inherited from class java.lang.Object

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

Field Detail

_descriptionId

private String _descriptionId

_extractionComponents

private List<ExtractionComponent> _extractionComponents

_displayOptionalColumnsNames

private List<String> _displayOptionalColumnsNames

_queryVariablesNamesAndContentTypes

private Map<String,String> _queryVariablesNamesAndContentTypes

Constructor Detail

Extraction

public Extraction()

Method Detail

getDescriptionId

public String getDescriptionId()

Retrieves the identifier of the extraction's description

Returns:

the identifier of the extraction's description

setDescriptionId

public void setDescriptionId(String descriptionId)

Set the identifier of the extraction's description

Parameters:

descriptionId - the identifier to set

getExtractionComponents

public List<ExtractionComponent> getExtractionComponents()

Retrieves the list of the extraction components

Returns:

The extraction components

addExtractionComponent

public void addExtractionComponent(ExtractionComponent extractionComponent)

Add an extraction component

Parameters:

extractionComponent - The extraction component to add

getDisplayOptionalColumnsNames

public List<String> getDisplayOptionalColumnsNames()

Retrieves the list of variables names controlling display of optional columns

Returns:

The variables names

setDisplayOptionalColumnsNames

public void setDisplayOptionalColumnsNames(List<String> displayOptionalColumnsNames)

Set variables names controlling display of optional columns

Parameters:

displayOptionalColumnsNames - the variables for the optional columns to set

getQueryVariablesNamesAndContentTypes

public Map<String,String> getQueryVariablesNamesAndContentTypes()

Retrieves the list of variables names and content type to use in queries

Returns:

A Map containing variables names and content types

setQueryVariablesNamesAndContentTypes

public void setQueryVariablesNamesAndContentTypes(Map<String,String> queryVariablesNamesAndContentTypes)

Set variables names and content types to use in queries

Parameters:

queryVariablesNamesAndContentTypes - A Map containing variables names and content types to set