io.vertigo.dynamox.task

Class AbstractTaskEngineSQL<S extends SqlPreparedStatement>

java.lang.Object

io.vertigo.dynamo.task.model.TaskEngine

io.vertigo.dynamox.task.AbstractTaskEngineSQL<S>

Type Parameters:

S - Type de Statement utilisé

Direct Known Subclasses:

TaskEngineInsertWithGeneratedKeys, TaskEngineProc, TaskEngineSelect

public abstract class AbstractTaskEngineSQL<S extends SqlPreparedStatement>
extends TaskEngine

Fournit des méthodes de haut niveau pour les services de type SQL.
Un Service SQL est composé de paramètre de type primitif, DTO ou DTC, en IN, OUT ou INOUT et d'une requête SQL sous forme de texte. La requête est parsée puis préparée pour replacer les paramètres dynamo par des variables bindées. Grammaire des requêtes :
## : paramètre IN
%% : paramètre OUT
@@ : paramètre INOUT
où est :
"primitif" : LON_IDENTIFIANT_ID ou DAT_DATE_SAISIE
"champ de dto" : . : DTO_PERSONNE.NOM ou encore DTO_PERSONNE.PER_ID
"champ de dtc" : .. : DTC_PERSONNE.2.NOM ou encore DTC_PERSONNE.0.PER_ID

Les DTO et DTC n'ont pas besoin d'être en OUT ou en INOUT pour être mutées.

