Package org.ametys.plugins.extraction.execution

Class ExtractionExecutionContext

java.lang.Object

org.ametys.plugins.extraction.execution.ExtractionExecutionContext

public class ExtractionExecutionContext
extends Object

Context of extraction components execution

Constructor Summary

Constructors

Constructor	Description
ExtractionExecutionContext()	Default constructor
ExtractionExecutionContext(ExtractionExecutionContext context)	Creates a context by copy

Method Summary

Modifier and Type	Method	Description
Map<Extraction.ClausesVariable,List<String>>	getClausesVariablesValues()	Retrieves the variables values to use in clauses
Locale	getDefaultLocale()	Get the default locale for this context of extraction
Map<String,Boolean>	getDisplayOptionalColumns()	Retrieves the variables controlling display of optional columns
List<ExtractionExecutionContextHierarchyElement>	getHierarchyElements()	Retrieves the parents elements of the context
void	setClausesVariablesValues(Map<Extraction.ClausesVariable,List<String>> clausesVariablesValues)	Sets the variables values to use in clauses
void	setDefaultLocale(Locale defaultLocale)	Set the default locale for this context of extraction The default locale is used for export of localized values such as multilingual strings or contents.
void	setDisplayOptionalColumns(Map<String,Boolean> displayOptionalColumns)	Sets the variables controlling display of optional columns
void	setHierarchyElements(List<ExtractionExecutionContextHierarchyElement> hierarchyElements)	Sets the parents elements of the context

Methods inherited from class java.lang.Object

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

Constructor Details

ExtractionExecutionContext

public ExtractionExecutionContext()

Default constructor

ExtractionExecutionContext

public ExtractionExecutionContext(ExtractionExecutionContext context)

Creates a context by copy

Parameters:

context - context to copy

Method Details

setDefaultLocale

public void setDefaultLocale(Locale defaultLocale)

Set the default locale for this context of extraction The default locale is used for export of localized values such as multilingual strings or contents.

Parameters:

defaultLocale - the default locale

getDefaultLocale

public Locale getDefaultLocale()

Get the default locale for this context of extraction

Returns:

the default locale. Can be null.

getDisplayOptionalColumns

public Map<String,Boolean> getDisplayOptionalColumns()

Retrieves the variables controlling display of optional columns

Returns:

The variables controlling display of optional columns

setDisplayOptionalColumns

public void setDisplayOptionalColumns(Map<String,Boolean> displayOptionalColumns)

Sets the variables controlling display of optional columns

Parameters:

displayOptionalColumns - The variables to set

getClausesVariablesValues

public Map<Extraction.ClausesVariable,List<String>> getClausesVariablesValues()

Retrieves the variables values to use in clauses

Returns:

the variables values to use in clauses

setClausesVariablesValues

public void setClausesVariablesValues(Map<Extraction.ClausesVariable,List<String>> clausesVariablesValues)

Sets the variables values to use in clauses

Parameters:

clausesVariablesValues - the variables values to set

getHierarchyElements

public List<ExtractionExecutionContextHierarchyElement> getHierarchyElements()

Retrieves the parents elements of the context

Returns:

the elements of the context

setHierarchyElements

public void setHierarchyElements(List<ExtractionExecutionContextHierarchyElement> hierarchyElements)

Sets the parents elements of the context

Parameters:

hierarchyElements - the hierarchy elements to set