Package de.calamanari.adl.sql.cnv

Class ResettableScpContext

java.lang.Object

de.calamanari.adl.sql.cnv.ResettableScpContext

All Implemented Interfaces:

de.calamanari.adl.ProcessContext, SqlConversionProcessContext

public class ResettableScpContext
extends Object
implements SqlConversionProcessContext

Implementation of a resettable SqlConversionProcessContext.

This class covers the state of an AbstractSqlExpressionConverter instance throughout its lifetime.
It allows to reset this state to an initial configuration before each conversion run, so multiple runs won't interfere.

Author:

Karl Eilebrecht

Constructor Summary

Constructors

Constructor	Description
ResettableScpContext(DataBinding dataBinding, Map<String,Serializable> globalVariablesTemplate, Set<de.calamanari.adl.Flag> flagsTemplate)

Method Summary

Modifier and Type	Method	Description
Set<ExpressionAlias>	getAliasesInWhereClause()
AliasHelper	getAliasHelper()
SqlAugmentationListener	getAugmentationListener()
MatchConditionFactory	getConditionFactory()
DataBinding	getDataBinding()
CoreExpressionSqlHelper	getExpressionHelper()
Set<de.calamanari.adl.Flag>	getGlobalFlags()
Set<de.calamanari.adl.Flag>	getGlobalFlagsTemplate()
Map<String,Serializable>	getGlobalVariables()
Map<String,Serializable>	getGlobalVariablesTemplate()
String	getIdColumnName()
TableMetaInfo	getMainTable()	The main table is the table to start the query with.
QueryType	getQueryType()
List<QueryParameter>	getRegisteredParameters()
de.calamanari.adl.FormatStyle	getStyle()
Set<TableMetaInfo>	getTablesInWhereClause()
StringBuilder	getWhereClause()
void	registerParameter(QueryParameter parameter)	Registers a query parameter of the current query.
void	reset()	Initializes this context, so its state has the initially configured flags and variables again
void	setAliasHelper(AliasHelper aliasHelper)
void	setAugmentationListener(SqlAugmentationListener augmentationListener)	Sets the augmentation listener for this instance, default is SqlAugmentationListener.none()
void	setConditionFactory(MatchConditionFactory conditionFactory)
void	setExpressionHelper(CoreExpressionSqlHelper expressionHelper)
void	setIdColumnName(String idColumnName)
void	setMainTable(TableMetaInfo mainTable)	The main table is the table to start the query with.
void	setQueryType(QueryType queryType)
void	setStyle(de.calamanari.adl.FormatStyle style)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.calamanari.adl.sql.cnv.SqlConversionProcessContext

getMainIdColumnName

Constructor Details

ResettableScpContext

public ResettableScpContext(DataBinding dataBinding,
 Map<String,Serializable> globalVariablesTemplate,
 Set<de.calamanari.adl.Flag> flagsTemplate)

Parameters:

dataBinding - to be set initially for each conversion run

flagsTemplate - to be set initially for each conversion run

Method Details

reset

public void reset()

Initializes this context, so its state has the initially configured flags and variables again

Because we assume them to be rather stable once configured, the following properties won't be reset by this method:

• setStyle(FormatStyle)
• idColumnName
• setQueryType(QueryType)

getGlobalVariables

public Map<String,Serializable> getGlobalVariables()

Specified by:

getGlobalVariables in interface de.calamanari.adl.ProcessContext

getGlobalFlags

public Set<de.calamanari.adl.Flag> getGlobalFlags()

Specified by:

getGlobalFlags in interface de.calamanari.adl.ProcessContext

getGlobalVariablesTemplate

public Map<String,Serializable> getGlobalVariablesTemplate()

Returns:

the variables specified at construction time (this config acts as a template during reset())

getGlobalFlagsTemplate

public Set<de.calamanari.adl.Flag> getGlobalFlagsTemplate()

Returns:

the flags specified at construction time (this config acts as a template during reset())

getDataBinding

public DataBinding getDataBinding()

Specified by:

getDataBinding in interface SqlConversionProcessContext

Returns:

the configured data binding of the converter

registerParameter

public void registerParameter(QueryParameter parameter)

Description copied from interface: SqlConversionProcessContext

Registers a query parameter of the current query.

Only registered parameters can later be applied to the final script.

Specified by:

registerParameter in interface SqlConversionProcessContext

Parameters:

parameter -

getRegisteredParameters