Intérêt de gérer des paramètres DTC : il existe maintenant un moyen d'accéder aux champs d'une DTC, qui peut être utilisé pour créer des ServiceProviderSQL pseudo-dynamiques (ajout de mots clefs dans la requête SQL du KSP pour gérer des itérations sur DTC par ex).
Exemple de requête :
SELECT TOTO_ID, NOM
FROM TOTO
WHERE TOTO_ID = #LON_TOTO_ID#
AND NOM like #DTO_FILTRE.NOM#||'%'
AND TYPE_ID IN (#DTC_TYPE.0.TYPE_ID#,#DTC_TYPE.1.TYPE_ID#,#DTC_TYPE.2.TYPE_ID#)
De plus permet de créer du SQL dynamiquement interprété. Les paramètres IN de la tache peuvent être invoqués pour construire la requête SQL. Exemple : request = " Select * From PRODUIT <%if (dtoProduitCritere.getPrdLibelle()!=null) {%> Where PRD_LIBELLE like #DTO_PRODUIT_CRITERE.PRD_LIBELLE#||'%%' <%}%> order by <%=1%>";

Author:

pchretien, npiedeloup

Field Summary

Fields

Modifier and Type	Field and Description
static KTransactionResourceId<SqlConnection>	SQL_RESOURCE_ID Identifiant de ressource SQL par défaut.
static String	SQL_ROWCOUNT Nom de l'attribut recevant le nombre de lignes affectées par un Statement.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTaskEngineSQL(ScriptManager scriptManager) Constructeur.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	checkSqlQuery(String sql) Vérification de la syntaxe sql.
protected abstract S	createStatement(String sql, SqlConnection connection) Crée le Statement pour le select ou bloc sql.
protected abstract int	doExecute(SqlConnection connection, S statement) Exécution de la requête.
void	execute()
protected SqlConnectionProvider	getConnectionProvider() Il est possible de surcharger la configuration SQL d'un service.
protected static SqlDataBaseManager	getDataBaseManager()
protected KTransactionResourceId<SqlConnection>	getKTransactionResourceId()
protected List<io.vertigo.dynamox.task.TaskEngineSQLParam>	getParams()
protected String	getSqlQuery() Retourne la Query qui sera parsée Par défaut il s'agit de la request définie sur le service
protected String	preProcessQuery(String sqlQuery) Permet de créer du SQL dynamiquement interprété.
protected void	setOutParameter(SqlCallableStatement cs) Met à jour les paramètres de sorties
protected void	setParameter(SqlPreparedStatement ps, io.vertigo.dynamox.task.TaskEngineSQLParam param, Integer rowNumber) Affecte un paramètre au Statement.
protected void	setParameters(SqlPreparedStatement statement) Modifie le statement en fonction des paramètres Affecte les valeurs en entrée

Methods inherited from class io.vertigo.dynamo.task.model.TaskEngine

getTaskDefinition, getValue, process, setValue

Methods inherited from class java.lang.Object

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

Field Detail

SQL_RESOURCE_ID

public static final KTransactionResourceId<SqlConnection> SQL_RESOURCE_ID

Identifiant de ressource SQL par défaut.

SQL_ROWCOUNT

public static final String SQL_ROWCOUNT

Nom de l'attribut recevant le nombre de lignes affectées par un Statement. Dans le cas des Batchs ce nombre correspond à la somme de toutes les lignes affectées par le batch.

See Also:

Constant Field Values

Constructor Detail

AbstractTaskEngineSQL

protected AbstractTaskEngineSQL(ScriptManager scriptManager)

Constructeur.

Parameters:

scriptManager - Manager de traitment de scripts

Method Detail

doExecute

protected abstract int doExecute(SqlConnection connection,
            S statement)
                          throws SQLException

Exécution de la requête.

Parameters:

connection - Connexion BDD

statement - Requête

Returns:

Nombre de lignes affectées (Insert/ Update / Delete)

Throws:

SQLException - Erreur sql

checkSqlQuery

protected abstract void checkSqlQuery(String sql)

Vérification de la syntaxe sql.

Parameters:

sql - Syntaxe sql de la requête

execute

public void execute()

Specified by:

execute in class TaskEngine

getSqlQuery

protected String getSqlQuery()

Retourne la Query qui sera parsée Par défaut il s'agit de la request définie sur le service

Returns:

Chaine de configuration

preProcessQuery

protected final String preProcessQuery(String sqlQuery)

Permet de créer du SQL dynamiquement interprété. Les paramètres IN de la tache peuvent être invoqués pour construire la requête SQL. Exemple : request = " Select * From PRODUIT <%if (dtoProduitCritere.getPrdLibelle()!=null) {%> Where PRD_LIBELLE like #DTO_PRODUIT_CRITERE.PRD_LIBELLE#||'%%' <%}%> order by <%=1%>";

Parameters:

sqlQuery - Requete à évaluer

Returns:

Requete évaluée

setOutParameter

protected final void setOutParameter(SqlCallableStatement cs)
                              throws SQLException

Met à jour les paramètres de sorties

Parameters:

cs - CallableStatement

Throws:

SQLException - Si erreur

createStatement

protected abstract S createStatement(String sql,
                SqlConnection connection)

Crée le Statement pour le select ou bloc sql. Initialise la liste des paramètres en entrée et en sortie

Parameters:

sql - Requête SQL

connection - Connexion vers la base de données

Returns:

Statement StatementSQL

setParameters

protected final void setParameters(SqlPreparedStatement statement)
                            throws SQLException

Modifie le statement en fonction des paramètres Affecte les valeurs en entrée

Parameters:

statement - de type KPreparedStatement, KCallableStatement...

Throws:

SQLException - En cas d'erreur dans la configuration

getParams

protected final List<io.vertigo.dynamox.task.TaskEngineSQLParam> getParams()

Returns:

Liste des paramètres

setParameter

protected final void setParameter(SqlPreparedStatement ps,
                io.vertigo.dynamox.task.TaskEngineSQLParam param,
                Integer rowNumber)
                           throws SQLException

Affecte un paramètre au Statement.

Parameters:

ps - PrepareStatement

param - Paramètre SQL

rowNumber - Ligne des données d'entrée.

Throws:

SQLException - Erreur sql

getKTransactionResourceId

protected KTransactionResourceId<SqlConnection> getKTransactionResourceId()

Returns:

Id de la Ressource Connexion SQL dans la transaction

getDataBaseManager

protected static final SqlDataBaseManager getDataBaseManager()

Returns:

Manager de base de données

getConnectionProvider

protected SqlConnectionProvider getConnectionProvider()

Il est possible de surcharger la configuration SQL d'un service.

Returns:

Configuration SQL.