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

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,String>	_clauseVariables
private Locale	_defaultLocale
private Map<String,Boolean>	_displayOptionalColumns
private List<ExtractionExecutionContextHierarchyElement>	_hierarchyElements

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getClauseVariables() Retrieves the variables to use in queries
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	setClauseVariables(Map<String,String> clauseVariables) Sets the variables to use in queries
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

Field Detail

_displayOptionalColumns

private Map<String,Boolean> _displayOptionalColumns

_clauseVariables

private Map<String,String> _clauseVariables

_hierarchyElements

private List<ExtractionExecutionContextHierarchyElement> _hierarchyElements

_defaultLocale

private Locale _defaultLocale

Constructor Detail

ExtractionExecutionContext

public ExtractionExecutionContext()

Default constructor

ExtractionExecutionContext

public ExtractionExecutionContext(ExtractionExecutionContext context)

Creates a context by copy

Parameters:

context - context to copy

Method Detail

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

getClauseVariables

public Map<String,String> getClauseVariables()

Retrieves the variables to use in queries

Returns:

the variables to use in queries

setClauseVariables

public void setClauseVariables(Map<String,String> clauseVariables)

Sets the variables to use in queries

Parameters:

clauseVariables - the variables 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