com.toolsverse.etl.core.util

Class EtlUtils

Object

com.toolsverse.etl.core.util.EtlUtils

public final class EtlUtils
extends Object

The collection of static methods used by ETL framework.

Since:

1.0

Version:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EtlUtils.HowToSearch The Enum HowToSearch.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAST_ETL_EXCEPTION The Constant LAST_ETL_EXCEPTION.

Constructor Summary

Constructors

Constructor and Description
EtlUtils()

Method Summary

Modifier and Type	Method and Description
static Variable	addVar(ListHashMap<String,Variable> vars, String name, String defValue, boolean replace) Creates a new variable and adds it to the given map.
static boolean	checkCondition(EtlConfig config, String name, Scenario scenario, ConditionalExecution conditionalExecution) Checks condition.
static boolean	checkCondition(EtlConfig config, String name, Scenario scenario, ConditionalExecution conditionalExecution, DataSet dataSet) Checks condition.
static Block	getBlockByName(Scenario scenario, String name, EtlUtils.HowToSearch howToSearch) Find block by name.
static String	getDbId(Alias alias, String delim) Gets the database id by parsing url.
static String	getFileName(String fileName) Gets the file name.
static String	getPatternName(String name) Gets the pattern name.
static String	getScenarioFileName(String folder, String fileName) Gets the scenario file name.
static String	getScenarioName(String name) Gets the scenario name.
static String	getSqlFileName(String name, int index) Gets the sql file name.
static String	getVarValue(ListHashMap<String,Variable> vars, String name, String defValue) Gets the variable value.
static String	insert2Update(String sql, String keyField) Converts "insert" sql to "update".
static boolean	isExtract(int action) Checks if extract needs to be performed during execution of the etl scenario.
static boolean	isExtractLoad(int action) Checks if extract and load needs to be performed during execution of the etl scenario.
static boolean	isLoad(int action) Checks if load needs to be performed during execution of the etl scenario.
static String	mergeSqlWithVars(CacheProvider<String,Object> cacheProvider, String sql, String using, ListHashMap<String,Variable> variables, Map<String,Object> bindVars) Merges sql with variables.
static String	mergeSqlWithVars(String sql, ListHashMap<String,Variable> vars, Driver driver) Merges sql with variables.
static String	mergeStringWithParams(String input, String[] params) Merges string with parameters.
static Point	parseException(Throwable exception, String code, String errorLinePattern) Parses exception.
static void	substituteVars(ListHashMap<String,Variable> variables) Substitute variable values in {} brackets.
static String	varValue2ColumnValue(String value) Remove single quotes from the string.

Methods inherited from class Object

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

Field Detail

LAST_ETL_EXCEPTION

public static final String LAST_ETL_EXCEPTION

The Constant LAST_ETL_EXCEPTION.

See Also:

Constant Field Values

Constructor Detail

EtlUtils

public EtlUtils()

Method Detail

addVar

public static Variable addVar(ListHashMap<String,Variable> vars,
                              String name,
                              String defValue,
                              boolean replace)

Creates a new variable and adds it to the given map.

Parameters:

vars - the map of variables

name - the name

defValue - the default value

replace - the "replace" flag. If true will replace existing variable with the same name.

Returns:

the variable

checkCondition

public static boolean checkCondition(EtlConfig config,
                                     String name,
                                     Scenario scenario,
                                     ConditionalExecution conditionalExecution)
                              throws Exception

Checks condition.

Parameters:

config - the config

name - the name

scenario - the scenario

conditionalExecution - the instance of the conditional execution class. Usually it is either Source, Destination or Scenario

Returns:

true, if successful

Throws:

Exception - in case of any error

checkCondition

public static boolean checkCondition(EtlConfig config,
                                     String name,
                                     Scenario scenario,
                                     ConditionalExecution conditionalExecution,
                                     DataSet dataSet)
                              throws Exception

Checks condition.

Parameters:

config - the config

name - the name

scenario - the scenario

conditionalExecution - the instance of the conditional execution class. Usually it is either Source, Destination or Scenario

dataSet - the data set