public List<QueryParameter> getRegisteredParameters()

Specified by:

getRegisteredParameters in interface SqlConversionProcessContext

Returns:

list of all parameters registered during the current conversion run

See Also:

• SqlConversionProcessContext.registerParameter(QueryParameter)

getAliasHelper

public AliasHelper getAliasHelper()

Specified by:

getAliasHelper in interface SqlConversionProcessContext

Returns:

the converter's alias helper to create and maintain aliases

setAliasHelper

public void setAliasHelper(AliasHelper aliasHelper)

Parameters:

aliasHelper - the converter's alias helper to create and maintain aliases

getExpressionHelper

public CoreExpressionSqlHelper getExpressionHelper()

Specified by:

getExpressionHelper in interface SqlConversionProcessContext

Returns:

the converter's expression helper to work with expressions and sub-expressions

setExpressionHelper

public void setExpressionHelper(CoreExpressionSqlHelper expressionHelper)

Parameters:

expressionHelper - the converter's expression helper to work with expressions and sub-expressions

getIdColumnName

public String getIdColumnName()

Specified by:

getIdColumnName in interface SqlConversionProcessContext

Returns:

configured name of the main ID-column (when selecting IDs), defaults to SqlFormatConstants.DEFAULT_ID_COLUMN_NAME

setIdColumnName

public void setIdColumnName(String idColumnName)

Parameters:

idColumnName - name of the main ID-column (when selecting IDs), defaults to SqlFormatConstants.DEFAULT_ID_COLUMN_NAME

getQueryType

public QueryType getQueryType()

Specified by:

getQueryType in interface SqlConversionProcessContext

Returns:

type of the query to be created, defaults to QueryType.SELECT_DISTINCT_ID_ORDERED

setQueryType

public void setQueryType(QueryType queryType)

Parameters:

queryType - type of the query to be created, defaults to QueryType.SELECT_DISTINCT_ID_ORDERED

getMainTable

public TableMetaInfo getMainTable()

Description copied from interface: SqlConversionProcessContext

The main table is the table to start the query with. It is initialized with DataTableConfig.primaryTable().

Depending on the conversion strategy it can be reasonable to override it with a different table, for example if only a single table is involved without any complex joins.

Specified by:

getMainTable in interface SqlConversionProcessContext

Returns:

the main table or null if not configured

setMainTable

public void setMainTable(TableMetaInfo mainTable)

The main table is the table to start the query with. It is initialized with DataTableConfig.primaryTable().

Depending on the conversion strategy it can be reasonable to override it with a different table, for example if only a single table is involved without any complex joins.

Parameters:

mainTable - the table to prefer to start the query or null to enforce another query start strategy

getConditionFactory

public MatchConditionFactory getConditionFactory()

Specified by:

getConditionFactory in interface SqlConversionProcessContext

Returns:

the factory for creating match conditions on target columns, set by the converter per conversion run

setConditionFactory

public void setConditionFactory(MatchConditionFactory conditionFactory)

Parameters:

conditionFactory - the factory for creating match conditions on target columns, set by the converter per conversion run

getStyle

public de.calamanari.adl.FormatStyle getStyle()

Specified by:

getStyle in interface SqlConversionProcessContext

Returns:

configured formatting style (inline or multi-line)

setStyle

public void setStyle(de.calamanari.adl.FormatStyle style)

Parameters:

style - formatting style (inline or multi-line), default is FormatStyle.PRETTY_PRINT

getAugmentationListener

public SqlAugmentationListener getAugmentationListener()

Returns:

the configured augmentation listener or SqlAugmentationListener.none()

setAugmentationListener

public void setAugmentationListener(SqlAugmentationListener augmentationListener)

Sets the augmentation listener for this instance, default is SqlAugmentationListener.none()

Parameters:

augmentationListener -

getWhereClause

public StringBuilder getWhereClause()

Specified by:

getWhereClause in interface SqlConversionProcessContext

Returns:

WHERE-clause builder of the converter

getAliasesInWhereClause

public Set<ExpressionAlias> getAliasesInWhereClause()

Specified by:

getAliasesInWhereClause in interface SqlConversionProcessContext

Returns:

list of all aliases referenced in the where-clause, mutable

getTablesInWhereClause

public Set<TableMetaInfo> getTablesInWhereClause()

Specified by:

getTablesInWhereClause in interface SqlConversionProcessContext

Returns:

list of all tables referenced in the where-clause, mutable