Returns:

true, if successful

Throws:

Exception - in case of any error

getBlockByName

public static Block getBlockByName(Scenario scenario,
                                   String name,
                                   EtlUtils.HowToSearch howToSearch)

Find block by name.

Parameters:

scenario - the scenario

name - the name

howToSearch - the how to search

Returns:

the block by name

getDbId

public static String getDbId(Alias alias,
                             String delim)

Gets the database id by parsing url.

Parameters:

alias - the alias

delim - the delimiter

Returns:

the database id

getFileName

public static String getFileName(String fileName)

Gets the file name. If original fileName has no extension adds ".xml".

Parameters:

fileName - the file name

Returns:

the file name

getPatternName

public static String getPatternName(String name)

Gets the pattern name. Example: test -> {test}

Parameters:

name - the name

Returns:

the pattern name

getScenarioFileName

public static String getScenarioFileName(String folder,
                                         String fileName)

Gets the scenario file name.

Parameters:

folder - the folder

fileName - the file name

Returns:

the scenario file name

getScenarioName

public static String getScenarioName(String name)

Gets the scenario name.

 a/b/c.txt --> c
 a.txt     --> a
 a/b/c     --> c
 a/b/c/    --> ""
 

Parameters:

name - the name

Returns:

the scenario name

getSqlFileName

public static String getSqlFileName(String name,
                                    int index)

Gets the sql file name.

Parameters:

name - the name

index - the index of the file

Returns:

the sql file name

getVarValue

public static String getVarValue(ListHashMap<String,Variable> vars,
                                 String name,
                                 String defValue)

Gets the variable value.

Parameters:

vars - the variables

name - the variable name

defValue - the default value

Returns:

the variable value

insert2Update

public static String insert2Update(String sql,
                                   String keyField)

Converts "insert" sql to "update".

Parameters:

sql - the sql

keyField - the key field(s)

Returns:

the update sql

isExtract

public static boolean isExtract(int action)

Checks if extract needs to be performed during execution of the etl scenario.

Parameters:

action - The action associated with the scenario.

Returns:

true, if extract needs to be performed during execution of the etl scenario.

isExtractLoad

public static boolean isExtractLoad(int action)

Checks if extract and load needs to be performed during execution of the etl scenario.

Parameters:

action - The action associated with the scenario.

Returns:

true, if extract and load needs to be performed during execution of the etl scenario.

isLoad

public static boolean isLoad(int action)

Checks if load needs to be performed during execution of the etl scenario.

Parameters:

action - The action associated with the scenario.

Returns:

true, if load needs to be performed during execution of the etl scenario.

varValue2ColumnValue

public static String varValue2ColumnValue(String value)

Remove single quotes from the string.

Parameters:

value - the value

Returns:

the string

mergeSqlWithVars

public static String mergeSqlWithVars(CacheProvider<String,Object> cacheProvider,
                                      String sql,
                                      String using,
                                      ListHashMap<String,Variable> variables,
                                      Map<String,Object> bindVars)

Merges sql with variables.

Parameters:

cacheProvider - the cache provider

sql - the sql

using - the comma delimited string with the names of bind variables.

variables - the variables

bindVars - the bind variables

Returns:

the sql

mergeSqlWithVars

public static String mergeSqlWithVars(String sql,
                                      ListHashMap<String,Variable> vars,
                                      Driver driver)

Merges sql with variables.

Parameters:

sql - the sql

vars - the variables

driver - the driver

Returns:

the string

mergeStringWithParams

public static String mergeStringWithParams(String input,
                                           String[] params)

Merges string with parameters.

Parameters:

input - the input

params - the parameters

Returns:

the string

parseException

public static Point parseException(Throwable exception,
                                   String code,
                                   String errorLinePattern)

Parses exception. Returns location of the error in the sql.

Parameters:

exception - the exception

code - the sql

errorLinePattern - the error line pattern

Returns:

the location in the sql which contains an error

substituteVars

public static void substituteVars(ListHashMap<String,Variable> variables)

Substitute variable values in {} brackets.

Parameters:

variables - the variables